X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=c3829694b77e46bee13acb7a2904da1664425b8a;hp=b684ca8408b790afb3d5f1c95797f0a7f64a5478;hb=7bac844eaab512d8789a9103d0efa774a1bab0d6;hpb=4845032a4636260385b59b55aabdb05c700fea2f

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index b684ca8..c382969 100644
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -2,12 +2,10 @@ package PVE::CLIHandler;
 
 use strict;
 use warnings;
-use Data::Dumper;
 
 use PVE::SafeSyslog;
 use PVE::Exception qw(raise raise_param_exc);
 use PVE::RESTHandler;
-use PVE::PodParser;
 use PVE::INotify;
 
 use base qw(PVE::RESTHandler);
@@ -16,46 +14,33 @@ my $cmddef;
 my $exename;
 my $cli_handler_class;
 
+my $assert_initialized = sub {
+    my @caller = caller;
+    die "$caller[0]:$caller[2] - not initialized\n"
+	if !($cmddef && $exename && $cli_handler_class);
+};
+
 my $expand_command_name = sub {
     my ($def, $cmd) = @_;
 
     if (!$def->{$cmd}) {
-	my $expanded;
-	for my $k (keys(%$def)) {
-	    if ($k =~ m/^$cmd/) {
-		if ($expanded) {
-		    $expanded = undef; # more than one match
-		    last;
-		} else {
-		    $expanded = $k;
-		}
-	    }
-	}
-	$cmd = $expanded if $expanded;
+	my @expanded = grep { /^\Q$cmd\E/ } keys %$def;
+	return $expanded[0] if scalar(@expanded) == 1; # enforce exact match
     }
     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;
+    return [ sort keys %$cmddef ];
 };
 
 __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",
@@ -71,11 +56,11 @@ __PACKAGE__->register_method ({
 	},
     },
     returns => { type => 'null' },
-    
+
     code => sub {
 	my ($param) = @_;
 
-	die "not initialized" if !($cmddef && $exename && $cli_handler_class);
+	$assert_initialized->();
 
 	my $cmd = $param->{cmd};
 
@@ -85,7 +70,7 @@ __PACKAGE__->register_method ({
 	if (!$cmd) {
 	    if ($verbose) {
 		print_usage_verbose();
-	    } else {		
+	    } else {
 		print_usage_short(\*STDOUT);
 	    }
 	    return undef;
@@ -113,10 +98,10 @@ __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;
+    $assert_initialized->();
 
     my $pwcallback = $cli_handler_class->can('read_password');
     my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
@@ -129,9 +114,9 @@ sub print_simple_asciidoc_synopsys {
     return $synopsis;
 }
 
-sub print_asciidoc_synopsys {
+sub print_asciidoc_synopsis {
 
-    die "not initialized" if !($cmddef && $exename && $cli_handler_class);
+    $assert_initialized->();
 
     my $pwcallback = $cli_handler_class->can('read_password');
     my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
@@ -157,63 +142,9 @@ sub print_asciidoc_synopsys {
     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 $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
-
-    my $synopsis = " $name help\n\n";
-    my $str = $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback, $stringfilemap);
-    $str =~ s/^USAGE://;
-    $str =~ s/\n/\n /g;
-    $synopsis .= $str;
-
-    my $parser = PVE::PodParser->new();
-    $parser->{include}->{synopsis} = $synopsis;
-    $parser->parse_from_file($podfn);
-}
-
-sub print_pod_manpage {
-    my ($podfn) = @_;
-
-    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 $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
-
-    my $synopsis = "";
-    
-    $synopsis .= " $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
-
-    my $style = 'full'; # or should we use 'short'?
-    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, $pwcallback,
-				    $stringfilemap);
-	$str =~ s/^USAGE: //;
-
-	$synopsis .= "\n" if $oldclass && $oldclass ne $class;
-	$str =~ s/\n/\n /g;
-	$synopsis .= " $str\n\n";
-	$oldclass = $class;
-    }
-
-    $synopsis .= "\n";
-
-    my $parser = PVE::PodParser->new();
-    $parser->{include}->{synopsis} = $synopsis;
-    $parser->parse_from_file($podfn);
-}
-
 sub print_usage_verbose {
 
-    die "not initialized" if !($cmddef && $exename && $cli_handler_class);
+    $assert_initialized->();
 
     my $pwcallback = $cli_handler_class->can('read_password');
     my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
@@ -235,7 +166,7 @@ sub sorted_commands {
 sub print_usage_short {
     my ($fd, $msg) = @_;
 
-    die "not initialized" if !($cmddef && $exename && $cli_handler_class);
+    $assert_initialized->();
 
     my $pwcallback = $cli_handler_class->can('read_password');
     my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
@@ -254,7 +185,7 @@ sub print_usage_short {
 }
 
 my $print_bash_completion = sub {
-    my ($cmddef, $simple_cmd, $bash_command, $cur, $prev) = @_;
+    my ($simple_cmd, $bash_command, $cur, $prev) = @_;
 
     my $debug = 0;
 
@@ -366,7 +297,7 @@ sub verify_api {
 
 my $get_exe_name = sub {
     my ($class) = @_;
-    
+
     my $name = $class;
     $name =~ s/^.*:://;
     $name =~ s/_/-/g;
@@ -393,95 +324,59 @@ 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_pod_manpage {
-    my ($class, $podfn) = @_;
+sub generate_asciidoc_synopsis {
+    my ($class) = @_;
 
     $cli_handler_class = $class;
 
     $exename = &$get_exe_name($class);
 
-    $podfn = find_cli_class_source($exename) if !defined($podfn);
-
-    die "unable to find source for class '$class'" if !$podfn;
-
     no strict 'refs';
     my $def = ${"${class}::cmddef"};
+    $cmddef = $def;
 
     if (ref($def) eq 'ARRAY') {
-	print_simple_pod_manpage($podfn, @$def);
+	print_simple_asciidoc_synopsis(@$def);
     } else {
-	$cmddef = $def;
-
 	$cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
 
-	print_pod_manpage($podfn);
+	print_asciidoc_synopsis();
     }
 }
 
-sub generate_asciidoc_synopsys {
+# overwrite this if you want to run/setup things early
+sub setup_environment {
     my ($class) = @_;
 
-    $cli_handler_class = $class;
-
-    $exename = &$get_exe_name($class);
-
-    no strict 'refs';
-    my $def = ${"${class}::cmddef"};
-
-    if (ref($def) eq 'ARRAY') {
-	print_simple_asciidoc_synopsys(@$def);
-    } else {
-	$cmddef = $def;
-
-	$cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
-
-	print_asciidoc_synopsys();
-    }
+    # do nothing by default
 }
 
 my $handle_cmd  = sub {
-    my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc, $stringfilemap) = @_;
-
-    $cmddef = $def;
-    $exename = $cmdname;
+    my ($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
+
+    my $cmd = shift @$args;
+    if (!$cmd) {
 	print_usage_short (\*STDERR, "no command specified");
 	exit (-1);
     } elsif ($cmd eq 'verifyapi') {
 	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') {
-	&$print_bash_completion($cmddef, 0, @$args);
+    }
+
+    $cli_handler_class->setup_environment();
+
+    if ($cmd eq 'bashcomplete') {
+	&$print_bash_completion(undef, @$args);
 	return;
     }
 
@@ -503,9 +398,9 @@ my $handle_cmd  = sub {
 };
 
 my $handle_simple_cmd = sub {
-    my ($def, $args, $pwcallback, $podfn, $preparefunc, $stringfilemap) = @_;
+    my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
 
-    my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def};
+    my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef};
     die "no class specified" if !$class;
 
     if (scalar(@$args) >= 1) {
@@ -514,16 +409,18 @@ 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;
-	} elsif ($args->[0] eq 'printmanpod') {
-	    $podfn = find_cli_class_source($name) if !defined($podfn);
-	    print_simple_pod_manpage($podfn, @$def);
+	}
+    }
+
+    $cli_handler_class->setup_environment();
+
+    if (scalar(@$args) >= 1) {
+	if ($args->[0] eq 'bashcomplete') {
+	    shift @$args;
+	    &$print_bash_completion($name, @$args);
 	    return;
 	}
     }
@@ -535,16 +432,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";
-    
-    die "password callback is no longer supported" if $pwcallback;
-
-    run_cli_handler($class, podfn => $podfn, prepare => $preparefunc);
-}
-
 sub run_cli_handler {
     my ($class, %params) = @_;
 
@@ -553,15 +440,13 @@ sub run_cli_handler {
     $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
+	next if $key eq 'no_init'; # not used anymore
+	next if $key eq 'no_rpcenv'; # not used anymore
 	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');
@@ -570,26 +455,13 @@ 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"};
+    $cmddef = ${"${class}::cmddef"};
 
-    if (ref($def) eq 'ARRAY') {
-	&$handle_simple_cmd($def, \@ARGV, $pwcallback, $podfn, $preparefunc, $stringfilemap);
+    if (ref($cmddef) eq 'ARRAY') {
+	&$handle_simple_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
     } else {
-	$cmddef = $def;
-	my $cmd = shift @ARGV;
-	&$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc, $stringfilemap);
+	&$handle_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
     }
 
     exit 0;