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;
- }
- }
- }
- $cmd = $expanded if $expanded;
+ my @expanded = grep { /^\Q$cmd\E/ } keys %$def;
+ return $expanded[0] if scalar(@expanded) == 1; # enforce exact match
}
return $cmd;
};
my $complete_command_names = sub {
- my $res = [];
+ return [ sort keys %$cmddef ];
+};
- return if ref($cmddef) ne 'HASH';
+sub generate_usage_str {
+ my ($format, $cmd, $indent, $separator, $sortfunc) = @_;
- foreach my $cmd (keys %$cmddef) {
- next if $cmd eq 'help';
- push @$res, $cmd;
- }
+ $assert_initialized->();
+ die 'format required' if !$format;
- return $res;
-};
+ $sortfunc //= sub { sort keys %{$_[0]} };
+ $separator //= '';
+ $indent //= '';
+
+ my $can_read_pass = $cli_handler_class->can('read_password');
+ my $can_str_param_fmap = $cli_handler_class->can('string_param_file_mapping');
+
+ my $def = $cmddef;
+ $def = $def->{$cmd} if $cmd && ref($def) eq 'HASH' && $def->{$cmd};
+
+ 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,
+ $can_read_pass, $can_str_param_fmap);
+ $oldclass = $class;
+ }
+
+ }
+ } 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,
+ $can_read_pass, $can_str_param_fmap);
+ }
+ return $str;
+ };
+
+ return $generate->($indent, $separator, $def, $exename);
+}
__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",
},
},
returns => { type => 'null' },
-
+
code => sub {
my ($param) = @_;
- die "not initialized" if !($cmddef && $exename && $cli_handler_class);
+ $assert_initialized->();
my $cmd = $param->{cmd};
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 $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
+ 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,
- $stringfilemap);
if ($verbose) {
print "$str\n";
} else {
}});
sub print_simple_asciidoc_synopsis {
- my ($class, $name, $arg_param, $uri_param) = @_;
+ $assert_initialized->();
- 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);
+ my $synopsis = "*${exename}* `help`\n\n";
+ $synopsis .= generate_usage_str('asciidoc');
return $synopsis;
}
sub print_asciidoc_synopsis {
-
- 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');
+ $assert_initialized->();
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 .= generate_usage_str('asciidoc');
$synopsis .= "\n";
}
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');
+ $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, $stringfilemap);
- 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 $pwcallback = $cli_handler_class->can('read_password');
- my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
+ $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, $stringfilemap);
- print $fd "\n" if $oldclass && $oldclass ne $class;
- print $fd " $str";
- $oldclass = $class;
- }
+ print {$fd} generate_usage_str('short', undef, ' ' 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;
+ } else {
+ # both are from the same class
+ 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;
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/;
}
};
- 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) {
+ if (!scalar(@$args)) {
+ &$print_result(keys %$def);
return;
}
- $cmd = $args->[1];
+ $cmd = $args->[0];
}
-
- my $def = $cmddef->{$cmd};
+ $def = $def->{$cmd};
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 = {};
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) = @_;
};
# positional arguments
- $pos += 1 if $simple_cmd;
- if ($fpcount && $pos <= $fpcount) {
- my $pname = $arg_param->[$pos -1];
+ $pos++ if $simple_cmd;
+ if ($pos < scalar(@$arg_param)) {
+ my $pname = $arg_param->[$pos];
&$print_parameter_completion($pname);
return;
}
my $get_exe_name = sub {
my ($class) = @_;
-
+
my $name = $class;
$name =~ s/^.*:://;
$name =~ s/_/-/g;
no strict 'refs';
my $def = ${"${class}::cmddef"};
+ $cmddef = $def;
if (ref($def) eq 'ARRAY') {
- print_simple_asciidoc_synopsis(@$def);
+ print_simple_asciidoc_synopsis();
} else {
- $cmddef = $def;
-
$cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
print_asciidoc_synopsis();
}
my $handle_cmd = sub {
- my ($def, $cmdname, $cmd, $args, $pwcallback, $preparefunc, $stringfilemap) = @_;
-
- $cmddef = $def;
- $exename = $cmdname;
+ my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
$cmddef->{help} = [ __PACKAGE__, 'help', ['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') {
+ my $cmd = shift @$args;
+ $abort->("no command specified") if !$cmd;
+
+ # call verifyapi before setup_environment(), don't execute any real code in
+ # this case
+ if ($cmd eq 'verifyapi') {
PVE::RESTHandler::validate_method_schemas();
return;
}
$cli_handler_class->setup_environment();
if ($cmd eq 'bashcomplete') {
- &$print_bash_completion($cmddef, 0, @$args);
+ &$print_bash_completion(undef, @$args);
return;
}
$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);
- }
+ $abort->("unknown command '$cmd'") if !$class;
my $prefix = "$exename $cmd";
my $res = $class->cli_handler($prefix, $name, \@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap);
};
my $handle_simple_cmd = sub {
- my ($def, $args, $pwcallback, $preparefunc, $stringfilemap) = @_;
+ my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
- 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, $stringfilemap);
+ $str .= generate_usage_str('long');
print STDERR "$str\n\n";
return;
} elsif ($args->[0] eq 'verifyapi') {
if (scalar(@$args) >= 1) {
if ($args->[0] eq 'bashcomplete') {
shift @$args;
- &$print_bash_completion({ $name => $def }, $name, @$args);
+ &$print_bash_completion($name, @$args);
return;
}
}
&$outsub($res) if $outsub;
};
-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, prepare => $preparefunc);
-}
-
sub run_cli_handler {
my ($class, %params) = @_;
initlog($exename);
no strict 'refs';
- my $def = ${"${class}::cmddef"};
+ $cmddef = ${"${class}::cmddef"};
- if (ref($def) eq 'ARRAY') {
- &$handle_simple_cmd($def, \@ARGV, $pwcallback, $preparefunc, $stringfilemap);
+ if (ref($cmddef) eq 'ARRAY') {
+ &$handle_simple_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
} else {
- $cmddef = $def;
- my $cmd = shift @ARGV;
- &$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $preparefunc, $stringfilemap);
+ &$handle_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
}
exit 0;