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;
$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 $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) = resolve_cmd($cmd);
$str .= $indent;
$str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
$fixed_param, $format,
- $can_read_pass, $can_str_param_fmap);
+ $read_password_func, $param_mapping_func);
$oldclass = $class;
} elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
$str .= $indent;
$str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format,
- $can_read_pass, $can_str_param_fmap);
+ $read_password_func, $param_mapping_func);
}
return $str;
};
}
my $handle_cmd = sub {
- my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
+ my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
$cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
&$preparefunc() if $preparefunc;
- my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef->{$cmd} || []};
+ my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
$abort->("unknown command '$cmd_str'") if !$class;
my $prefix = "$exename $cmd_str";
- my $res = $class->cli_handler($prefix, $name, $cmd_args, $arg_param, $uri_param, $pwcallback, $stringfilemap);
+ my $res = $class->cli_handler($prefix, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
&$outsub($res) if $outsub;
};
my $handle_simple_cmd = sub {
- my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
+ my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef};
die "no class specified" if !$class;
&$preparefunc() if $preparefunc;
- my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap);
+ my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
&$outsub($res) if $outsub;
};
my $preparefunc = $params{prepare};
- my $pwcallback = $class->can('read_password');
- my $stringfilemap = $class->can('string_param_file_mapping');
+ 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);
$cmddef = ${"${class}::cmddef"};
if (ref($cmddef) eq 'ARRAY') {
- &$handle_simple_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
+ &$handle_simple_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
} else {
- &$handle_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
+ &$handle_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
}
exit 0;