]> git.proxmox.com Git - pve-common.git/blobdiff - src/PVE/CLIHandler.pm
handle_simple_cmd: code cleanups
[pve-common.git] / src / PVE / CLIHandler.pm
index 2e7b14dc0e26479b05c498626da7203c77bba20d..8bab06b391f7aed139ded7e9826bea12919d69a7 100644 (file)
@@ -2,7 +2,9 @@ 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;
@@ -91,6 +93,20 @@ __PACKAGE__->register_method ({
 
     }});
 
+sub print_simple_pod_manpage {
+    my ($podfn, $class, $name, $arg_param, $uri_param) = @_;
+
+    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);
+}
+
 sub print_pod_manpage {
     my ($podfn) = @_;
 
@@ -157,6 +173,207 @@ sub print_usage_short {
     }
 }
 
+my $print_bash_completion = sub {
+    my ($cmddef, $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;
+
+    # fixme: shell quoting??
+    my @args = split(/\s+/, $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 //= {};
+
+    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);
+               &$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();
+}
+
+sub generate_bash_completions {
+    my ($class) = @_;
+
+    # generate bash completion config
+
+    $exename = $class;
+    $exename =~ s/^.*:://;
+
+    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 ($exename) = @_;
+
+    my $filename;
+
+    my $cpath = "PVE/CLI/${exename}.pm";
+    foreach my $p (@INC) {
+       my $testfn = "$p/$cpath";
+       if (-f $testfn) {
+           $filename = $testfn;
+           last;
+       }
+    }
+
+    return $filename;
+}
+
+sub generate_pod_manpage {
+    my ($class, $podfn) = @_;
+
+    $exename = $class;
+    $exename =~ s/^.*:://;
+
+    $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;
+       print_pod_manpage($podfn);
+    }
+}
+
+sub run {
+    my ($class, $pwcallback, $podfn, $preparefunc) = @_;
+
+    $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
+
+    $exename = $class;
+    $exename =~ s/^.*:://;
+
+    initlog($exename);
+
+    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);
+    } else {
+       $cmddef = $def;
+       my $cmd = shift @ARGV;
+       handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc);
+    }
+
+    exit 0;
+}
+
 sub handle_cmd {
     my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_;
 
@@ -174,6 +391,9 @@ sub handle_cmd {
     } elsif ($cmd eq 'printmanpod') {
        print_pod_manpage($podfn);
        return;
+    } elsif ($cmd eq 'bashcomplete') {
+       &$print_bash_completion($cmddef, 0, @$args);
+       return;
     }
 
     &$preparefunc() if $preparefunc;
@@ -194,34 +414,33 @@ sub handle_cmd {
 }
 
 sub handle_simple_cmd {
-    my ($def, $args, $pwcallback, $podfn) = @_;
+    my ($def, $args, $pwcallback, $podfn, $preparefunc) = @_;
 
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def};
     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');
            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') {
-           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;