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 $expand_command_name = sub {
my ($def, $cmd) = @_;
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;
+};
+
__PACKAGE__->register_method ({
name => 'help',
path => 'help',
description => "Command name",
type => 'string',
optional => 1,
+ completion => $complete_command_names,
},
verbose => {
description => "Verbose output format.",
code => sub {
my ($param) = @_;
- die "not initialized" if !($cmddef && $exename);
+ die "not initialized" if !($cmddef && $exename && $cli_handler_class);
my $cmd = $param->{cmd};
raise_param_exc({ cmd => "no such command '$cmd'"}) if !$class;
+ my $pwcallback = $cli_handler_class->can('read_password');
- 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);
if ($verbose) {
print "$str\n";
} else {
}});
+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}* `<COMMAND> [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 !$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');
+ my $str = $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback);
$str =~ s/^USAGE://;
$str =~ s/\n/\n /g;
$synopsis .= $str;
sub print_pod_manpage {
my ($podfn) = @_;
- die "not initialized" if !($cmddef && $exename);
+ 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 <COMMAND> [ARGS] [OPTIONS]\n\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, $style);
+ my $str = $class->usage_str($name, "$exename $cmd", $arg_param,
+ $uri_param, $style, $pwcallback);
$str =~ s/^USAGE: //;
$synopsis .= "\n" if $oldclass && $oldclass ne $class;
sub print_usage_verbose {
- die "not initialized" if !($cmddef && $exename);
+ die "not initialized" if !($cmddef && $exename && $cli_handler_class);
+
+ my $pwcallback = $cli_handler_class->can('read_password');
print "USAGE: $exename <COMMAND> [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);
print "$str\n\n";
}
}
sub print_usage_short {
my ($fd, $msg) = @_;
- die "not initialized" if !($cmddef && $exename);
+ die "not initialized" if !($cmddef && $exename && $cli_handler_class);
+
+ my $pwcallback = $cli_handler_class->can('read_password');
print $fd "ERROR: $msg\n" if $msg;
print $fd "USAGE: $exename <COMMAND> [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');
+ my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, 'short', $pwcallback);
print $fd "\n" if $oldclass && $oldclass ne $class;
print $fd " $str";
$oldclass = $class;
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;
&$print_result(keys %$cmddef);
return;
}
- $cmd = $args[1];
+ $cmd = $args->[1];
}
my $def = $cmddef->{$cmd};
$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;
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') {
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
# 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 ($name) = @_;
my $filename;
- my $cpath = "PVE/CLI/${exename}.pm";
+ $name =~ s/-/_/g;
+
+ my $cpath = "PVE/CLI/${name}.pm";
+ my $spath = "PVE/Service/${name}.pm";
foreach my $p (@INC) {
- my $testfn = "$p/$cpath";
- if (-f $testfn) {
- $filename = $testfn;
- last;
+ 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) = @_;
- $exename = $class;
- $exename =~ s/^.*:://;
+ $cli_handler_class = $class;
+
+ $exename = &$get_exe_name($class);
$podfn = find_cli_class_source($exename) if !defined($podfn);
print_simple_pod_manpage($podfn, @$def);
} else {
$cmddef = $def;
+
+ $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
+
print_pod_manpage($podfn);
}
}
-sub run {
- my ($class, $pwcallback, $podfn, $preparefunc) = @_;
-
- $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
-
- $exename = $class;
- $exename =~ s/^.*:://;
-
- initlog($exename);
-
- die "please run as root\n" if $> != 0;
+sub generate_asciidoc_synopsys {
+ my ($class) = @_;
- PVE::INotify::inotify_init();
+ $cli_handler_class = $class;
- my $rpcenv = PVE::RPCEnvironment->init('cli');
- $rpcenv->init_request();
- $rpcenv->set_language($ENV{LANG});
- $rpcenv->set_user('root@pam');
+ $exename = &$get_exe_name($class);
no strict 'refs';
my $def = ${"${class}::cmddef"};
if (ref($def) eq 'ARRAY') {
- handle_simple_cmd($def, \@ARGV, $pwcallback, $podfn, $preparefunc);
+ print_simple_asciidoc_synopsys(@$def);
} else {
$cmddef = $def;
- my $cmd = shift @ARGV;
- handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc);
- }
- exit 0;
+ $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
+
+ print_asciidoc_synopsys();
+ }
}
-sub handle_cmd {
- my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_;
+my $handle_cmd = sub {
+ my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc, $stringfilemap) = @_;
$cmddef = $def;
$exename = $cmdname;
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') {
}
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 ($def, $args, $pwcallback, $podfn, $preparefunc, $stringfilemap) = @_;
my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def};
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);
print STDERR "$str\n\n";
return;
} elsif ($args->[0] eq 'bashcomplete') {
&$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 {
+ my ($class, $pwcallback, $podfn, $preparefunc) = @_;
+
+ # Note: "depreciated function run_cli - use run_cli_handler instead";
+
+ die "password callback is no longer supported" if $pwcallback;
+
+ run_cli_handler($class, podfn => $podfn, prepare => $preparefunc);
+}
+
+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 '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{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);
+
+ 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);
+ } else {
+ $cmddef = $def;
+ my $cmd = shift @ARGV;
+ &$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc, $stringfilemap);
+ }
+
+ exit 0;
}
1;
projects / pve-common.git / blobdiff