X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=0c48335fb6308895be3993373a2584e803ff61ef;hp=61434cc87206ce21f7569b2f40a890ccb3904636;hb=367f04c5773ca7dbe93f63da819711d4b143e085;hpb=aa9b9af5a81acdac12403506085e0c2bf769497b

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 61434cc..0c48335 100644
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -2,12 +2,11 @@ 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);
 
@@ -97,9 +96,11 @@ __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', $pwcallback);
+				    $verbose ? 'full' : 'short', $pwcallback,
+				    $stringfilemap);
 	if ($verbose) {
 	    print "$str\n";
 	} else {
@@ -110,55 +111,48 @@ __PACKAGE__->register_method ({
 
     }});
 
-sub print_simple_pod_manpage {
-    my ($podfn, $class, $name, $arg_param, $uri_param) = @_;
+sub print_simple_asciidoc_synopsis {
+    my ($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);
-    $str =~ s/^USAGE://;
-    $str =~ s/\n/\n /g;
-    $synopsis .= $str;
+    my $synopsis = "*${name}* `help`\n\n";
 
-    my $parser = PVE::PodParser->new();
-    $parser->{include}->{synopsis} = $synopsis;
-    $parser->parse_from_file($podfn);
+    $synopsis .= $class->usage_str($name, $name, $arg_param, $uri_param,
+				   'asciidoc', $pwcallback, $stringfilemap);
+
+    return $synopsis;
 }
 
-sub print_pod_manpage {
-    my ($podfn) = @_;
+sub print_asciidoc_synopsis {
 
     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'?
+    $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, $pwcallback);
-	$str =~ s/^USAGE: //;
-
+				    $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 {
@@ -166,13 +160,14 @@ sub print_usage_verbose {
     die "not initialized" if !($cmddef && $exename && $cli_handler_class);
 
     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', $pwcallback);
+				    'full', $pwcallback, $stringfilemap);
 	print "$str\n\n";
     }
 }
@@ -187,6 +182,7 @@ sub print_usage_short {
     die "not initialized" if !($cmddef && $exename && $cli_handler_class);
 
     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";
@@ -194,7 +190,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', $pwcallback);
+	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;
@@ -337,77 +333,65 @@ sub generate_bash_completions {
 # this modifies global var, but I found no better way
 COMP_WORDBREAKS=\${COMP_WORDBREAKS//:}
 
-complete -C '$exename bashcomplete' $exename
+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"};
 
     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();
     }
 }
 
+# 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, $podfn, $preparefunc) = @_;
+    my ($def, $cmdname, $cmd, $args, $pwcallback, $preparefunc, $stringfilemap) = @_;
 
     $cmddef = $def;
     $exename = $cmdname;
 
     $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 'printmanpod') {
-	$podfn = find_cli_class_source($exename) if !defined($podfn);
-	print_pod_manpage($podfn);
-	return;
-    } elsif ($cmd eq 'bashcomplete') {
+    }
+
+    $cli_handler_class->setup_environment();
+
+    if ($cmd eq 'bashcomplete') {
 	&$print_bash_completion($cmddef, 0, @$args);
 	return;
     }
@@ -424,13 +408,13 @@ my $handle_cmd  = sub {
     }
 
     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;
 };
 
 my $handle_simple_cmd = sub {
-    my ($def, $args, $pwcallback, $podfn, $preparefunc) = @_;
+    my ($def, $args, $pwcallback, $preparefunc, $stringfilemap) = @_;
 
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def};
     die "no class specified" if !$class;
@@ -438,26 +422,28 @@ my $handle_simple_cmd = sub {
     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', $pwcallback);
+	    $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 => $def }, $name, @$args);
 	    return;
 	}
     }
 
     &$preparefunc() if $preparefunc;
 
-    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback);
+    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap);
 
     &$outsub($res) if $outsub;
 };
@@ -466,10 +452,11 @@ sub run_cli {
     my ($class, $pwcallback, $podfn, $preparefunc) = @_;
 
     # Note: "depreciated function run_cli - use run_cli_handler instead";
-    
+    # silently ignore $podfn , which is no longer supported.
+
     die "password callback is no longer supported" if $pwcallback;
 
-    run_cli_handler($class, podfn => $podfn, preparefunc => $preparefunc);
+    run_cli_handler($class, prepare => $preparefunc);
 }
 
 sub run_cli_handler {
@@ -480,40 +467,30 @@ 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 'preparefunc';
+	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 $podfn = $params{podfn};
-    my $preparefunc = $params{preparefunc};
+    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);
 
-    if ($class !~ m/^PVE::Service::/) {
-	die "please run as root\n" if $> != 0;
-
-	PVE::INotify::inotify_init();
-
-	my $rpcenv = PVE::RPCEnvironment->init('cli');
-	$rpcenv->init_request();
-	$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);
+	&$handle_simple_cmd($def, \@ARGV, $pwcallback, $preparefunc, $stringfilemap);
     } else {
 	$cmddef = $def;
 	my $cmd = shift @ARGV;
-	&$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc);
+	&$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $preparefunc, $stringfilemap);
     }
 
     exit 0;