[pve-common.git] / src / PVE / CLIHandler.pm

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 base qw(PVE::RESTHandler);

my $cmddef;
my $exename;
my $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;
    }
    return $cmd;
};

my $complete_command_names = sub {
    my $res = [];

    return if ref($cmddef) ne 'HASH';

    foreach my $cmd (keys %$cmddef) {
	next if $cmd eq 'help';
	push @$res, $cmd;
    }

    return $res;
};

__PACKAGE__->register_method ({
    name => 'help', 
    path => 'help',
    method => 'GET',
    description => "Get help about specified command.",
    parameters => {
    	additionalProperties => 0,
	properties => {
	    cmd => {
		description => "Command name",
		type => 'string',
		optional => 1,
		completion => $complete_command_names,
	    },
	    verbose => {
		description => "Verbose output format.",
		type => 'boolean',
		optional => 1,
	    },
	},
    },
    returns => { type => 'null' },
    
    code => sub {
	my ($param) = @_;

	die "not initialized" if !($cmddef && $exename && $cli_handler_class);

	my $cmd = $param->{cmd};

	my $verbose = defined($cmd) && $cmd; 
	$verbose = $param->{verbose} if defined($param->{verbose});

	if (!$cmd) {
	    if ($verbose) {
		print_usage_verbose();
	    } 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 = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
				    $verbose ? 'full' : 'short', $pwcallback);
	if ($verbose) {
	    print "$str\n";
	} else {
	    print "USAGE: $str\n";
	}

	return undef;

    }});

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 $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);
}

sub print_pod_manpage {
    my ($podfn) = @_;

    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 $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 .= "\n";

    my $parser = PVE::PodParser->new();
    $parser->{include}->{synopsis} = $synopsis;
    $parser->parse_from_file($podfn);
}

sub print_usage_verbose {

    die "not initialized" if !($cmddef && $exename && $cli_handler_class);

    my $pwcallback = $cli_handler_class->can('read_password');

    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";
    }
}

sub sorted_commands {   
    return sort { ($cmddef->{$a}->[0] cmp $cmddef->{$b}->[0]) || ($a cmp $b)} keys %$cmddef;
}

sub print_usage_short {
    my ($fd, $msg) = @_;

    die "not initialized" if !($cmddef && $exename && $cli_handler_class);

    my $pwcallback = $cli_handler_class->can('read_password');

    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;
    }
}

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;

    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 -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_pod_manpage {
    my ($class, $podfn) = @_;

    $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);
    } else {
	$cmddef = $def;

	$cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];

	print_pod_manpage($podfn);
    }
}

my $handle_cmd  = sub {
    my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_;

    $cmddef = $def;
    $exename = $cmdname;

    $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];

    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') {
	&$print_bash_completion($cmddef, 0, @$args);
	return;
    }

    &$preparefunc() if $preparefunc;

    $cmd = &$expand_command_name($cmddef, $cmd);

    my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef->{$cmd} || []};

    if (!$class) {
	print_usage_short (\*STDERR, "unknown command '$cmd'");
	exit (-1);
    }

    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 ($class, $name, $arg_param, $uri_param, $outsub) = @{$def};
    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);
	    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);
	    return;
	}
    }

    &$preparefunc() if $preparefunc;

    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback);

    &$outsub($res) if $outsub;
};

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) = @_;

    $cli_handler_class = $class;

    $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';

    foreach my $key (keys %params) {
	next if $key eq 'podfn';
	next if $key eq 'preparefunc';
	die "unknown parameter '$key'";
    }

    my $podfn = $params{podfn};
    my $preparefunc = $params{preparefunc};

    my $pwcallback = $class->can('read_password');

    $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);
    } else {
	$cmddef = $def;
	my $cmd = shift @ARGV;
	&$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc);
    }

    exit 0;
}

1;
Commit	Line	Data
e143e9d8 DM	1	package PVE::CLIHandler;
	2
	3	use strict;
	4	use warnings;
d8053c08	5	use Data::Dumper;
e143e9d8	6
93ddd7bc	7	use PVE::SafeSyslog;
e143e9d8 DM	8	use PVE::Exception qw(raise raise_param_exc);
	9	use PVE::RESTHandler;
	10	use PVE::PodParser;
	11
	12	use base qw(PVE::RESTHandler);
	13
	14	my $cmddef;
	15	my $exename;
891b798d	16	my $cli_handler_class;
e143e9d8 DM	17
	18	my $expand_command_name = sub {
	19	my ($def, $cmd) = @_;
	20
	21	if (!$def->{$cmd}) {
	22	my $expanded;
	23	for my $k (keys(%$def)) {
	24	if ($k =~ m/^$cmd/) {
	25	if ($expanded) {
	26	$expanded = undef; # more than one match
	27	last;
	28	} else {
	29	$expanded = $k;
	30	}
	31	}
	32	}
	33	$cmd = $expanded if $expanded;
	34	}
	35	return $cmd;
	36	};
	37
edf3d572 DM	38	my $complete_command_names = sub {
	39	my $res = [];
	40
	41	return if ref($cmddef) ne 'HASH';
	42
	43	foreach my $cmd (keys %$cmddef) {
	44	next if $cmd eq 'help';
	45	push @$res, $cmd;
	46	}
	47
	48	return $res;
	49	};
	50
e143e9d8 DM	51	__PACKAGE__->register_method ({
	52	name => 'help',
	53	path => 'help',
	54	method => 'GET',
	55	description => "Get help about specified command.",
	56	parameters => {
	57	additionalProperties => 0,
	58	properties => {
	59	cmd => {
	60	description => "Command name",
	61	type => 'string',
	62	optional => 1,
edf3d572	63	completion => $complete_command_names,
e143e9d8 DM	64	},
	65	verbose => {
	66	description => "Verbose output format.",
	67	type => 'boolean',
	68	optional => 1,
	69	},
	70	},
	71	},
	72	returns => { type => 'null' },
	73
	74	code => sub {
	75	my ($param) = @_;
	76
891b798d	77	die "not initialized" if !($cmddef && $exename && $cli_handler_class);
e143e9d8 DM	78
	79	my $cmd = $param->{cmd};
	80
	81	my $verbose = defined($cmd) && $cmd;
	82	$verbose = $param->{verbose} if defined($param->{verbose});
	83
	84	if (!$cmd) {
	85	if ($verbose) {
	86	print_usage_verbose();
	87	} else {
	88	print_usage_short(\*STDOUT);
	89	}
	90	return undef;
	91	}
	92
	93	$cmd = &$expand_command_name($cmddef, $cmd);
	94
	95	my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd} \|\| []};
	96
	97	raise_param_exc({ cmd => "no such command '$cmd'"}) if !$class;
	98
891b798d	99	my $pwcallback = $cli_handler_class->can('read_password');
e143e9d8	100
891b798d DM	101	my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
891b798d DM	102	$verbose ? 'full' : 'short', $pwcallback);
e143e9d8 DM	103	if ($verbose) {
	104	print "$str\n";
	105	} else {
	106	print "USAGE: $str\n";
	107	}
	108
	109	return undef;
	110
	111	}});
	112
7fe1f565 DM	113	sub print_simple_pod_manpage {
	114	my ($podfn, $class, $name, $arg_param, $uri_param) = @_;
	115
2fff84d9 DM	116	die "not initialized" if !$cli_handler_class;
2fff84d9 DM	117
891b798d DM	118	my $pwcallback = $cli_handler_class->can('read_password');
891b798d DM	119
7fe1f565	120	my $synopsis = " $name help\n\n";
891b798d	121	my $str = $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback);
7fe1f565 DM	122	$str =~ s/^USAGE://;
	123	$str =~ s/\n/\n /g;
	124	$synopsis .= $str;
	125
	126	my $parser = PVE::PodParser->new();
	127	$parser->{include}->{synopsis} = $synopsis;
	128	$parser->parse_from_file($podfn);
	129	}
	130
e143e9d8 DM	131	sub print_pod_manpage {
	132	my ($podfn) = @_;
	133
891b798d	134	die "not initialized" if !($cmddef && $exename && $cli_handler_class);
e143e9d8 DM	135	die "no pod file specified" if !$podfn;
e143e9d8 DM	136
891b798d DM	137	my $pwcallback = $cli_handler_class->can('read_password');
891b798d DM	138
e143e9d8 DM	139	my $synopsis = "";
	140
	141	$synopsis .= " $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
	142
	143	my $style = 'full'; # or should we use 'short'?
	144	my $oldclass;
	145	foreach my $cmd (sorted_commands()) {
	146	my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
891b798d DM	147	my $str = $class->usage_str($name, "$exename $cmd", $arg_param,
891b798d DM	148	$uri_param, $style, $pwcallback);
e143e9d8 DM	149	$str =~ s/^USAGE: //;
	150
	151	$synopsis .= "\n" if $oldclass && $oldclass ne $class;
	152	$str =~ s/\n/\n /g;
	153	$synopsis .= " $str\n\n";
	154	$oldclass = $class;
	155	}
	156
	157	$synopsis .= "\n";
	158
	159	my $parser = PVE::PodParser->new();
	160	$parser->{include}->{synopsis} = $synopsis;
	161	$parser->parse_from_file($podfn);
	162	}
	163
	164	sub print_usage_verbose {
	165
891b798d DM	166	die "not initialized" if !($cmddef && $exename && $cli_handler_class);
	167
	168	my $pwcallback = $cli_handler_class->can('read_password');
e143e9d8 DM	169
	170	print "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
	171
	172	foreach my $cmd (sort keys %$cmddef) {
	173	my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
891b798d DM	174	my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
891b798d DM	175	'full', $pwcallback);
e143e9d8 DM	176	print "$str\n\n";
	177	}
	178	}
	179
	180	sub sorted_commands {
	181	return sort { ($cmddef->{$a}->[0] cmp $cmddef->{$b}->[0]) \|\| ($a cmp $b)} keys %$cmddef;
	182	}
	183
	184	sub print_usage_short {
	185	my ($fd, $msg) = @_;
	186
891b798d DM	187	die "not initialized" if !($cmddef && $exename && $cli_handler_class);
	188
	189	my $pwcallback = $cli_handler_class->can('read_password');
e143e9d8 DM	190
	191	print $fd "ERROR: $msg\n" if $msg;
	192	print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n";
	193
	194	my $oldclass;
	195	foreach my $cmd (sorted_commands()) {
	196	my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
891b798d	197	my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, 'short', $pwcallback);
e143e9d8 DM	198	print $fd "\n" if $oldclass && $oldclass ne $class;
	199	print $fd " $str";
	200	$oldclass = $class;
	201	}
	202	}
	203
d8053c08 DM	204	my $print_bash_completion = sub {
	205	my ($cmddef, $simple_cmd, $bash_command, $cur, $prev) = @_;
	206
	207	my $debug = 0;
	208
	209	return if !(defined($cur) && defined($prev) && defined($bash_command));
	210	return if !defined($ENV{COMP_LINE});
	211	return if !defined($ENV{COMP_POINT});
	212
	213	my $cmdline = substr($ENV{COMP_LINE}, 0, $ENV{COMP_POINT});
	214	print STDERR "\nCMDLINE: $ENV{COMP_LINE}\n" if $debug;
	215
58d9e664 DM	216	my $args = PVE::Tools::split_args($cmdline);
58d9e664 DM	217	my $pos = scalar(@$args) - 2;
d8053c08 DM	218	$pos += 1 if $cmdline =~ m/\s+$/;
	219
	220	print STDERR "CMDLINE:$pos:$cmdline\n" if $debug;
	221
	222	return if $pos < 0;
	223
	224	my $print_result = sub {
	225	foreach my $p (@_) {
	226	print "$p\n" if $p =~ m/^$cur/;
	227	}
	228	};
	229
	230	my $cmd;
	231	if ($simple_cmd) {
	232	$cmd = $simple_cmd;
	233	} else {
	234	if ($pos == 0) {
	235	&$print_result(keys %$cmddef);
	236	return;
	237	}
58d9e664	238	$cmd = $args->[1];
d8053c08 DM	239	}
	240
	241	my $def = $cmddef->{$cmd};
	242	return if !$def;
	243
	244	print STDERR "CMDLINE1:$pos:$cmdline\n" if $debug;
	245
	246	my $skip_param = {};
	247
	248	my ($class, $name, $arg_param, $uri_param) = @$def;
	249	$arg_param //= [];
	250	$uri_param //= {};
	251
d90a2fd0 DM	252	$arg_param = [ $arg_param ] if !ref($arg_param);
d90a2fd0 DM	253
d8053c08 DM	254	map { $skip_param->{$_} = 1; } @$arg_param;
	255	map { $skip_param->{$_} = 1; } keys %$uri_param;
	256
	257	my $fpcount = scalar(@$arg_param);
	258
	259	my $info = $class->map_method_by_name($name);
	260
	261	my $schema = $info->{parameters};
	262	my $prop = $schema->{properties};
	263
	264	my $print_parameter_completion = sub {
	265	my ($pname) = @_;
	266	my $d = $prop->{$pname};
	267	if ($d->{completion}) {
	268	my $vt = ref($d->{completion});
	269	if ($vt eq 'CODE') {
58d9e664	270	my $res = $d->{completion}->($cmd, $pname, $cur, $args);
d8053c08 DM	271	&$print_result(@$res);
	272	}
	273	} elsif ($d->{type} eq 'boolean') {
	274	&$print_result('0', '1');
	275	} elsif ($d->{enum}) {
	276	&$print_result(@{$d->{enum}});
	277	}
	278	};
	279
	280	# positional arguments
	281	$pos += 1 if $simple_cmd;
	282	if ($fpcount && $pos <= $fpcount) {
	283	my $pname = $arg_param->[$pos -1];
	284	&$print_parameter_completion($pname);
	285	return;
	286	}
	287
	288	my @option_list = ();
	289	foreach my $key (keys %$prop) {
	290	next if $skip_param->{$key};
	291	push @option_list, "--$key";
	292	}
	293
	294	if ($cur =~ m/^-/) {
	295	&$print_result(@option_list);
	296	return;
	297	}
	298
	299	if ($prev =~ m/^--?(.+)$/ && $prop->{$1}) {
	300	my $pname = $1;
	301	&$print_parameter_completion($pname);
	302	return;
	303	}
	304
	305	&$print_result(@option_list);
	306	};
	307
1f130ba6 DM	308	sub verify_api {
	309	my ($class) = @_;
	310
	311	# simply verify all registered methods
	312	PVE::RESTHandler::validate_method_schemas();
	313	}
	314
8f3712f8 DM	315	my $get_exe_name = sub {
	316	my ($class) = @_;
	317
	318	my $name = $class;
	319	$name =~ s/^.*:://;
	320	$name =~ s/_/-/g;
	321
	322	return $name;
	323	};
	324
c45707a0 DM	325	sub generate_bash_completions {
	326	my ($class) = @_;
	327
	328	# generate bash completion config
	329
8f3712f8	330	$exename = &$get_exe_name($class);
c45707a0 DM	331
	332	print <<__EOD__;
	333	# $exename bash completion
	334
	335	# see http://tiswww.case.edu/php/chet/bash/FAQ
	336	# and __ltrim_colon_completions() in /usr/share/bash-completion/bash_completion
	337	# this modifies global var, but I found no better way
	338	COMP_WORDBREAKS=\${COMP_WORDBREAKS//:}
	339
	340	complete -C '$exename bashcomplete' $exename
	341	__EOD__
	342	}
	343
7fe1f565	344	sub find_cli_class_source {
8f3712f8	345	my ($name) = @_;
7fe1f565 DM	346
	347	my $filename;
	348
8f3712f8 DM	349	$name =~ s/-/_/g;
	350
	351	my $cpath = "PVE/CLI/${name}.pm";
	352	my $spath = "PVE/Service/${name}.pm";
7fe1f565	353	foreach my $p (@INC) {
edf3d572 DM	354	foreach my $s (($cpath, $spath)) {
	355	my $testfn = "$p/$s";
	356	if (-f $testfn) {
	357	$filename = $testfn;
	358	last;
	359	}
7fe1f565	360	}
edf3d572	361	last if defined($filename);
7fe1f565 DM	362	}
	363
	364	return $filename;
	365	}
	366
1f130ba6 DM	367	sub generate_pod_manpage {
	368	my ($class, $podfn) = @_;
	369
891b798d DM	370	$cli_handler_class = $class;
891b798d DM	371
8f3712f8	372	$exename = &$get_exe_name($class);
1f130ba6	373
7fe1f565	374	$podfn = find_cli_class_source($exename) if !defined($podfn);
1f130ba6 DM	375
	376	die "unable to find source for class '$class'" if !$podfn;
	377
7fe1f565 DM	378	no strict 'refs';
	379	my $def = ${"${class}::cmddef"};
	380
bb958629	381	if (ref($def) eq 'ARRAY') {
7fe1f565 DM	382	print_simple_pod_manpage($podfn, @$def);
	383	} else {
	384	$cmddef = $def;
edf3d572 DM	385
	386	$cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
	387
7fe1f565 DM	388	print_pod_manpage($podfn);
7fe1f565 DM	389	}
1f130ba6 DM	390	}
1f130ba6 DM	391
891b798d	392	my $handle_cmd = sub {
8e3e9929	393	my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_;
e143e9d8 DM	394
	395	$cmddef = $def;
	396	$exename = $cmdname;
	397
	398	$cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
	399
	400	if (!$cmd) {
	401	print_usage_short (\*STDERR, "no command specified");
	402	exit (-1);
	403	} elsif ($cmd eq 'verifyapi') {
	404	PVE::RESTHandler::validate_method_schemas();
	405	return;
	406	} elsif ($cmd eq 'printmanpod') {
edf3d572	407	$podfn = find_cli_class_source($exename) if !defined($podfn);
e143e9d8 DM	408	print_pod_manpage($podfn);
e143e9d8 DM	409	return;
d8053c08 DM	410	} elsif ($cmd eq 'bashcomplete') {
	411	&$print_bash_completion($cmddef, 0, @$args);
	412	return;
e143e9d8 DM	413	}
e143e9d8 DM	414
8e3e9929 WB	415	&$preparefunc() if $preparefunc;
8e3e9929 WB	416
e143e9d8 DM	417	$cmd = &$expand_command_name($cmddef, $cmd);
	418
	419	my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef->{$cmd} \|\| []};
	420
	421	if (!$class) {
	422	print_usage_short (\*STDERR, "unknown command '$cmd'");
	423	exit (-1);
	424	}
	425
	426	my $prefix = "$exename $cmd";
	427	my $res = $class->cli_handler($prefix, $name, \@ARGV, $arg_param, $uri_param, $pwcallback);
2026f4b5 DM	428
2026f4b5 DM	429	&$outsub($res) if $outsub;
891b798d	430	};
2026f4b5	431
891b798d	432	my $handle_simple_cmd = sub {
7fe1f565	433	my ($def, $args, $pwcallback, $podfn, $preparefunc) = @_;
2026f4b5 DM	434
	435	my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def};
	436	die "no class specified" if !$class;
	437
d8053c08	438	if (scalar(@$args) >= 1) {
2026f4b5 DM	439	if ($args->[0] eq 'help') {
2026f4b5 DM	440	my $str = "USAGE: $name help\n";
891b798d	441	$str .= $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback);
2026f4b5 DM	442	print STDERR "$str\n\n";
2026f4b5 DM	443	return;
d8053c08 DM	444	} elsif ($args->[0] eq 'bashcomplete') {
	445	shift @$args;
	446	&$print_bash_completion({ $name => $def }, $name, @$args);
	447	return;
2026f4b5 DM	448	} elsif ($args->[0] eq 'verifyapi') {
	449	PVE::RESTHandler::validate_method_schemas();
	450	return;
	451	} elsif ($args->[0] eq 'printmanpod') {
7fe1f565 DM	452	$podfn = find_cli_class_source($name) if !defined($podfn);
7fe1f565 DM	453	print_simple_pod_manpage($podfn, @$def);
2026f4b5 DM	454	return;
2026f4b5 DM	455	}
e143e9d8	456	}
2026f4b5	457
7fe1f565 DM	458	&$preparefunc() if $preparefunc;
7fe1f565 DM	459
2026f4b5 DM	460	my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback);
	461
	462	&$outsub($res) if $outsub;
891b798d DM	463	};
	464
	465	sub run_cli {
	466	my ($class, $pwcallback, $podfn, $preparefunc) = @_;
	467
	468	# Note: "depreciated function run_cli - use run_cli_handler instead";
	469
	470	die "password callback is no longer supported" if $pwcallback;
	471
	472	run_cli_handler($class, podfn => $podfn, preparefunc => $preparefunc);
	473	}
	474
	475	sub run_cli_handler {
	476	my ($class, %params) = @_;
	477
	478	$cli_handler_class = $class;
	479
	480	$ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
	481
aa9b9af5 DM	482	foreach my $key (keys %params) {
	483	next if $key eq 'podfn';
	484	next if $key eq 'preparefunc';
	485	die "unknown parameter '$key'";
	486	}
	487
891b798d DM	488	my $podfn = $params{podfn};
	489	my $preparefunc = $params{preparefunc};
	490
	491	my $pwcallback = $class->can('read_password');
	492
	493	$exename = &$get_exe_name($class);
	494
	495	initlog($exename);
	496
	497	if ($class !~ m/^PVE::Service::/) {
	498	die "please run as root\n" if $> != 0;
	499
	500	PVE::INotify::inotify_init();
	501
	502	my $rpcenv = PVE::RPCEnvironment->init('cli');
	503	$rpcenv->init_request();
	504	$rpcenv->set_language($ENV{LANG});
	505	$rpcenv->set_user('root@pam');
	506	}
	507
	508	no strict 'refs';
	509	my $def = ${"${class}::cmddef"};
	510
	511	if (ref($def) eq 'ARRAY') {
	512	&$handle_simple_cmd($def, \@ARGV, $pwcallback, $podfn, $preparefunc);
	513	} else {
	514	$cmddef = $def;
	515	my $cmd = shift @ARGV;
	516	&$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc);
	517	}
	518
	519	exit 0;
e143e9d8 DM	520	}
	521
	522	1;