Remove deprecated run_cli subroutine

[pve-common.git] / src / PVE / CLIHandler.pm

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index c448a80ef7828cb2f00f4961bce7c0fcd75cc211..efc8a1a2bb4ffe67e0a94ac75504378ce0ba2611 100644 (file)
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -2,7 +2,6 @@ package PVE::CLIHandler;
 
 use strict;
 use warnings;
-use Data::Dumper;
 
 use PVE::SafeSyslog;
 use PVE::Exception qw(raise raise_param_exc);
@@ -49,12 +48,12 @@ my $complete_command_names = sub {
 };
 
 __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",
@@ -70,7 +69,7 @@ __PACKAGE__->register_method ({
        },
     },
     returns => { type => 'null' },
-    
+
     code => sub {
        my ($param) = @_;
 
@@ -84,7 +83,7 @@ __PACKAGE__->register_method ({
        if (!$cmd) {
            if ($verbose) {
                print_usage_verbose();
-           } else {            
+           } else {
                print_usage_short(\*STDOUT);
            }
            return undef;
@@ -112,7 +111,7 @@ __PACKAGE__->register_method ({
 
     }});
 
-sub print_simple_asciidoc_synopsys {
+sub print_simple_asciidoc_synopsis {
     my ($class, $name, $arg_param, $uri_param) = @_;
 
     die "not initialized" if !$cli_handler_class;
@@ -128,7 +127,7 @@ sub print_simple_asciidoc_synopsys {
     return $synopsis;
 }
 
-sub print_asciidoc_synopsys {
+sub print_asciidoc_synopsis {
 
     die "not initialized" if !($cmddef && $exename && $cli_handler_class);
 
@@ -311,7 +310,7 @@ sub verify_api {
 
 my $get_exe_name = sub {
     my ($class) = @_;
-    
+
     my $name = $class;
     $name =~ s/^.*:://;
     $name =~ s/_/-/g;
@@ -338,31 +337,13 @@ 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);
-    }
-
-    return $filename;
-}
-
 sub generate_asciidoc_synopsys {
     my ($class) = @_;
+    $class->generate_asciidoc_synopsis();
+};
+
+sub generate_asciidoc_synopsis {
+    my ($class) = @_;
 
     $cli_handler_class = $class;
 
@@ -372,16 +353,23 @@ sub generate_asciidoc_synopsys {
     my $def = ${"${class}::cmddef"};
 
     if (ref($def) eq 'ARRAY') {
-       print_simple_asciidoc_synopsys(@$def);
+       print_simple_asciidoc_synopsis(@$def);
     } else {
        $cmddef = $def;
 
        $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
 
-       print_asciidoc_synopsys();
+       print_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) = @_;
 
@@ -390,13 +378,20 @@ my $handle_cmd  = sub {
 
     $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;
     }
@@ -430,16 +425,22 @@ my $handle_simple_cmd = sub {
            $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);
@@ -447,17 +448,6 @@ my $handle_simple_cmd = sub {
     &$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) = @_;
 
@@ -467,12 +457,12 @@ sub run_cli_handler {
 
     foreach my $key (keys %params) {
        next if $key eq 'prepare';
-       next if $key eq 'no_init'; # used by lxc hooks
+       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 $no_init = $params{no_init};
 
     my $pwcallback = $class->can('read_password');
     my $stringfilemap = $class->can('string_param_file_mapping');
@@ -481,17 +471,6 @@ sub run_cli_handler {
 
     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"};