use strict;
use warnings;
-use Data::Dumper;
use PVE::SafeSyslog;
use PVE::Exception qw(raise raise_param_exc);
};
__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",
},
},
returns => { type => 'null' },
-
+
code => sub {
my ($param) = @_;
if (!$cmd) {
if ($verbose) {
print_usage_verbose();
- } else {
+ } else {
print_usage_short(\*STDOUT);
}
return undef;
my $get_exe_name = sub {
my ($class) = @_;
-
+
my $name = $class;
$name =~ s/^.*:://;
$name =~ s/_/-/g;
__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);
- }
-
- return $filename;
-}
-
sub generate_asciidoc_synopsys {
my ($class) = @_;
$class->generate_asciidoc_synopsis();
}
}
+# overwrite this if you want to run/setup things early
+sub setup_environment {
+ my ($class) = @_;
+
+ # do nothing by default
+}
+
my $handle_cmd = sub {
my ($def, $cmdname, $cmd, $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
+
+ if (!$cmd) {
print_usage_short (\*STDERR, "no command specified");
exit (-1);
} elsif ($cmd eq 'verifyapi') {
PVE::RESTHandler::validate_method_schemas();
return;
- } elsif ($cmd eq 'bashcomplete') {
+ }
+
+ $cli_handler_class->setup_environment();
+
+ if ($cmd eq 'bashcomplete') {
&$print_bash_completion($cmddef, 0, @$args);
return;
}
$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;
}
}
+ $cli_handler_class->setup_environment();
+
+ if (scalar(@$args) >= 1) {
+ if ($args->[0] eq 'bashcomplete') {
+ shift @$args;
+ &$print_bash_completion({ $name => $def }, $name, @$args);
+ return;
+ }
+ }
+
&$preparefunc() if $preparefunc;
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";
- # silently ignore $podfn , which is no longer supported.
-
- die "password callback is no longer supported" if $pwcallback;
-
- run_cli_handler($class, prepare => $preparefunc);
-}
-
sub run_cli_handler {
my ($class, %params) = @_;
initlog($exename);
- if ($class !~ m/^PVE::Service::/) {
- die "please run as root\n" if $> != 0;
- }
-
no strict 'refs';
my $def = ${"${class}::cmddef"};