]> git.proxmox.com Git - pve-common.git/blobdiff - src/PVE/CLIHandler.pm
Fix uninitialized subroutine error
[pve-common.git] / src / PVE / CLIHandler.pm
index 61434cc87206ce21f7569b2f40a890ccb3904636..b684ca8408b790afb3d5f1c95797f0a7f64a5478 100644 (file)
@@ -8,6 +8,7 @@ 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 +98,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,15 +113,60 @@ __PACKAGE__->register_method ({
 
     }});
 
+sub print_simple_asciidoc_synopsys {
+    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";
+
+    $synopsis .= $class->usage_str($name, $name, $arg_param, $uri_param,
+                                  'asciidoc', $pwcallback, $stringfilemap);
+
+    return $synopsis;
+}
+
+sub print_asciidoc_synopsys {
+
+    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');
+
+    my $synopsis = "";
+
+    $synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n";
+
+    my $oldclass;
+    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, 'asciidoc', $pwcallback,
+                                   $stringfilemap);
+       $synopsis .= "\n" if $oldclass && $oldclass ne $class;
+
+       $synopsis .= "$str\n\n";
+       $oldclass = $class;
+    }
+
+    $synopsis .= "\n";
+
+    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);
+    my $str = $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback, $stringfilemap);
     $str =~ s/^USAGE://;
     $str =~ s/\n/\n /g;
     $synopsis .= $str;
@@ -135,6 +183,7 @@ sub print_pod_manpage {
     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 = "";
     
@@ -145,7 +194,8 @@ sub print_pod_manpage {
     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);
+                                   $uri_param, $style, $pwcallback,
+                                   $stringfilemap);
        $str =~ s/^USAGE: //;
 
        $synopsis .= "\n" if $oldclass && $oldclass ne $class;
@@ -166,13 +216,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 +238,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 +246,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,7 +389,7 @@ 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__
 }
 
@@ -389,8 +441,29 @@ sub generate_pod_manpage {
     }
 }
 
+sub generate_asciidoc_synopsys {
+    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();
+    }
+}
+
 my $handle_cmd  = sub {
-    my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_;
+    my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc, $stringfilemap) = @_;
 
     $cmddef = $def;
     $exename = $cmdname;
@@ -424,13 +497,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, $podfn, $preparefunc, $stringfilemap) = @_;
 
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def};
     die "no class specified" if !$class;
@@ -438,7 +511,7 @@ 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') {
@@ -457,7 +530,7 @@ my $handle_simple_cmd = sub {
 
     &$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;
 };
@@ -469,7 +542,7 @@ sub run_cli {
     
     die "password callback is no longer supported" if $pwcallback;
 
-    run_cli_handler($class, podfn => $podfn, preparefunc => $preparefunc);
+    run_cli_handler($class, podfn => $podfn, prepare => $preparefunc);
 }
 
 sub run_cli_handler {
@@ -481,14 +554,17 @@ sub run_cli_handler {
 
     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'; # used by lxc hooks
        die "unknown parameter '$key'";
     }
 
     my $podfn = $params{podfn};
-    my $preparefunc = $params{preparefunc};
+    my $preparefunc = $params{prepare};
+    my $no_init = $params{no_init};
 
     my $pwcallback = $class->can('read_password');
+    my $stringfilemap = $class->can('string_param_file_mapping');
 
     $exename = &$get_exe_name($class);
 
@@ -497,10 +573,10 @@ sub run_cli_handler {
     if ($class !~ m/^PVE::Service::/) {
        die "please run as root\n" if $> != 0;
 
-       PVE::INotify::inotify_init();
+       PVE::INotify::inotify_init() if !$no_init;
 
        my $rpcenv = PVE::RPCEnvironment->init('cli');
-       $rpcenv->init_request();
+       $rpcenv->init_request() if !$no_init;
        $rpcenv->set_language($ENV{LANG});
        $rpcenv->set_user('root@pam');
     }
@@ -509,11 +585,11 @@ sub run_cli_handler {
     my $def = ${"${class}::cmddef"};
 
     if (ref($def) eq 'ARRAY') {
-       &$handle_simple_cmd($def, \@ARGV, $pwcallback, $podfn, $preparefunc);
+       &$handle_simple_cmd($def, \@ARGV, $pwcallback, $podfn, $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, $podfn, $preparefunc, $stringfilemap);
     }
 
     exit 0;