CLIHandler.pm: add setup_environment hook
authorDietmar Maurer <dietmar@proxmox.com>
Thu, 12 Jan 2017 09:12:15 +0000 (10:12 +0100)
committerFabian Gr├╝nbichler <f.gruenbichler@proxmox.com>
Fri, 13 Jan 2017 09:19:59 +0000 (10:19 +0100)
Most PVE command line tools will simply call

 PVE::RPCEnvironment->setup_default_cli_env();

there.

Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>
src/PVE/CLIHandler.pm

index 199241f..33c47c3 100644 (file)
@@ -387,6 +387,13 @@ sub 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) = @_;
 
@@ -395,13 +402,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;
     }
@@ -435,16 +449,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);