X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=c3829694b77e46bee13acb7a2904da1664425b8a;hp=c26b0f6364d85a043336a30285fdd8061ff39f84;hb=7bac844eaab512d8789a9103d0efa774a1bab0d6;hpb=8f3712f87f93524000fecd9a4cd14e3790477412 diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm index c26b0f6..c382969 100644 --- a/src/PVE/CLIHandler.pm +++ b/src/PVE/CLIHandler.pm @@ -2,58 +2,45 @@ 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); my $cmddef; my $exename; +my $cli_handler_class; + +my $assert_initialized = sub { + my @caller = caller; + die "$caller[0]:$caller[2] - not initialized\n" + if !($cmddef && $exename && $cli_handler_class); +}; my $expand_command_name = sub { my ($def, $cmd) = @_; if (!$def->{$cmd}) { - my $expanded; - for my $k (keys(%$def)) { - if ($k =~ m/^$cmd/) { - if ($expanded) { - $expanded = undef; # more than one match - last; - } else { - $expanded = $k; - } - } - } - $cmd = $expanded if $expanded; + my @expanded = grep { /^\Q$cmd\E/ } keys %$def; + return $expanded[0] if scalar(@expanded) == 1; # enforce exact match } 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; + return [ sort keys %$cmddef ]; }; __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", @@ -69,11 +56,11 @@ __PACKAGE__->register_method ({ }, }, returns => { type => 'null' }, - + code => sub { my ($param) = @_; - die "not initialized" if !($cmddef && $exename); + $assert_initialized->(); my $cmd = $param->{cmd}; @@ -83,7 +70,7 @@ __PACKAGE__->register_method ({ if (!$cmd) { if ($verbose) { print_usage_verbose(); - } else { + } else { print_usage_short(\*STDOUT); } return undef; @@ -95,8 +82,12 @@ __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'); + my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, + $verbose ? 'full' : 'short', $pwcallback, + $stringfilemap); if ($verbose) { print "$str\n"; } else { @@ -107,60 +98,63 @@ __PACKAGE__->register_method ({ }}); -sub print_simple_pod_manpage { - my ($podfn, $class, $name, $arg_param, $uri_param) = @_; +sub print_simple_asciidoc_synopsis { + my ($class, $name, $arg_param, $uri_param) = @_; + + $assert_initialized->(); + + my $pwcallback = $cli_handler_class->can('read_password'); + my $stringfilemap = $cli_handler_class->can('string_param_file_mapping'); + + my $synopsis = "*${name}* `help`\n\n"; - 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; + $synopsis .= $class->usage_str($name, $name, $arg_param, $uri_param, + 'asciidoc', $pwcallback, $stringfilemap); - my $parser = PVE::PodParser->new(); - $parser->{include}->{synopsis} = $synopsis; - $parser->parse_from_file($podfn); + return $synopsis; } -sub print_pod_manpage { - my ($podfn) = @_; +sub print_asciidoc_synopsis { - die "not initialized" if !($cmddef && $exename); - die "no pod file specified" if !$podfn; + $assert_initialized->(); + + my $pwcallback = $cli_handler_class->can('read_password'); + my $stringfilemap = $cli_handler_class->can('string_param_file_mapping'); my $synopsis = ""; - - $synopsis .= " $exename [ARGS] [OPTIONS]\n\n"; - my $style = 'full'; # or should we use 'short'? + $synopsis .= "*${exename}* ` [ARGS] [OPTIONS]`\n\n"; + my $oldclass; - foreach my $cmd (sorted_commands()) { + 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, $style); - $str =~ s/^USAGE: //; - + my $str = $class->usage_str($name, "$exename $cmd", $arg_param, + $uri_param, 'asciidoc', $pwcallback, + $stringfilemap); $synopsis .= "\n" if $oldclass && $oldclass ne $class; - $str =~ s/\n/\n /g; - $synopsis .= " $str\n\n"; + + $synopsis .= "$str\n\n"; $oldclass = $class; } $synopsis .= "\n"; - my $parser = PVE::PodParser->new(); - $parser->{include}->{synopsis} = $synopsis; - $parser->parse_from_file($podfn); + return $synopsis; } sub print_usage_verbose { - die "not initialized" if !($cmddef && $exename); + $assert_initialized->(); + + 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'); + my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, + 'full', $pwcallback, $stringfilemap); print "$str\n\n"; } } @@ -172,7 +166,10 @@ sub sorted_commands { sub print_usage_short { my ($fd, $msg) = @_; - die "not initialized" if !($cmddef && $exename); + $assert_initialized->(); + + 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"; @@ -180,7 +177,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'); + 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; @@ -188,7 +185,7 @@ sub print_usage_short { } my $print_bash_completion = sub { - my ($cmddef, $simple_cmd, $bash_command, $cur, $prev) = @_; + my ($simple_cmd, $bash_command, $cur, $prev) = @_; my $debug = 0; @@ -199,9 +196,8 @@ my $print_bash_completion = sub { my $cmdline = substr($ENV{COMP_LINE}, 0, $ENV{COMP_POINT}); print STDERR "\nCMDLINE: $ENV{COMP_LINE}\n" if $debug; - # fixme: shell quoting?? - my @args = split(/\s+/, $cmdline); - my $pos = scalar(@args) - 2; + 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; @@ -222,7 +218,7 @@ my $print_bash_completion = sub { &$print_result(keys %$cmddef); return; } - $cmd = $args[1]; + $cmd = $args->[1]; } my $def = $cmddef->{$cmd}; @@ -236,6 +232,8 @@ my $print_bash_completion = sub { $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; @@ -252,7 +250,7 @@ my $print_bash_completion = sub { if ($d->{completion}) { my $vt = ref($d->{completion}); if ($vt eq 'CODE') { - my $res = $d->{completion}->($cmd, $pname, $cur); + my $res = $d->{completion}->($cmd, $pname, $cur, $args); &$print_result(@$res); } } elsif ($d->{type} eq 'boolean') { @@ -299,7 +297,7 @@ sub verify_api { my $get_exe_name = sub { my ($class) = @_; - + my $name = $class; $name =~ s/^.*:://; $name =~ s/_/-/g; @@ -322,111 +320,63 @@ 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__ } -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); - } +sub generate_asciidoc_synopsys { + my ($class) = @_; + $class->generate_asciidoc_synopsis(); +}; - return $filename; -} +sub generate_asciidoc_synopsis { + my ($class) = @_; -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"}; + $cmddef = $def; 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 run_cli { - my ($class, $pwcallback, $podfn, $preparefunc) = @_; - - $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin'; - - $exename = &$get_exe_name($class); - - initlog($exename); - - - if ($class !~ m/^PVE::Service::/) { - die "please run as root\n" if $> != 0; - - PVE::INotify::inotify_init(); - - my $rpcenv = PVE::RPCEnvironment->init('cli'); - $rpcenv->init_request(); - $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); - } +# overwrite this if you want to run/setup things early +sub setup_environment { + my ($class) = @_; - exit 0; + # do nothing by default } -sub handle_cmd { - my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_; - - $cmddef = $def; - $exename = $cmdname; +my $handle_cmd = sub { + my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_; $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 + + my $cmd = shift @$args; + 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') { - &$print_bash_completion($cmddef, 0, @$args); + } + + $cli_handler_class->setup_environment(); + + if ($cmd eq 'bashcomplete') { + &$print_bash_completion(undef, @$args); return; } @@ -442,42 +392,79 @@ sub handle_cmd { } 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; -} +}; -sub handle_simple_cmd { - my ($def, $args, $pwcallback, $podfn, $preparefunc) = @_; +my $handle_simple_cmd = sub { + my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_; - my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def}; + my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef}; die "no class specified" if !$class; 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, $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, @$args); 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; +}; + +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 'prepare'; + next if $key eq 'no_init'; # not used anymore + next if $key eq 'no_rpcenv'; # not used anymore + die "unknown parameter '$key'"; + } + + my $preparefunc = $params{prepare}; + + my $pwcallback = $class->can('read_password'); + my $stringfilemap = $class->can('string_param_file_mapping'); + + $exename = &$get_exe_name($class); + + initlog($exename); + + no strict 'refs'; + $cmddef = ${"${class}::cmddef"}; + + if (ref($cmddef) eq 'ARRAY') { + &$handle_simple_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap); + } else { + &$handle_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap); + } + + exit 0; } 1;