X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=2d7714556b70249a1cbc6e59bc3356a785bc6c5a;hp=e6fd415b3ef4fd237c03db93eb038e835e7d1bed;hb=8d3eb3ce17c60f128359e249e3ea9d114c792823;hpb=2a8ced7bacb7da8ab4143a59720e74a2897cf714 diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm index e6fd415..2d77145 100644 --- a/src/PVE/CLIHandler.pm +++ b/src/PVE/CLIHandler.pm @@ -2,65 +2,189 @@ 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); +# $cmddef defines which (sub)commands are available in a specific CLI class. +# A real command is always an array consisting of its class, name, array of +# position fixed (required) parameters and hash of predefined parameters when +# mapping a CLI command t o an API call. Optionally an output method can be +# passed at the end, e.g., for formatting or transformation purpose. +# +# [class, name, fixed_params, API_pre-set params, output_sub ] +# +# In case of so called 'simple commands', the $cmddef can be also just an +# array. +# +# Examples: +# $cmddef = { +# command => [ 'PVE::API2::Class', 'command', [ 'arg1', 'arg2' ], { node => $nodename } ], +# do => { +# this => [ 'PVE::API2::OtherClass', 'method', [ 'arg1' ], undef, sub { +# my ($res) = @_; +# print "$res\n"; +# }], +# that => [ 'PVE::API2::OtherClass', 'subroutine' [] ], +# }, +# dothat => { alias => 'do that' }, +# } 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 $abort = sub { + my ($reason, $cmd) = @_; + print_usage_short (\*STDERR, $reason, $cmd); + exit (-1); +}; 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 = []; +my $get_commands = sub { + my $def = shift // die "no command definition passed!"; + return [ grep { !(ref($def->{$_}) eq 'HASH' && defined($def->{$_}->{alias})) } sort keys %$def ]; +}; + +my $complete_command_names = sub { $get_commands->($cmddef) }; - return if ref($cmddef) ne 'HASH'; +# traverses the command definition using the $argv array, resolving one level +# of aliases. +# Returns the matching (sub) command and its definition, and argument array for +# this (sub) command and a hash where we marked which (sub) commands got +# expanded (e.g. st => status) while traversing +sub resolve_cmd { + my ($argv, $is_alias) = @_; - foreach my $cmd (keys %$cmddef) { - next if $cmd eq 'help'; - push @$res, $cmd; + my ($def, $cmd) = ($cmddef, $argv); + + if (ref($argv) eq 'ARRAY') { + my $expanded = {}; + my $last_arg_id = scalar(@$argv) - 1; + + for my $i (0..$last_arg_id) { + $cmd = $expand_command_name->($def, $argv->[$i]); + $expanded->{$argv->[$i]} = $cmd if $cmd ne $argv->[$i]; + last if !defined($def->{$cmd}); + $def = $def->{$cmd}; + + if (ref($def) eq 'ARRAY') { + # could expand to a real command, rest of $argv are its arguments + my $cmd_args = [ @$argv[$i+1..$last_arg_id] ]; + return ($cmd, $def, $cmd_args, $expanded); + } + + if (defined($def->{alias})) { + die "alias loop detected for '$cmd'" if $is_alias; # avoids cycles + # replace aliased (sub)command with the expanded aliased command + splice @$argv, $i, 1, split(/ +/, $def->{alias}); + return resolve_cmd($argv, 1); + } + } + # got either a special command (bashcomplete, verifyapi) or an unknown + # cmd, just return first entry as cmd and the rest of $argv as cmd_arg + my $cmd_args = [ @$argv[1..$last_arg_id] ]; + return ($argv->[0], $def, $cmd_args, $expanded); } + return ($cmd, $def); +} - return $res; -}; +sub generate_usage_str { + my ($format, $cmd, $indent, $separator, $sortfunc) = @_; + + $assert_initialized->(); + die 'format required' if !$format; + + $sortfunc //= sub { sort keys %{$_[0]} }; + $separator //= ''; + $indent //= ''; + + my $can_read_pass = $cli_handler_class->can('read_password'); + my $param_mapping_func = $cli_handler_class->can('string_param_file_mapping'); + + my ($subcmd, $def) = resolve_cmd($cmd); + + my $generate; + $generate = sub { + my ($indent, $separator, $def, $prefix) = @_; + + my $str = ''; + if (ref($def) eq 'HASH') { + my $oldclass = undef; + foreach my $cmd (&$sortfunc($def)) { + + if (ref($def->{$cmd}) eq 'ARRAY') { + my ($class, $name, $arg_param, $fixed_param) = @{$def->{$cmd}}; + + $str .= $separator if $oldclass && $oldclass ne $class; + $str .= $indent; + $str .= $class->usage_str($name, "$prefix $cmd", $arg_param, + $fixed_param, $format, + $can_read_pass, $param_mapping_func); + $oldclass = $class; + + } elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) { + + $str .= "*$prefix $cmd*\n\nAn alias for '$exename $def->{$cmd}->{alias}'.\n\n"; + + } else { + next if $def->{$cmd}->{alias}; + + my $substr = $generate->($indent, $separator, $def->{$cmd}, "$prefix $cmd"); + if ($substr) { + $substr .= $separator if $substr !~ /\Q$separator\E{2}/; + $str .= $substr; + } + } + + } + } else { + my ($class, $name, $arg_param, $fixed_param) = @$def; + $abort->("unknown command '$cmd'") if !$class; + + $str .= $indent; + $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, + $can_read_pass, $param_mapping_func); + } + return $str; + }; + + my $cmdstr = $exename; + $cmdstr .= ' ' . join(' ', @$cmd) if defined($cmd); + + return $generate->($indent, $separator, $def, $cmdstr); +} __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", - type => 'string', - optional => 1, + 'extra-args' => PVE::JSONSchema::get_standard_option('extra-args', { + description => 'Shows help for a specific command', completion => $complete_command_names, - }, + }), verbose => { description => "Verbose output format.", type => 'boolean', @@ -69,34 +193,34 @@ __PACKAGE__->register_method ({ }, }, returns => { type => 'null' }, - + code => sub { my ($param) = @_; - die "not initialized" if !($cmddef && $exename); + $assert_initialized->(); - my $cmd = $param->{cmd}; + my $cmd = $param->{'extra-args'}; - my $verbose = defined($cmd) && $cmd; + my $verbose = defined($cmd) && $cmd; $verbose = $param->{verbose} if defined($param->{verbose}); if (!$cmd) { if ($verbose) { print_usage_verbose(); - } else { + } else { print_usage_short(\*STDOUT); } return undef; } - $cmd = &$expand_command_name($cmddef, $cmd); - - my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd} || []}; - - raise_param_exc({ cmd => "no such command '$cmd'"}) if !$class; - + my $str; + if ($verbose) { + $str = generate_usage_str('full', $cmd, ''); + } else { + $str = generate_usage_str('short', $cmd, ' ' x 7); + } + $str =~ s/^\s+//; - my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, $verbose ? 'full' : 'short'); if ($verbose) { print "$str\n"; } else { @@ -107,88 +231,66 @@ __PACKAGE__->register_method ({ }}); -sub print_simple_pod_manpage { - my ($podfn, $class, $name, $arg_param, $uri_param) = @_; +sub print_simple_asciidoc_synopsis { + $assert_initialized->(); - 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 $synopsis = "*${exename}* `help`\n\n"; + $synopsis .= generate_usage_str('asciidoc'); - my $parser = PVE::PodParser->new(); - $parser->{include}->{synopsis} = $synopsis; - $parser->parse_from_file($podfn); + return $synopsis; } -sub print_pod_manpage { - my ($podfn) = @_; - - die "not initialized" if !($cmddef && $exename); - die "no pod file specified" if !$podfn; +sub print_asciidoc_synopsis { + $assert_initialized->(); 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); - $str =~ s/^USAGE: //; - - $synopsis .= "\n" if $oldclass && $oldclass ne $class; - $str =~ s/\n/\n /g; - $synopsis .= " $str\n\n"; - $oldclass = $class; - } + + $synopsis .= "*${exename}* ` [ARGS] [OPTIONS]`\n\n"; + + $synopsis .= generate_usage_str('asciidoc'); $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->(); 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'); - print "$str\n\n"; - } -} + my $str = generate_usage_str('full'); -sub sorted_commands { - return sort { ($cmddef->{$a}->[0] cmp $cmddef->{$b}->[0]) || ($a cmp $b)} keys %$cmddef; + print "$str\n"; } sub print_usage_short { - my ($fd, $msg) = @_; + my ($fd, $msg, $cmd) = @_; - die "not initialized" if !($cmddef && $exename); + $assert_initialized->(); print $fd "ERROR: $msg\n" if $msg; print $fd "USAGE: $exename [ARGS] [OPTIONS]\n"; - 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'); - print $fd "\n" if $oldclass && $oldclass ne $class; - print $fd " $str"; - $oldclass = $class; - } + print {$fd} generate_usage_str('short', $cmd, ' ' x 7, "\n", sub { + my ($h) = @_; + return sort { + if (ref($h->{$a}) eq 'ARRAY' && ref($h->{$b}) eq 'ARRAY') { + # $a and $b are both real commands order them by their class + return $h->{$a}->[0] cmp $h->{$b}->[0] || $a cmp $b; + } elsif (ref($h->{$a}) eq 'ARRAY' xor ref($h->{$b}) eq 'ARRAY') { + # real command and subcommand mixed, put sub commands first + return ref($h->{$b}) eq 'ARRAY' ? -1 : 1; + } else { + # both are either from the same class or subcommands + return $a cmp $b; + } + } keys %$h; + }); } my $print_bash_completion = sub { - my ($cmddef, $simple_cmd, $bash_command, $cur, $prev) = @_; + my ($simple_cmd, $bash_command, $cur, $prev) = @_; my $debug = 0; @@ -199,36 +301,33 @@ 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; - $pos += 1 if $cmdline =~ m/\s+$/; - - print STDERR "CMDLINE:$pos:$cmdline\n" if $debug; - - return if $pos < 0; - + my $args = PVE::Tools::split_args($cmdline); + shift @$args; # no need for program name 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); + my ($cmd, $def) = ($simple_cmd, $cmddef); + if (!$simple_cmd) { + ($cmd, $def, $args, my $expaned) = resolve_cmd($args); + + if (ref($def) eq 'HASH') { + &$print_result(@{$get_commands->($def)}); + return; + } + if (my $expanded_cmd = $expaned->{$cur}) { + print "$expanded_cmd\n"; return; } - $cmd = $args[1]; } - - my $def = $cmddef->{$cmd}; return if !$def; - print STDERR "CMDLINE1:$pos:$cmdline\n" if $debug; + my $pos = scalar(@$args) - 1; + $pos += 1 if $cmdline =~ m/\s+$/; + print STDERR "pos: $pos\n" if $debug; + return if $pos < 0; my $skip_param = {}; @@ -236,15 +335,14 @@ 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; - my $fpcount = scalar(@$arg_param); - my $info = $class->map_method_by_name($name); - my $schema = $info->{parameters}; - my $prop = $schema->{properties}; + my $prop = $info->{parameters}->{properties}; my $print_parameter_completion = sub { my ($pname) = @_; @@ -252,7 +350,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') { @@ -263,9 +361,9 @@ my $print_bash_completion = sub { }; # positional arguments - $pos += 1 if $simple_cmd; - if ($fpcount && $pos <= $fpcount) { - my $pname = $arg_param->[$pos -1]; + $pos++ if $simple_cmd; + if ($pos < scalar(@$arg_param)) { + my $pname = $arg_param->[$pos]; &$print_parameter_completion($pname); return; } @@ -297,13 +395,22 @@ sub verify_api { 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 = $class; - $exename =~ s/^.*:://; + $exename = &$get_exe_name($class); print <<__EOD__; # $exename bash completion @@ -313,162 +420,148 @@ 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 ($exename) = @_; - - my $filename; - - my $cpath = "PVE/CLI/${exename}.pm"; - my $spath = "PVE/Service/${exename}.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) = @_; +sub generate_asciidoc_synopsys { + my ($class) = @_; + $class->generate_asciidoc_synopsis(); +}; - $exename = $class; - $exename =~ s/^.*:://; +sub generate_asciidoc_synopsis { + my ($class) = @_; - $podfn = find_cli_class_source($exename) if !defined($podfn); + $cli_handler_class = $class; - die "unable to find source for class '$class'" if !$podfn; + $exename = &$get_exe_name($class); no strict 'refs'; my $def = ${"${class}::cmddef"}; + $cmddef = $def; if (ref($def) eq 'ARRAY') { - print_simple_pod_manpage($podfn, @$def); + print_simple_asciidoc_synopsis(); } 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 = $class; - $exename =~ s/^.*:://; - - initlog($exename); +# overwrite this if you want to run/setup things early +sub setup_environment { + my ($class) = @_; + # do nothing by default +} - if ($class !~ m/^PVE::Service::/) { - die "please run as root\n" if $> != 0; +my $handle_cmd = sub { + my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_; - PVE::INotify::inotify_init(); + $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ]; - my $rpcenv = PVE::RPCEnvironment->init('cli'); - $rpcenv->init_request(); - $rpcenv->set_language($ENV{LANG}); - $rpcenv->set_user('root@pam'); - } + my $cmd_str = join(' ', @$args); + my ($cmd, $def, $cmd_args) = resolve_cmd($args); - no strict 'refs'; - my $def = ${"${class}::cmddef"}; + $abort->("no command specified") if !$cmd; - 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); + # call verifyapi before setup_environment(), don't execute any real code in + # this case + if ($cmd eq 'verifyapi') { + PVE::RESTHandler::validate_method_schemas(); + return; } - exit 0; -} - -sub handle_cmd { - my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_; - - $cmddef = $def; - $exename = $cmdname; - - $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ]; + $cli_handler_class->setup_environment(); - 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); + if ($cmd eq 'bashcomplete') { + &$print_bash_completion(undef, @$cmd_args); return; } - &$preparefunc() if $preparefunc; - - $cmd = &$expand_command_name($cmddef, $cmd); + # checked special commands, if def is still a hash we got an incomplete sub command + $abort->("incomplete command '$exename $cmd_str'") if ref($def) eq 'HASH'; - my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef->{$cmd} || []}; + &$preparefunc() if $preparefunc; - if (!$class) { - print_usage_short (\*STDERR, "unknown command '$cmd'"); - exit (-1); - } + my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []}; + $abort->("unknown command '$cmd_str'") if !$class; - my $prefix = "$exename $cmd"; - my $res = $class->cli_handler($prefix, $name, \@ARGV, $arg_param, $uri_param, $pwcallback); + my $prefix = "$exename $cmd_str"; + my $res = $class->cli_handler($prefix, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func); &$outsub($res) if $outsub; -} +}; -sub handle_simple_cmd { - my ($def, $args, $pwcallback, $podfn, $preparefunc) = @_; +my $handle_simple_cmd = sub { + my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_; - 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 .= generate_usage_str('long'); 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, $read_password_func, $param_mapping_func); &$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 $read_password_func = $class->can('read_password'); + my $param_mapping_func = $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, $read_password_func, $preparefunc, $param_mapping_func); + } else { + &$handle_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func); + } + + exit 0; } 1;