X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=f973bdc1ccce6c2425665fa3e5bd2caeb5f82fd5;hp=6d3f69dd06317b26e5685cf437f115d158e7406a;hb=5ffbe2f10ac9c4b7f95cfde9ff91e542ac32b07c;hpb=d8053c08c27a33bd8073408fedeff4b6255446e8

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 6d3f69d..f973bdc 100644
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -4,6 +4,7 @@ use strict;
 use warnings;
 use Data::Dumper;
 
+use PVE::SafeSyslog;
 use PVE::Exception qw(raise raise_param_exc);
 use PVE::RESTHandler;
 use PVE::PodParser;
@@ -12,6 +13,7 @@ use base qw(PVE::RESTHandler);
 
 my $cmddef;
 my $exename;
+my $cli_handler_class;
 
 my $expand_command_name = sub {
     my ($def, $cmd) = @_;
@@ -33,6 +35,19 @@ my $expand_command_name = sub {
     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;
+};
+
 __PACKAGE__->register_method ({
     name => 'help', 
     path => 'help',
@@ -45,6 +60,7 @@ __PACKAGE__->register_method ({
 		description => "Command name",
 		type => 'string',
 		optional => 1,
+		completion => $complete_command_names,
 	    },
 	    verbose => {
 		description => "Verbose output format.",
@@ -58,7 +74,7 @@ __PACKAGE__->register_method ({
     code => sub {
 	my ($param) = @_;
 
-	die "not initialized" if !($cmddef && $exename);
+	die "not initialized" if !($cmddef && $exename && $cli_handler_class);
 
 	my $cmd = $param->{cmd};
 
@@ -80,8 +96,10 @@ __PACKAGE__->register_method ({
 
 	raise_param_exc({ cmd => "no such command '$cmd'"}) if !$class;
 
+	my $pwcallback = $cli_handler_class->can('read_password');
 
-	my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, $verbose ? 'full' : 'short');
+	my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
+				    $verbose ? 'full' : 'short', $pwcallback);
 	if ($verbose) {
 	    print "$str\n";
 	} else {
@@ -92,12 +110,32 @@ __PACKAGE__->register_method ({
 
     }});
 
+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 $synopsis = " $name help\n\n";
+    my $str = $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback);
+    $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);
+    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 $synopsis = "";
     
     $synopsis .= " $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
@@ -106,8 +144,8 @@ sub print_pod_manpage {
     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);
+	my $str = $class->usage_str($name, "$exename $cmd", $arg_param,
+				    $uri_param, $style, $pwcallback);
 	$str =~ s/^USAGE: //;
 
 	$synopsis .= "\n" if $oldclass && $oldclass ne $class;
@@ -125,13 +163,16 @@ sub print_pod_manpage {
 
 sub print_usage_verbose {
 
-    die "not initialized" if !($cmddef && $exename);
+    die "not initialized" if !($cmddef && $exename && $cli_handler_class);
+
+    my $pwcallback = $cli_handler_class->can('read_password');
 
     print "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
 
     foreach my $cmd (sort keys %$cmddef) {
 	my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
-	my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, 'full');
+	my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
+				    'full', $pwcallback);
 	print "$str\n\n";
     }
 }
@@ -143,7 +184,9 @@ sub sorted_commands {
 sub print_usage_short {
     my ($fd, $msg) = @_;
 
-    die "not initialized" if !($cmddef && $exename);
+    die "not initialized" if !($cmddef && $exename && $cli_handler_class);
+
+    my $pwcallback = $cli_handler_class->can('read_password');
 
     print $fd "ERROR: $msg\n" if $msg;
     print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n";
@@ -151,7 +194,7 @@ sub print_usage_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, 'short');
+	my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, 'short', $pwcallback);
 	print $fd "\n" if $oldclass && $oldclass ne $class;
 	print $fd "       $str";
 	$oldclass = $class;
@@ -170,9 +213,8 @@ my $print_bash_completion = sub {
     my $cmdline = substr($ENV{COMP_LINE}, 0, $ENV{COMP_POINT});
     print STDERR "\nCMDLINE: $ENV{COMP_LINE}\n" if $debug;
 
-    # fixme: shell quoting??
-    my @args = split(/\s+/, $cmdline);
-    my $pos = scalar(@args) - 2;
+    my $args = PVE::Tools::split_args($cmdline);
+    my $pos = scalar(@$args) - 2;
     $pos += 1 if $cmdline =~ m/\s+$/;
 
     print STDERR "CMDLINE:$pos:$cmdline\n" if $debug;
@@ -193,7 +235,7 @@ my $print_bash_completion = sub {
 	    &$print_result(keys %$cmddef);
 	    return;
 	}
-	$cmd = $args[1];
+	$cmd = $args->[1];
     }
 
     my $def = $cmddef->{$cmd};
@@ -207,6 +249,8 @@ my $print_bash_completion = sub {
     $arg_param //= [];
     $uri_param //= {};
 
+    $arg_param = [ $arg_param ] if !ref($arg_param);
+
     map { $skip_param->{$_} = 1; } @$arg_param;
     map { $skip_param->{$_} = 1; } keys %$uri_param;
 
@@ -223,7 +267,7 @@ my $print_bash_completion = sub {
 	if ($d->{completion}) {
 	    my $vt = ref($d->{completion});
 	    if ($vt eq 'CODE') {
-		my $res = $d->{completion}->($cmd, $pname, $cur);
+		my $res = $d->{completion}->($cmd, $pname, $cur, $args);
 		&$print_result(@$res);
 	    }
 	} elsif ($d->{type} eq 'boolean') {
@@ -261,7 +305,91 @@ my $print_bash_completion = sub {
     &$print_result(@option_list);
 };
 
-sub handle_cmd {
+sub verify_api {
+    my ($class) = @_;
+
+    # simply verify all registered methods
+    PVE::RESTHandler::validate_method_schemas();
+}
+
+my $get_exe_name = sub {
+    my ($class) = @_;
+    
+    my $name = $class;
+    $name =~ s/^.*:://;
+    $name =~ s/_/-/g;
+
+    return $name;
+};
+
+sub generate_bash_completions {
+    my ($class) = @_;
+
+    # generate bash completion config
+
+    $exename = &$get_exe_name($class);
+
+    print <<__EOD__;
+# $exename bash completion
+
+# see http://tiswww.case.edu/php/chet/bash/FAQ
+# and __ltrim_colon_completions() in /usr/share/bash-completion/bash_completion
+# this modifies global var, but I found no better way
+COMP_WORDBREAKS=\${COMP_WORDBREAKS//:}
+
+complete -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_pod_manpage {
+    my ($class, $podfn) = @_;
+
+    $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"};
+
+    if (ref($def) eq 'ARRAY') {
+	print_simple_pod_manpage($podfn, @$def);
+    } else {
+	$cmddef = $def;
+
+	$cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
+
+	print_pod_manpage($podfn);
+    }
+}
+
+my $handle_cmd  = sub {
     my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_;
 
     $cmddef = $def;
@@ -276,6 +404,7 @@ sub handle_cmd {
 	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') {
@@ -298,10 +427,10 @@ sub handle_cmd {
     my $res = $class->cli_handler($prefix, $name, \@ARGV, $arg_param, $uri_param, $pwcallback);
 
     &$outsub($res) if $outsub;
-}
+};
 
-sub handle_simple_cmd {
-    my ($def, $args, $pwcallback, $podfn) = @_;
+my $handle_simple_cmd = sub {
+    my ($def, $args, $pwcallback, $podfn, $preparefunc) = @_;
 
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def};
     die "no class specified" if !$class;
@@ -309,7 +438,7 @@ sub handle_simple_cmd {
     if (scalar(@$args) >= 1) {
 	if ($args->[0] eq 'help') {
 	    my $str = "USAGE: $name help\n";
-	    $str .= $class->usage_str($name, $name, $arg_param, $uri_param, 'long');
+	    $str .= $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback);
 	    print STDERR "$str\n\n";
 	    return;
 	} elsif ($args->[0] eq 'bashcomplete') {
@@ -320,22 +449,76 @@ sub handle_simple_cmd {
 	    PVE::RESTHandler::validate_method_schemas();
 	    return;
 	} elsif ($args->[0] eq 'printmanpod') {
-	    my $synopsis = " $name help\n\n";
-	    my $str = $class->usage_str($name, $name, $arg_param, $uri_param, 'long');
-	    $str =~ s/^USAGE://;
-	    $str =~ s/\n/\n /g;
-	    $synopsis .= $str;
-
-	    my $parser = PVE::PodParser->new();
-	    $parser->{include}->{synopsis} = $synopsis;
-	    $parser->parse_from_file($podfn);
+	    $podfn = find_cli_class_source($name) if !defined($podfn);
+	    print_simple_pod_manpage($podfn, @$def);
 	    return;
 	}
     }
 
+    &$preparefunc() if $preparefunc;
+
     my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback);
 
     &$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) = @_;
+
+    $cli_handler_class = $class;
+
+    $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
+	die "unknown parameter '$key'";
+    }
+
+    my $podfn = $params{podfn};
+    my $preparefunc = $params{prepare};
+    my $no_init = $params{no_init};
+
+    my $pwcallback = $class->can('read_password');
+
+    $exename = &$get_exe_name($class);
+
+    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"};
+
+    if (ref($def) eq 'ARRAY') {
+	&$handle_simple_cmd($def, \@ARGV, $pwcallback, $podfn, $preparefunc);
+    } else {
+	$cmddef = $def;
+	my $cmd = shift @ARGV;
+	&$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc);
+    }
+
+    exit 0;
 }
 
 1;