[pve-devel] [PATCH pve-common 2/3] CLIHandler.pm: add setup_environment hook

[Fabian Grünbichler]

On Thu, Jan 12, 2017 at 10:12:15AM +0100, Dietmar Maurer wrote:
> Most PVE command line tools will simply call
> 
>  PVE::RPCEnvironment->setup_default_cli_env();
> 
> there.

maybe this should go into the comment below then? right now it sounds
like "if you don't do anything special, leave this alone"

> 
> Signed-off-by: Dietmar Maurer <dietmar at proxmox.com>
> ---
>  src/PVE/CLIHandler.pm | 32 ++++++++++++++++++++++++++------
>  1 file changed, 26 insertions(+), 6 deletions(-)
> 
> diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
> index 199241f..f08371c 100644
> --- a/src/PVE/CLIHandler.pm
> +++ b/src/PVE/CLIHandler.pm
> @@ -387,6 +387,13 @@ sub generate_asciidoc_synopsis {
>      }
>  }
>  
> +# overwrite this if you want to run/setup things early

this comment ^^

> +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 don not want to

s/don not/do not/

> +    # 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);
> -- 
> 2.1.4
> 
> _______________________________________________
> pve-devel mailing list
> pve-devel at pve.proxmox.com
> http://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel