reword print_text_table and print_api_list documentation
[pve-common.git] / src / PVE / CLIHandler.pm
index b32c288..1b95d9a 100644 (file)
@@ -2,66 +2,200 @@ 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);
 
+# $cmddef defines which (sub)commands are available in a specific CLI class.
+# A real command is always an array consisting of its class, name, array of
+# position fixed (required) parameters and hash of predefined parameters when
+# mapping a CLI command t o an API call. Optionally an output method can be
+# passed at the end, e.g., for formatting or transformation purpose.
+#
+# [class, name, fixed_params, API_pre-set params, output_sub ]
+#
+# In case of so called 'simple commands', the $cmddef can be also just an
+# array.
+#
+# Examples:
+# $cmddef = {
+#     command => [ 'PVE::API2::Class', 'command', [ 'arg1', 'arg2' ], { node => $nodename } ],
+#     do => {
+#         this => [ 'PVE::API2::OtherClass', 'method', [ 'arg1' ], undef, sub {
+#             my ($res) = @_;
+#             print "$res\n";
+#         }],
+#         that => [ 'PVE::API2::OtherClass', 'subroutine' [] ],
+#     },
+#     dothat => { alias => 'do that' },
+# }
 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 $abort = sub {
+    my ($reason, $cmd) = @_;
+    print_usage_short (\*STDERR, $reason, $cmd);
+    exit (-1);
+};
+
 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;
-               }
+    return $cmd if exists $def->{$cmd}; # command is already complete
+
+    my $is_alias = sub { ref($_[0]) eq 'HASH' && exists($_[0]->{alias}) };
+    my @expanded = grep { /^\Q$cmd\E/ && !$is_alias->($def->{$_}) } keys %$def;
+
+    return $expanded[0] if scalar(@expanded) == 1; # enforce exact match
+
+    return undef;
+};
+
+my $get_commands = sub {
+    my $def = shift // die "no command definition passed!";
+    return [ grep { !(ref($def->{$_}) eq 'HASH' && defined($def->{$_}->{alias})) } sort keys %$def ];
+};
+
+my $complete_command_names = sub { $get_commands->($cmddef) };
+
+# traverses the command definition using the $argv array, resolving one level
+# of aliases.
+# Returns the matching (sub) command and its definition, and argument array for
+# this (sub) command and a hash where we marked which (sub) commands got
+# expanded (e.g. st => status) while traversing
+sub resolve_cmd {
+    my ($argv, $is_alias) = @_;
+
+    my ($def, $cmd) = ($cmddef, $argv);
+    my $cmdstr = $exename;
+
+    if (ref($argv) eq 'ARRAY') {
+       my $expanded_last_arg;
+       my $last_arg_id = scalar(@$argv) - 1;
+
+       for my $i (0..$last_arg_id) {
+           $cmd = $expand_command_name->($def, $argv->[$i]);
+           if (defined($cmd)) {
+               # If the argument was expanded (or was already complete) and it
+               # is the final argument, tell our caller about it:
+               $expanded_last_arg = $cmd if $i == $last_arg_id;
+           } else {
+               # Otherwise continue with the unexpanded version of it.
+               $cmd = $argv->[$i]; 
+           }
+           $cmdstr .= " $cmd";
+           $def = $def->{$cmd};
+           last if !defined($def);
+
+           if (ref($def) eq 'ARRAY') {
+               # could expand to a real command, rest of $argv are its arguments
+               my $cmd_args = [ @$argv[$i+1..$last_arg_id] ];
+               return ($cmd, $def, $cmd_args, $expanded_last_arg, $cmdstr);
+           }
+
+           if (defined($def->{alias})) {
+               die "alias loop detected for '$cmd'" if $is_alias; # avoids cycles
+               # replace aliased (sub)command with the expanded aliased command
+               splice @$argv, $i, 1, split(/ +/, $def->{alias});
+               return resolve_cmd($argv, 1);
            }
        }
-       $cmd = $expanded if $expanded;
+       # got either a special command (bashcomplete, verifyapi) or an unknown
+       # cmd, just return first entry as cmd and the rest of $argv as cmd_arg
+       my $cmd_args = [ @$argv[1..$last_arg_id] ];
+       return ($argv->[0], $def, $cmd_args, $expanded_last_arg, $cmdstr);
     }
-    return $cmd;
-};
+    return ($cmd, $def, undef, undef, $cmdstr);
+}
 
-my $complete_command_names = sub {
-    my $res = [];
+sub generate_usage_str {
+    my ($format, $cmd, $indent, $separator, $sortfunc) = @_;
 
-    return if ref($cmddef) ne 'HASH';
+    $assert_initialized->();
+    die 'format required' if !$format;
 
-    foreach my $cmd (keys %$cmddef) {
-       next if $cmd eq 'help';
-       push @$res, $cmd;
-    }
+    $sortfunc //= sub { sort keys %{$_[0]} };
+    $separator //= '';
+    $indent //= '';
 
-    return $res;
-};
+    my $read_password_func = $cli_handler_class->can('read_password');
+    my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
+       $cli_handler_class->can('string_param_file_mapping');
+
+    my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd($cmd);
+    $abort->("unknown command '$cmdstr'") if !defined($def) && ref($cmd) eq 'ARRAY';
+
+    my $generate;
+    $generate = sub {
+       my ($indent, $separator, $def, $prefix) = @_;
+
+       my $str = '';
+       if (ref($def) eq 'HASH') {
+           my $oldclass = undef;
+           foreach my $cmd (&$sortfunc($def)) {
+
+               if (ref($def->{$cmd}) eq 'ARRAY') {
+                   my ($class, $name, $arg_param, $fixed_param) = @{$def->{$cmd}};
+
+                   $str .= $separator if $oldclass && $oldclass ne $class;
+                   $str .= $indent;
+                   $str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
+                                             $fixed_param, $format,
+                                             $read_password_func, $param_mapping_func);
+                   $oldclass = $class;
+
+               } elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
+
+                   $str .= "*$prefix $cmd*\n\nAn alias for '$exename $def->{$cmd}->{alias}'.\n\n";
+
+               } else {
+                   next if $def->{$cmd}->{alias};
+
+                   my $substr = $generate->($indent, $separator, $def->{$cmd}, "$prefix $cmd");
+                   if ($substr) {
+                       $substr .= $separator if $substr !~ /\Q$separator\E{2}/;
+                       $str .= $substr;
+                   }
+               }
+
+           }
+       } else {
+           my ($class, $name, $arg_param, $fixed_param) = @$def;
+           $abort->("unknown command '$cmd'") if !$class;
+
+           $str .= $indent;
+           $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format,
+                                     $read_password_func, $param_mapping_func);
+       }
+       return $str;
+    };
+
+    return $generate->($indent, $separator, $def, $cmdstr);
+}
 
 __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,
+           'extra-args' => PVE::JSONSchema::get_standard_option('extra-args', {
+               description => 'Shows help for a specific command',
                completion => $complete_command_names,
-           },
+           }),
            verbose => {
                description => "Verbose output format.",
                type => 'boolean',
@@ -70,36 +204,34 @@ __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};
+       my $cmd = $param->{'extra-args'};
 
-       my $verbose = defined($cmd) && $cmd; 
+       my $verbose = defined($cmd) && $cmd;
        $verbose = $param->{verbose} if defined($param->{verbose});
 
        if (!$cmd) {
            if ($verbose) {
                print_usage_verbose();
-           } else {            
+           } else {
                print_usage_short(\*STDOUT);
            }
            return undef;
        }
 
-       $cmd = &$expand_command_name($cmddef, $cmd);
-
-       my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd} || []};
-
-       raise_param_exc({ cmd => "no such command '$cmd'"}) if !$class;
-
-       my $pwcallback = $cli_handler_class->can('read_password');
+       my $str;
+       if ($verbose) {
+           $str = generate_usage_str('full', $cmd, '');
+       } else {
+           $str = generate_usage_str('short', $cmd, ' ' x 7);
+       }
+       $str =~ s/^\s+//;
 
-       my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
-                                   $verbose ? 'full' : 'short', $pwcallback);
        if ($verbose) {
            print "$str\n";
        } else {
@@ -110,98 +242,66 @@ __PACKAGE__->register_method ({
 
     }});
 
-sub print_simple_pod_manpage {
-    my ($podfn, $class, $name, $arg_param, $uri_param) = @_;
+sub print_simple_asciidoc_synopsis {
+    $assert_initialized->();
 
-    die "not initialized" if !($cmddef && $exename && $cli_handler_class);
-    my $pwcallback = $cli_handler_class->can('read_password');
+    my $synopsis = "*${exename}* `help`\n\n";
+    $synopsis .= generate_usage_str('asciidoc');
 
-    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);
+    return $synopsis;
 }
 
-sub print_pod_manpage {
-    my ($podfn) = @_;
+sub print_asciidoc_synopsis {
+    $assert_initialized->();
 
-    die "not initialized" if !($cmddef && $exename && $cli_handler_class);
-    die "no pod file specified" if !$podfn;
+    my $synopsis = "";
 
-    my $pwcallback = $cli_handler_class->can('read_password');
+    $synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n";
 
-    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);
-       $str =~ s/^USAGE: //;
-
-       $synopsis .= "\n" if $oldclass && $oldclass ne $class;
-       $str =~ s/\n/\n /g;
-       $synopsis .= " $str\n\n";
-       $oldclass = $class;
-    }
+    $synopsis .= generate_usage_str('asciidoc');
 
     $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 && $cli_handler_class);
-
-    my $pwcallback = $cli_handler_class->can('read_password');
+    $assert_initialized->();
 
     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);
-       print "$str\n\n";
-    }
-}
+    my $str = generate_usage_str('full');
 
-sub sorted_commands {   
-    return sort { ($cmddef->{$a}->[0] cmp $cmddef->{$b}->[0]) || ($a cmp $b)} keys %$cmddef;
+    print "$str\n";
 }
 
 sub print_usage_short {
-    my ($fd, $msg) = @_;
-
-    die "not initialized" if !($cmddef && $exename && $cli_handler_class);
+    my ($fd, $msg, $cmd) = @_;
 
-    my $pwcallback = $cli_handler_class->can('read_password');
+    $assert_initialized->();
 
     print $fd "ERROR: $msg\n" if $msg;
     print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n";
 
-    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);
-       print $fd "\n" if $oldclass && $oldclass ne $class;
-       print $fd "       $str";
-       $oldclass = $class;
-    }
+    print {$fd} generate_usage_str('short', $cmd, ' ' x 7, "\n", sub {
+       my ($h) = @_;
+       return sort {
+           if (ref($h->{$a}) eq 'ARRAY' && ref($h->{$b}) eq 'ARRAY') {
+               # $a and $b are both real commands order them by their class
+               return $h->{$a}->[0] cmp $h->{$b}->[0] || $a cmp $b;
+           } elsif (ref($h->{$a}) eq 'ARRAY' xor ref($h->{$b}) eq 'ARRAY') {
+               # real command and subcommand mixed, put sub commands first
+               return ref($h->{$b}) eq 'ARRAY' ? -1 : 1;
+           } else {
+               # both are either from the same class or subcommands
+               return $a cmp $b;
+           }
+       } keys %$h;
+    });
 }
 
 my $print_bash_completion = sub {
-    my ($cmddef, $simple_cmd, $bash_command, $cur, $prev) = @_;
+    my ($simple_cmd, $bash_command, $cur, $prev) = @_;
 
     my $debug = 0;
 
@@ -213,34 +313,33 @@ my $print_bash_completion = sub {
     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;
-
+    shift @$args; # no need for program name
     my $print_result = sub {
        foreach my $p (@_) {
-           print "$p\n" if $p =~ m/^$cur/;
+           print "$p\n" if $p =~ m/^\Q$cur\E/;
        }
     };
 
-    my $cmd;
-    if ($simple_cmd) {
-       $cmd = $simple_cmd;
-    } else {
-       if ($pos == 0) {
-           &$print_result(keys %$cmddef);
+    my ($cmd, $def) = ($simple_cmd, $cmddef);
+    if (!$simple_cmd) {
+       ($cmd, $def, $args, my $expanded) = resolve_cmd($args);
+
+       if (defined($expanded) && $prev ne $expanded) {
+           print "$expanded\n";
            return;
        }
-       $cmd = $args->[1];
-    }
 
-    my $def = $cmddef->{$cmd};
+       if (ref($def) eq 'HASH') {
+           &$print_result(@{$get_commands->($def)});
+           return;
+       }
+    }
     return if !$def;
 
-    print STDERR "CMDLINE1:$pos:$cmdline\n" if $debug;
+    my $pos = scalar(@$args) - 1;
+    $pos += 1 if $cmdline =~ m/\s+$/;
+    print STDERR "pos: $pos\n" if $debug;
+    return if $pos < 0;
 
     my $skip_param = {};
 
@@ -253,12 +352,9 @@ my $print_bash_completion = sub {
     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 $prop = $info->{parameters}->{properties};
 
     my $print_parameter_completion = sub {
        my ($pname) = @_;
@@ -277,9 +373,8 @@ my $print_bash_completion = sub {
     };
 
     # positional arguments
-    $pos += 1 if $simple_cmd;
-    if ($fpcount && $pos <= $fpcount) {
-       my $pname = $arg_param->[$pos -1];
+    if ($pos < scalar(@$arg_param)) {
+       my $pname = $arg_param->[$pos];
        &$print_parameter_completion($pname);
        return;
     }
@@ -304,6 +399,86 @@ my $print_bash_completion = sub {
     &$print_result(@option_list);
 };
 
+# prints a formatted table with a title row.
+# $formatopts is an array of hashes, with the following keys:
+# 'key' - key of $data element to print
+# 'title' - column title, defaults to 'key' - won't get cutoff
+# 'cutoff' - maximal (print) length of this column values, if set
+#            the last column will never be cutoff
+# 'default' - optional default value for the column
+# formatopts element order defines column order (left to right)
+sub print_text_table {
+    my ($formatopts, $data) = @_;
+    my ($formatstring, @keys, @titles, %cutoffs, %defaults, $last_col);
+
+    $last_col = $formatopts->[$#{$formatopts}];
+    foreach my $col ( @$formatopts ) {
+       my ($key, $title, $cutoff, $default) = @$col{ qw(key title cutoff default)};
+       $title //= $key;
+
+       push @keys, $key;
+       push @titles, $title;
+       $defaults{$key} = $default;
+
+       #calculate maximal print width and cutoff
+       my $titlelen = length($title);
+
+       my $longest = $titlelen;
+       foreach my $entry (@$data) {
+           my $len = length($entry->{$key}) // 0;
+           $longest = $len if $len > $longest;
+       }
+
+       $cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest;
+       $cutoffs{$key} = $cutoff;
+
+       my $printalign = $cutoff > $titlelen ? '-' : '';
+       if ($col == $last_col) {
+           $formatstring .= "%${printalign}${titlelen}s\n";
+       } else {
+           $formatstring .= "%${printalign}${cutoff}s ";
+       }
+    }
+
+    printf $formatstring, @titles;
+
+    foreach my $entry (sort { $a->{$keys[0]} cmp $b->{$keys[0]} } @$data){
+        printf $formatstring, map { substr(($entry->{$_} // $defaults{$_}), 0 , $cutoffs{$_}) } @keys;
+    }
+}
+
+sub print_entry {
+    my $entry = shift;
+    #TODO: handle objects/hashes as well
+    foreach my $item (sort keys %$entry) {
+       if (ref($entry->{$item}) eq 'ARRAY'){
+           printf "%s: [ %s ]\n", $item, join(", ", @{$entry->{$item}});
+       } else {
+           printf "%s: %s\n", $item, $entry->{$item};
+       }
+    }
+}
+
+# prints the result of an API GET call returning an array
+# and to have the results key of the API call defined.
+sub print_api_list {
+    my ($props_to_print, $data, $returninfo) = @_;
+    my $formatopts;
+    my $returnprops = $returninfo->{items}->{properties};
+    foreach my $prop ( @$props_to_print ) {
+       my $propinfo = $returnprops->{$prop};
+       my $colopts = {
+           key => $prop,
+           title => $propinfo->{title},
+           default => $propinfo->{default},
+           cutoff => $propinfo->{print_width} // $propinfo->{maxLength},
+       };
+       push @$formatopts, $colopts;
+    }
+
+    print_text_table($formatopts, $data);
+}
+
 sub verify_api {
     my ($class) = @_;
 
@@ -313,7 +488,7 @@ sub verify_api {
 
 my $get_exe_name = sub {
     my ($class) = @_;
-    
+
     my $name = $class;
     $name =~ s/^.*:://;
     $name =~ s/_/-/g;
@@ -336,141 +511,119 @@ 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"};
+    $cmddef = $def;
 
     if (ref($def) eq 'ARRAY') {
-       print_simple_pod_manpage($podfn, @$def);
+       print_simple_asciidoc_synopsis();
     } 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 ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
 
-    $cmddef = $def;
-    $exename = $cmdname;
+    $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
+
+    my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd($args);
 
-    $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
+    $abort->("no command specified") if !$cmd;
 
-    if (!$cmd) { 
-       print_usage_short (\*STDERR, "no command specified");
-       exit (-1);
-    } elsif ($cmd eq 'verifyapi') {
+    # call verifyapi before setup_environment(), don't execute any real code in
+    # this case
+    if ($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, @$cmd_args);
        return;
     }
 
+    # checked special commands, if def is still a hash we got an incomplete sub command
+    $abort->("incomplete command '$cmd_str'", $args) if ref($def) eq 'HASH';
+
     &$preparefunc() if $preparefunc;
 
-    $cmd = &$expand_command_name($cmddef, $cmd);
+    my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
+    $abort->("unknown command '$cmd_str'") if !$class;
 
-    my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef->{$cmd} || []};
+    my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
 
-    if (!$class) {
-       print_usage_short (\*STDERR, "unknown command '$cmd'");
-       exit (-1);
+    if (defined $outsub) {
+       my $returninfo = $class->map_method_by_name($name)->{returns};
+       $outsub->($res, $returninfo);
     }
-
-    my $prefix = "$exename $cmd";
-    my $res = $class->cli_handler($prefix, $name, \@ARGV, $arg_param, $uri_param, $pwcallback);
-
-    &$outsub($res) if $outsub;
 };
 
 my $handle_simple_cmd = sub {
-    my ($def, $args, $pwcallback, $podfn, $preparefunc) = @_;
+    my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
 
-    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 ($args->[0] eq 'help') {
            my $str = "USAGE: $name help\n";
-           $str .= $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback);
+           $str .= generate_usage_str('long');
            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;
        }
     }
 
     &$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, $read_password_func, $param_mapping_func);
 
-    &$outsub($res) if $outsub;
+    if (defined $outsub) {
+       my $returninfo = $class->map_method_by_name($name)->{returns};
+       $outsub->($res, $returninfo);
+    }
 };
 
-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, preparefunc => $preparefunc);
-}
-
 sub run_cli_handler {
     my ($class, %params) = @_;
 
@@ -478,35 +631,30 @@ sub run_cli_handler {
 
     $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
 
-    my $podfn = $params{podfn};
-    my $preparefunc = $params{preparefunc};
+    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 $read_password_func = $class->can('read_password');
+    my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
+       $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"};
+    $cmddef = ${"${class}::cmddef"};
 
-    if (ref($def) eq 'ARRAY') {
-       &$handle_simple_cmd($def, \@ARGV, $pwcallback, $podfn, $preparefunc);
+    if (ref($cmddef) eq 'ARRAY') {
+       &$handle_simple_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
     } else {
-       $cmddef = $def;
-       my $cmd = shift @ARGV;
-       &$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc);
+       &$handle_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
     }
 
     exit 0;