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

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 33011c6..c382969 100644
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -3,47 +3,50 @@ package PVE::CLIHandler;
 use strict;
 use warnings;
 
+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);
 
 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 {
+    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",
 		type => 'string',
 		optional => 1,
+		completion => $complete_command_names,
 	    },
 	    verbose => {
 		description => "Verbose output format.",
@@ -53,11 +56,11 @@ __PACKAGE__->register_method ({
 	},
     },
     returns => { type => 'null' },
-    
+
     code => sub {
 	my ($param) = @_;
 
-	die "not initialized" if !($cmddef && $exename);
+	$assert_initialized->();
 
 	my $cmd = $param->{cmd};
 
@@ -67,7 +70,7 @@ __PACKAGE__->register_method ({
 	if (!$cmd) {
 	    if ($verbose) {
 		print_usage_verbose();
-	    } else {		
+	    } else {
 		print_usage_short(\*STDOUT);
 	    }
 	    return undef;
@@ -79,8 +82,12 @@ __PACKAGE__->register_method ({
 
 	raise_param_exc({ cmd => "no such command '$cmd'"}) if !$class;
 
+	my $pwcallback = $cli_handler_class->can('read_password');
+	my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
 
-	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,
+				    $stringfilemap);
 	if ($verbose) {
 	    print "$str\n";
 	} else {
@@ -91,46 +98,63 @@ __PACKAGE__->register_method ({
 
     }});
 
-sub print_pod_manpage {
-    my ($podfn) = @_;
+sub print_simple_asciidoc_synopsis {
+    my ($class, $name, $arg_param, $uri_param) = @_;
+
+    $assert_initialized->();
+
+    my $pwcallback = $cli_handler_class->can('read_password');
+    my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
+
+    my $synopsis = "*${name}* `help`\n\n";
+
+    $synopsis .= $class->usage_str($name, $name, $arg_param, $uri_param,
+				   'asciidoc', $pwcallback, $stringfilemap);
+
+    return $synopsis;
+}
+
+sub print_asciidoc_synopsis {
 
-    die "not initialized" if !($cmddef && $exename);
-    die "no pod file specified" if !$podfn;
+    $assert_initialized->();
+
+    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'?
+    $synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n";
+
     my $oldclass;
-    foreach my $cmd (sorted_commands()) {
+    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, $style);
-	$str =~ s/^USAGE: //;
-
+	my $str = $class->usage_str($name, "$exename $cmd", $arg_param,
+				    $uri_param, 'asciidoc', $pwcallback,
+				    $stringfilemap);
 	$synopsis .= "\n" if $oldclass && $oldclass ne $class;
-	$str =~ s/\n/\n /g;
-	$synopsis .= " $str\n\n";
+
+	$synopsis .= "$str\n\n";
 	$oldclass = $class;
     }
 
     $synopsis .= "\n";
 
-    my $parser = PVE::PodParser->new();
-    $parser->{include}->{synopsis} = $synopsis;
-    $parser->parse_from_file($podfn);
+    return $synopsis;
 }
 
 sub print_usage_verbose {
 
-    die "not initialized" if !($cmddef && $exename);
+    $assert_initialized->();
+
+    my $pwcallback = $cli_handler_class->can('read_password');
+    my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
 
     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, $stringfilemap);
 	print "$str\n\n";
     }
 }
@@ -142,7 +166,10 @@ sub sorted_commands {
 sub print_usage_short {
     my ($fd, $msg) = @_;
 
-    die "not initialized" if !($cmddef && $exename);
+    $assert_initialized->();
+
+    my $pwcallback = $cli_handler_class->can('read_password');
+    my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
 
     print $fd "ERROR: $msg\n" if $msg;
     print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n";
@@ -150,32 +177,211 @@ 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, $stringfilemap);
 	print $fd "\n" if $oldclass && $oldclass ne $class;
 	print $fd "       $str";
 	$oldclass = $class;
     }
 }
 
-sub handle_cmd {
-    my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn) = @_;
+my $print_bash_completion = sub {
+    my ($simple_cmd, $bash_command, $cur, $prev) = @_;
+
+    my $debug = 0;
+
+    return if !(defined($cur) && defined($prev) && defined($bash_command));
+    return if !defined($ENV{COMP_LINE});
+    return if !defined($ENV{COMP_POINT});
+
+    my $cmdline = substr($ENV{COMP_LINE}, 0, $ENV{COMP_POINT});
+    print STDERR "\nCMDLINE: $ENV{COMP_LINE}\n" if $debug;
+
+    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;
+
+    return if $pos < 0;
+
+    my $print_result = sub {
+	foreach my $p (@_) {
+	    print "$p\n" if $p =~ m/^$cur/;
+	}
+    };
+
+    my $cmd;
+    if ($simple_cmd) {
+	$cmd = $simple_cmd;
+    } else {
+	if ($pos == 0) {
+	    &$print_result(keys %$cmddef);
+	    return;
+	}
+	$cmd = $args->[1];
+    }
+
+    my $def = $cmddef->{$cmd};
+    return if !$def;
+
+    print STDERR "CMDLINE1:$pos:$cmdline\n" if $debug;
+
+    my $skip_param = {};
+
+    my ($class, $name, $arg_param, $uri_param) = @$def;
+    $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;
+
+    my $fpcount = scalar(@$arg_param);
+
+    my $info = $class->map_method_by_name($name);
+
+    my $schema = $info->{parameters};
+    my $prop = $schema->{properties};
+
+    my $print_parameter_completion = sub {
+	my ($pname) = @_;
+	my $d = $prop->{$pname};
+	if ($d->{completion}) {
+	    my $vt = ref($d->{completion});
+	    if ($vt eq 'CODE') {
+		my $res = $d->{completion}->($cmd, $pname, $cur, $args);
+		&$print_result(@$res);
+	    }
+	} elsif ($d->{type} eq 'boolean') {
+	    &$print_result('0', '1');
+	} elsif ($d->{enum}) {
+	    &$print_result(@{$d->{enum}});
+	}
+    };
+
+    # positional arguments
+    $pos += 1 if $simple_cmd;
+    if ($fpcount && $pos <= $fpcount) {
+	my $pname = $arg_param->[$pos -1];
+	&$print_parameter_completion($pname);
+	return;
+    }
+
+    my @option_list = ();
+    foreach my $key (keys %$prop) {
+	next if $skip_param->{$key};
+	push @option_list, "--$key";
+    }
+
+    if ($cur =~ m/^-/) {
+	&$print_result(@option_list);
+	return;
+    }
+
+    if ($prev =~ m/^--?(.+)$/ && $prop->{$1}) {
+	my $pname = $1;
+	&$print_parameter_completion($pname);
+	return;
+    }
 
+    &$print_result(@option_list);
+};
+
+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 -o default -C '$exename bashcomplete' $exename
+__EOD__
+}
+
+sub generate_asciidoc_synopsys {
+    my ($class) = @_;
+    $class->generate_asciidoc_synopsis();
+};
+
+sub generate_asciidoc_synopsis {
+    my ($class) = @_;
+
+    $cli_handler_class = $class;
+
+    $exename = &$get_exe_name($class);
+
+    no strict 'refs';
+    my $def = ${"${class}::cmddef"};
     $cmddef = $def;
-    $exename = $cmdname;
+
+    if (ref($def) eq 'ARRAY') {
+	print_simple_asciidoc_synopsis(@$def);
+    } else {
+	$cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
+
+	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 ($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') {
-	print_pod_manpage($podfn);
+    }
+
+    $cli_handler_class->setup_environment();
+
+    if ($cmd eq 'bashcomplete') {
+	&$print_bash_completion(undef, @$args);
 	return;
     }
 
+    &$preparefunc() if $preparefunc;
+
     $cmd = &$expand_command_name($cmddef, $cmd);
 
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef->{$cmd} || []};
@@ -186,43 +392,79 @@ sub handle_cmd {
     }
 
     my $prefix = "$exename $cmd";
-    my $res = $class->cli_handler($prefix, $name, \@ARGV, $arg_param, $uri_param, $pwcallback);
+    my $res = $class->cli_handler($prefix, $name, \@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap);
 
     &$outsub($res) if $outsub;
-}
+};
 
-sub handle_simple_cmd {
-    my ($def, $args, $pwcallback, $podfn) = @_;
+my $handle_simple_cmd = sub {
+    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) {
+    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, $stringfilemap);
 	    print STDERR "$str\n\n";
 	    return;
 	} elsif ($args->[0] eq 'verifyapi') {
 	    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);
+	}
+    }
+
+    $cli_handler_class->setup_environment();
+
+    if (scalar(@$args) >= 1) {
+	if ($args->[0] eq 'bashcomplete') {
+	    shift @$args;
+	    &$print_bash_completion($name, @$args);
 	    return;
 	}
     }
 
-    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback);
+    &$preparefunc() if $preparefunc;
+
+    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap);
 
     &$outsub($res) if $outsub;
+};
+
+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 'prepare';
+	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 $pwcallback = $class->can('read_password');
+    my $stringfilemap = $class->can('string_param_file_mapping');
+
+    $exename = &$get_exe_name($class);
+
+    initlog($exename);
+
+    no strict 'refs';
+    $cmddef = ${"${class}::cmddef"};
+
+    if (ref($cmddef) eq 'ARRAY') {
+	&$handle_simple_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
+    } else {
+	&$handle_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
+    }
+
+    exit 0;
 }
 
 1;