]> git.proxmox.com Git - pve-common.git/blame - src/PVE/CLIHandler.pm
PVE::CLIHandler::print_api_list - improve format check
[pve-common.git] / src / PVE / CLIHandler.pm
CommitLineData
e143e9d8
DM
1package PVE::CLIHandler;
2
3use strict;
4use warnings;
340c9862 5use JSON;
e143e9d8 6
93ddd7bc 7use PVE::SafeSyslog;
e143e9d8
DM
8use PVE::Exception qw(raise raise_param_exc);
9use PVE::RESTHandler;
0da61ab3 10use PVE::PTY;
881eb755 11use PVE::INotify;
e143e9d8
DM
12
13use base qw(PVE::RESTHandler);
14
c1059f7c
TL
15# $cmddef defines which (sub)commands are available in a specific CLI class.
16# A real command is always an array consisting of its class, name, array of
17# position fixed (required) parameters and hash of predefined parameters when
18# mapping a CLI command t o an API call. Optionally an output method can be
19# passed at the end, e.g., for formatting or transformation purpose.
20#
21# [class, name, fixed_params, API_pre-set params, output_sub ]
22#
23# In case of so called 'simple commands', the $cmddef can be also just an
24# array.
25#
26# Examples:
27# $cmddef = {
28# command => [ 'PVE::API2::Class', 'command', [ 'arg1', 'arg2' ], { node => $nodename } ],
29# do => {
30# this => [ 'PVE::API2::OtherClass', 'method', [ 'arg1' ], undef, sub {
31# my ($res) = @_;
32# print "$res\n";
33# }],
34# that => [ 'PVE::API2::OtherClass', 'subroutine' [] ],
35# },
36# dothat => { alias => 'do that' },
37# }
e143e9d8
DM
38my $cmddef;
39my $exename;
891b798d 40my $cli_handler_class;
e143e9d8 41
37f010e7
TL
42my $standard_mappings = {
43 'pve-password' => {
44 name => 'password',
45 desc => '<password>',
46 interactive => 1,
47 func => sub {
48 my ($value) = @_;
49 return $value if $value;
50 return PVE::PTY::get_confirmed_password();
51 },
52 },
53};
54sub get_standard_mapping {
55 my ($name, $base) = @_;
56
57 my $std = $standard_mappings->{$name};
58 die "no such standard mapping '$name'\n" if !$std;
59
60 my $res = $base || {};
61
62 foreach my $opt (keys %$std) {
63 next if defined($res->{$opt});
64 $res->{$opt} = $std->{$opt};
65 }
66
67 return $res;
68}
69
d204696c
TL
70my $assert_initialized = sub {
71 my @caller = caller;
72 die "$caller[0]:$caller[2] - not initialized\n"
73 if !($cmddef && $exename && $cli_handler_class);
74};
75
918140af
TL
76my $abort = sub {
77 my ($reason, $cmd) = @_;
78 print_usage_short (\*STDERR, $reason, $cmd);
79 exit (-1);
80};
81
e143e9d8
DM
82my $expand_command_name = sub {
83 my ($def, $cmd) = @_;
84
5082a17b
WB
85 return $cmd if exists $def->{$cmd}; # command is already complete
86
ea5a5084 87 my $is_alias = sub { ref($_[0]) eq 'HASH' && exists($_[0]->{alias}) };
0b796806
TL
88 my @expanded = grep { /^\Q$cmd\E/ && !$is_alias->($def->{$_}) } keys %$def;
89
5082a17b
WB
90 return $expanded[0] if scalar(@expanded) == 1; # enforce exact match
91
92 return undef;
e143e9d8
DM
93};
94
50b89b88
TL
95my $get_commands = sub {
96 my $def = shift // die "no command definition passed!";
97 return [ grep { !(ref($def->{$_}) eq 'HASH' && defined($def->{$_}->{alias})) } sort keys %$def ];
edf3d572
DM
98};
99
50b89b88
TL
100my $complete_command_names = sub { $get_commands->($cmddef) };
101
102# traverses the command definition using the $argv array, resolving one level
103# of aliases.
104# Returns the matching (sub) command and its definition, and argument array for
105# this (sub) command and a hash where we marked which (sub) commands got
106# expanded (e.g. st => status) while traversing
107sub resolve_cmd {
108 my ($argv, $is_alias) = @_;
109
110 my ($def, $cmd) = ($cmddef, $argv);
f9326469 111 my $cmdstr = $exename;
50b89b88
TL
112
113 if (ref($argv) eq 'ARRAY') {
5082a17b 114 my $expanded_last_arg;
50b89b88
TL
115 my $last_arg_id = scalar(@$argv) - 1;
116
117 for my $i (0..$last_arg_id) {
118 $cmd = $expand_command_name->($def, $argv->[$i]);
5082a17b
WB
119 if (defined($cmd)) {
120 # If the argument was expanded (or was already complete) and it
121 # is the final argument, tell our caller about it:
122 $expanded_last_arg = $cmd if $i == $last_arg_id;
123 } else {
124 # Otherwise continue with the unexpanded version of it.
125 $cmd = $argv->[$i];
126 }
f9326469 127 $cmdstr .= " $cmd";
50b89b88 128 $def = $def->{$cmd};
57c0d0c6 129 last if !defined($def);
50b89b88
TL
130
131 if (ref($def) eq 'ARRAY') {
132 # could expand to a real command, rest of $argv are its arguments
133 my $cmd_args = [ @$argv[$i+1..$last_arg_id] ];
5082a17b 134 return ($cmd, $def, $cmd_args, $expanded_last_arg, $cmdstr);
50b89b88
TL
135 }
136
137 if (defined($def->{alias})) {
138 die "alias loop detected for '$cmd'" if $is_alias; # avoids cycles
139 # replace aliased (sub)command with the expanded aliased command
140 splice @$argv, $i, 1, split(/ +/, $def->{alias});
141 return resolve_cmd($argv, 1);
142 }
143 }
144 # got either a special command (bashcomplete, verifyapi) or an unknown
145 # cmd, just return first entry as cmd and the rest of $argv as cmd_arg
146 my $cmd_args = [ @$argv[1..$last_arg_id] ];
5082a17b 147 return ($argv->[0], $def, $cmd_args, $expanded_last_arg, $cmdstr);
50b89b88 148 }
f9326469 149 return ($cmd, $def, undef, undef, $cmdstr);
50b89b88
TL
150}
151
4c802a57
TL
152sub generate_usage_str {
153 my ($format, $cmd, $indent, $separator, $sortfunc) = @_;
154
155 $assert_initialized->();
156 die 'format required' if !$format;
157
158 $sortfunc //= sub { sort keys %{$_[0]} };
159 $separator //= '';
160 $indent //= '';
161
4e0214fa 162 my $read_password_func = $cli_handler_class->can('read_password');
c44ec0f6
DM
163 my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
164 $cli_handler_class->can('string_param_file_mapping');
4c802a57 165
f9326469 166 my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd($cmd);
24ccf353 167 $abort->("unknown command '$cmdstr'") if !defined($def) && ref($cmd) eq 'ARRAY';
4c802a57
TL
168
169 my $generate;
170 $generate = sub {
171 my ($indent, $separator, $def, $prefix) = @_;
172
173 my $str = '';
174 if (ref($def) eq 'HASH') {
175 my $oldclass = undef;
176 foreach my $cmd (&$sortfunc($def)) {
177
178 if (ref($def->{$cmd}) eq 'ARRAY') {
179 my ($class, $name, $arg_param, $fixed_param) = @{$def->{$cmd}};
180
181 $str .= $separator if $oldclass && $oldclass ne $class;
182 $str .= $indent;
183 $str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
184 $fixed_param, $format,
4e0214fa 185 $read_password_func, $param_mapping_func);
4c802a57 186 $oldclass = $class;
50b89b88
TL
187
188 } elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
189
190 $str .= "*$prefix $cmd*\n\nAn alias for '$exename $def->{$cmd}->{alias}'.\n\n";
191
192 } else {
193 next if $def->{$cmd}->{alias};
194
195 my $substr = $generate->($indent, $separator, $def->{$cmd}, "$prefix $cmd");
196 if ($substr) {
197 $substr .= $separator if $substr !~ /\Q$separator\E{2}/;
198 $str .= $substr;
199 }
4c802a57
TL
200 }
201
202 }
203 } else {
204 my ($class, $name, $arg_param, $fixed_param) = @$def;
205 $abort->("unknown command '$cmd'") if !$class;
206
207 $str .= $indent;
208 $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format,
4e0214fa 209 $read_password_func, $param_mapping_func);
4c802a57
TL
210 }
211 return $str;
212 };
213
50b89b88 214 return $generate->($indent, $separator, $def, $cmdstr);
4c802a57
TL
215}
216
e143e9d8 217__PACKAGE__->register_method ({
3ef20687 218 name => 'help',
e143e9d8
DM
219 path => 'help',
220 method => 'GET',
221 description => "Get help about specified command.",
222 parameters => {
3ef20687 223 additionalProperties => 0,
e143e9d8 224 properties => {
6627ae09
TL
225 'extra-args' => PVE::JSONSchema::get_standard_option('extra-args', {
226 description => 'Shows help for a specific command',
edf3d572 227 completion => $complete_command_names,
6627ae09 228 }),
e143e9d8
DM
229 verbose => {
230 description => "Verbose output format.",
231 type => 'boolean',
232 optional => 1,
233 },
234 },
235 },
236 returns => { type => 'null' },
3ef20687 237
e143e9d8
DM
238 code => sub {
239 my ($param) = @_;
240
d204696c 241 $assert_initialized->();
e143e9d8 242
6627ae09 243 my $cmd = $param->{'extra-args'};
e143e9d8 244
6627ae09 245 my $verbose = defined($cmd) && $cmd;
e143e9d8
DM
246 $verbose = $param->{verbose} if defined($param->{verbose});
247
248 if (!$cmd) {
249 if ($verbose) {
250 print_usage_verbose();
3ef20687 251 } else {
e143e9d8
DM
252 print_usage_short(\*STDOUT);
253 }
254 return undef;
255 }
256
4c802a57
TL
257 my $str;
258 if ($verbose) {
259 $str = generate_usage_str('full', $cmd, '');
260 } else {
261 $str = generate_usage_str('short', $cmd, ' ' x 7);
262 }
263 $str =~ s/^\s+//;
e143e9d8 264
e143e9d8
DM
265 if ($verbose) {
266 print "$str\n";
267 } else {
268 print "USAGE: $str\n";
269 }
270
271 return undef;
272
273 }});
274
0a5a1eee 275sub print_simple_asciidoc_synopsis {
d204696c 276 $assert_initialized->();
fe3f1fde 277
4c802a57
TL
278 my $synopsis = "*${exename}* `help`\n\n";
279 $synopsis .= generate_usage_str('asciidoc');
fe3f1fde
DM
280
281 return $synopsis;
282}
283
0a5a1eee 284sub print_asciidoc_synopsis {
d204696c 285 $assert_initialized->();
fe3f1fde 286
fe3f1fde
DM
287 my $synopsis = "";
288
289 $synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n";
290
4c802a57 291 $synopsis .= generate_usage_str('asciidoc');
fe3f1fde
DM
292
293 $synopsis .= "\n";
294
295 return $synopsis;
296}
297
e143e9d8 298sub print_usage_verbose {
d204696c 299 $assert_initialized->();
891b798d 300
e143e9d8
DM
301 print "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
302
4c802a57 303 my $str = generate_usage_str('full');
e143e9d8 304
4c802a57 305 print "$str\n";
e143e9d8
DM
306}
307
308sub print_usage_short {
50b89b88 309 my ($fd, $msg, $cmd) = @_;
e143e9d8 310
d204696c 311 $assert_initialized->();
891b798d 312
e143e9d8
DM
313 print $fd "ERROR: $msg\n" if $msg;
314 print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n";
315
50b89b88 316 print {$fd} generate_usage_str('short', $cmd, ' ' x 7, "\n", sub {
4c802a57
TL
317 my ($h) = @_;
318 return sort {
319 if (ref($h->{$a}) eq 'ARRAY' && ref($h->{$b}) eq 'ARRAY') {
320 # $a and $b are both real commands order them by their class
321 return $h->{$a}->[0] cmp $h->{$b}->[0] || $a cmp $b;
50b89b88
TL
322 } elsif (ref($h->{$a}) eq 'ARRAY' xor ref($h->{$b}) eq 'ARRAY') {
323 # real command and subcommand mixed, put sub commands first
324 return ref($h->{$b}) eq 'ARRAY' ? -1 : 1;
4c802a57 325 } else {
50b89b88 326 # both are either from the same class or subcommands
4c802a57
TL
327 return $a cmp $b;
328 }
329 } keys %$h;
330 });
e143e9d8
DM
331}
332
d8053c08 333my $print_bash_completion = sub {
57e67ea3 334 my ($simple_cmd, $bash_command, $cur, $prev) = @_;
d8053c08
DM
335
336 my $debug = 0;
337
338 return if !(defined($cur) && defined($prev) && defined($bash_command));
339 return if !defined($ENV{COMP_LINE});
340 return if !defined($ENV{COMP_POINT});
341
342 my $cmdline = substr($ENV{COMP_LINE}, 0, $ENV{COMP_POINT});
343 print STDERR "\nCMDLINE: $ENV{COMP_LINE}\n" if $debug;
344
58d9e664 345 my $args = PVE::Tools::split_args($cmdline);
5fa768fc 346 shift @$args; # no need for program name
d8053c08
DM
347 my $print_result = sub {
348 foreach my $p (@_) {
2c48a665 349 print "$p\n" if $p =~ m/^\Q$cur\E/;
d8053c08
DM
350 }
351 };
352
5fa768fc
TL
353 my ($cmd, $def) = ($simple_cmd, $cmddef);
354 if (!$simple_cmd) {
0ed80698 355 ($cmd, $def, $args, my $expanded) = resolve_cmd($args);
50b89b88 356
5082a17b
WB
357 if (defined($expanded) && $prev ne $expanded) {
358 print "$expanded\n";
50b89b88
TL
359 return;
360 }
5082a17b
WB
361
362 if (ref($def) eq 'HASH') {
363 &$print_result(@{$get_commands->($def)});
d8053c08
DM
364 return;
365 }
d8053c08 366 }
d8053c08
DM
367 return if !$def;
368
5fa768fc
TL
369 my $pos = scalar(@$args) - 1;
370 $pos += 1 if $cmdline =~ m/\s+$/;
371 print STDERR "pos: $pos\n" if $debug;
372 return if $pos < 0;
d8053c08
DM
373
374 my $skip_param = {};
375
376 my ($class, $name, $arg_param, $uri_param) = @$def;
377 $arg_param //= [];
378 $uri_param //= {};
379
d90a2fd0
DM
380 $arg_param = [ $arg_param ] if !ref($arg_param);
381
d8053c08
DM
382 map { $skip_param->{$_} = 1; } @$arg_param;
383 map { $skip_param->{$_} = 1; } keys %$uri_param;
384
d8053c08
DM
385 my $info = $class->map_method_by_name($name);
386
5fa768fc 387 my $prop = $info->{parameters}->{properties};
d8053c08
DM
388
389 my $print_parameter_completion = sub {
390 my ($pname) = @_;
391 my $d = $prop->{$pname};
392 if ($d->{completion}) {
393 my $vt = ref($d->{completion});
394 if ($vt eq 'CODE') {
58d9e664 395 my $res = $d->{completion}->($cmd, $pname, $cur, $args);
d8053c08
DM
396 &$print_result(@$res);
397 }
398 } elsif ($d->{type} eq 'boolean') {
399 &$print_result('0', '1');
400 } elsif ($d->{enum}) {
401 &$print_result(@{$d->{enum}});
402 }
403 };
404
405 # positional arguments
5fa768fc
TL
406 if ($pos < scalar(@$arg_param)) {
407 my $pname = $arg_param->[$pos];
d8053c08
DM
408 &$print_parameter_completion($pname);
409 return;
410 }
411
412 my @option_list = ();
413 foreach my $key (keys %$prop) {
414 next if $skip_param->{$key};
415 push @option_list, "--$key";
416 }
417
418 if ($cur =~ m/^-/) {
419 &$print_result(@option_list);
420 return;
421 }
422
423 if ($prev =~ m/^--?(.+)$/ && $prop->{$1}) {
424 my $pname = $1;
425 &$print_parameter_completion($pname);
426 return;
427 }
428
429 &$print_result(@option_list);
430};
431
340c9862
DM
432sub data_to_text {
433 my ($data) = @_;
434
435 return undef if !defined($data);
436
437 if (my $class = ref($data)) {
438 return to_json($data, { utf8 => 1, canonical => 1 });
439 } else {
440 return "$data";
441 }
442}
443
8042c2cc
SI
444# prints a formatted table with a title row.
445# $formatopts is an array of hashes, with the following keys:
acd6f383
TL
446# 'key' - key of $data element to print
447# 'title' - column title, defaults to 'key' - won't get cutoff
448# 'cutoff' - maximal (print) length of this column values, if set
449# the last column will never be cutoff
450# 'default' - optional default value for the column
451# formatopts element order defines column order (left to right)
8042c2cc
SI
452sub print_text_table {
453 my ($formatopts, $data) = @_;
8042c2cc 454
85b9def2
TL
455 my ($formatstring, @keys, @titles, %cutoffs, %defaults);
456 my $last_col = $formatopts->[$#{$formatopts}];
457
8042c2cc 458 foreach my $col ( @$formatopts ) {
ba49de85 459 my ($key, $title, $cutoff) = @$col{qw(key title cutoff)};
8042c2cc
SI
460 $title //= $key;
461
462 push @keys, $key;
463 push @titles, $title;
ba49de85 464 $defaults{$key} = $col->{default} // '';
8042c2cc 465
85b9def2 466 # calculate maximal print width and cutoff
8042c2cc
SI
467 my $titlelen = length($title);
468
469 my $longest = $titlelen;
470 foreach my $entry (@$data) {
340c9862 471 my $len = length(data_to_text($entry->{$key})) // 0;
8042c2cc
SI
472 $longest = $len if $len > $longest;
473 }
474
475 $cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest;
476 $cutoffs{$key} = $cutoff;
477
478 my $printalign = $cutoff > $titlelen ? '-' : '';
479 if ($col == $last_col) {
480 $formatstring .= "%${printalign}${titlelen}s\n";
481 } else {
482 $formatstring .= "%${printalign}${cutoff}s ";
483 }
484 }
485
486 printf $formatstring, @titles;
487
85b9def2 488 foreach my $entry (sort { $a->{$keys[0]} cmp $b->{$keys[0]} } @$data) {
340c9862 489 printf $formatstring, map { substr((data_to_text($entry->{$_}) // $defaults{$_}), 0 , $cutoffs{$_}) } @keys;
8042c2cc
SI
490 }
491}
492
acd6f383 493# prints the result of an API GET call returning an array
a604bf22
SI
494# and to have the results key of the API call defined.
495sub print_api_list {
8587474c 496 my ($data, $returninfo, $props_to_print) = @_;
85b9def2 497
2edb0abb
DM
498 die "can only print object lists\n"
499 if !($returninfo->{type} eq 'array' && $returninfo->{items}->{type} eq 'object');
305fc1e1 500
a604bf22 501 my $returnprops = $returninfo->{items}->{properties};
85b9def2 502
eb04f1e2
DM
503 if (!defined($props_to_print)) {
504 $props_to_print = [ sort keys %$returnprops ];
505 if (!scalar(@$props_to_print)) {
506 $props_to_print = [ sort keys %{$data->[0]} ];
507 }
508 die "unable to detect list properties\n" if !scalar(@$props_to_print);
509 }
510
85b9def2 511 my $formatopts = [];
a604bf22
SI
512 foreach my $prop ( @$props_to_print ) {
513 my $propinfo = $returnprops->{$prop};
514 my $colopts = {
515 key => $prop,
516 title => $propinfo->{title},
517 default => $propinfo->{default},
518 cutoff => $propinfo->{print_width} // $propinfo->{maxLength},
519 };
520 push @$formatopts, $colopts;
521 }
522
523 print_text_table($formatopts, $data);
524}
525
340c9862
DM
526sub print_api_result {
527 my ($format, $data, $result_schema) = @_;
528
529 return if $result_schema->{type} eq 'null';
530
531 if ($format eq 'json') {
532 print to_json($data, {utf8 => 1, allow_nonref => 1, canonical => 1, pretty => 1 });
533 } elsif ($format eq 'text') {
534 my $type = $result_schema->{type};
535 if ($type eq 'object') {
536 foreach my $key (sort keys %$data) {
537 print $key . ": " . data_to_text($data->{$key}) . "\n";
538 }
539 } elsif ($type eq 'array') {
540 return if !scalar(@$data);
541 my $item_type = $result_schema->{items}->{type};
542 if ($item_type eq 'object') {
8587474c 543 print_api_list($data, $result_schema);
340c9862
DM
544 } else {
545 foreach my $entry (@$data) {
546 print data_to_text($entry) . "\n";
547 }
548 }
549 } else {
550 print "$data\n";
551 }
552 } else {
553 die "internal error: unknown output format"; # should not happen
554 }
555}
556
1f130ba6
DM
557sub verify_api {
558 my ($class) = @_;
559
560 # simply verify all registered methods
561 PVE::RESTHandler::validate_method_schemas();
562}
563
8f3712f8
DM
564my $get_exe_name = sub {
565 my ($class) = @_;
3ef20687 566
8f3712f8
DM
567 my $name = $class;
568 $name =~ s/^.*:://;
569 $name =~ s/_/-/g;
570
571 return $name;
572};
573
c45707a0
DM
574sub generate_bash_completions {
575 my ($class) = @_;
576
577 # generate bash completion config
578
8f3712f8 579 $exename = &$get_exe_name($class);
c45707a0
DM
580
581 print <<__EOD__;
582# $exename bash completion
583
584# see http://tiswww.case.edu/php/chet/bash/FAQ
585# and __ltrim_colon_completions() in /usr/share/bash-completion/bash_completion
586# this modifies global var, but I found no better way
587COMP_WORDBREAKS=\${COMP_WORDBREAKS//:}
588
e4a1d8e2 589complete -o default -C '$exename bashcomplete' $exename
c45707a0
DM
590__EOD__
591}
592
fe3f1fde
DM
593sub generate_asciidoc_synopsys {
594 my ($class) = @_;
0a5a1eee
FG
595 $class->generate_asciidoc_synopsis();
596};
597
598sub generate_asciidoc_synopsis {
599 my ($class) = @_;
fe3f1fde
DM
600
601 $cli_handler_class = $class;
602
603 $exename = &$get_exe_name($class);
604
605 no strict 'refs';
606 my $def = ${"${class}::cmddef"};
57e67ea3 607 $cmddef = $def;
fe3f1fde
DM
608
609 if (ref($def) eq 'ARRAY') {
4c802a57 610 print_simple_asciidoc_synopsis();
fe3f1fde 611 } else {
fe3f1fde
DM
612 $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
613
0a5a1eee 614 print_asciidoc_synopsis();
fe3f1fde
DM
615 }
616}
617
7b7f99c9
DM
618# overwrite this if you want to run/setup things early
619sub setup_environment {
620 my ($class) = @_;
621
622 # do nothing by default
623}
624
891b798d 625my $handle_cmd = sub {
8d3eb3ce 626 my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
e143e9d8 627
6627ae09 628 $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
e143e9d8 629
f9326469 630 my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd($args);
7b7f99c9 631
918140af
TL
632 $abort->("no command specified") if !$cmd;
633
634 # call verifyapi before setup_environment(), don't execute any real code in
635 # this case
636 if ($cmd eq 'verifyapi') {
e143e9d8
DM
637 PVE::RESTHandler::validate_method_schemas();
638 return;
7b7f99c9
DM
639 }
640
641 $cli_handler_class->setup_environment();
642
643 if ($cmd eq 'bashcomplete') {
50b89b88 644 &$print_bash_completion(undef, @$cmd_args);
d8053c08 645 return;
e143e9d8
DM
646 }
647
50b89b88 648 # checked special commands, if def is still a hash we got an incomplete sub command
131f316b 649 $abort->("incomplete command '$cmd_str'", $args) if ref($def) eq 'HASH';
8e3e9929 650
50b89b88 651 &$preparefunc() if $preparefunc;
e143e9d8 652
b8dc4366 653 my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
50b89b88 654 $abort->("unknown command '$cmd_str'") if !$class;
e143e9d8 655
f9326469 656 my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
2026f4b5 657
a604bf22
SI
658 if (defined $outsub) {
659 my $returninfo = $class->map_method_by_name($name)->{returns};
660 $outsub->($res, $returninfo);
661 }
891b798d 662};
2026f4b5 663
891b798d 664my $handle_simple_cmd = sub {
8d3eb3ce 665 my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
2026f4b5 666
57e67ea3 667 my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef};
2026f4b5
DM
668 die "no class specified" if !$class;
669
d8053c08 670 if (scalar(@$args) >= 1) {
2026f4b5
DM
671 if ($args->[0] eq 'help') {
672 my $str = "USAGE: $name help\n";
4c802a57 673 $str .= generate_usage_str('long');
2026f4b5
DM
674 print STDERR "$str\n\n";
675 return;
676 } elsif ($args->[0] eq 'verifyapi') {
677 PVE::RESTHandler::validate_method_schemas();
678 return;
2026f4b5 679 }
e143e9d8 680 }
2026f4b5 681
7b7f99c9
DM
682 $cli_handler_class->setup_environment();
683
684 if (scalar(@$args) >= 1) {
685 if ($args->[0] eq 'bashcomplete') {
686 shift @$args;
57e67ea3 687 &$print_bash_completion($name, @$args);
7b7f99c9
DM
688 return;
689 }
690 }
691
7fe1f565
DM
692 &$preparefunc() if $preparefunc;
693
8d3eb3ce 694 my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
2026f4b5 695
a604bf22
SI
696 if (defined $outsub) {
697 my $returninfo = $class->map_method_by_name($name)->{returns};
698 $outsub->($res, $returninfo);
699 }
891b798d
DM
700};
701
891b798d
DM
702sub run_cli_handler {
703 my ($class, %params) = @_;
704
705 $cli_handler_class = $class;
706
707 $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
708
aa9b9af5 709 foreach my $key (keys %params) {
5ae87c41 710 next if $key eq 'prepare';
1042b82c
DM
711 next if $key eq 'no_init'; # not used anymore
712 next if $key eq 'no_rpcenv'; # not used anymore
aa9b9af5
DM
713 die "unknown parameter '$key'";
714 }
715
5ae87c41 716 my $preparefunc = $params{prepare};
891b798d 717
8d3eb3ce 718 my $read_password_func = $class->can('read_password');
c44ec0f6
DM
719 my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
720 $class->can('string_param_file_mapping');
891b798d
DM
721
722 $exename = &$get_exe_name($class);
723
724 initlog($exename);
725
891b798d 726 no strict 'refs';
57e67ea3 727 $cmddef = ${"${class}::cmddef"};
891b798d 728
57e67ea3 729 if (ref($cmddef) eq 'ARRAY') {
8d3eb3ce 730 &$handle_simple_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
891b798d 731 } else {
8d3eb3ce 732 &$handle_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
891b798d
DM
733 }
734
735 exit 0;
e143e9d8
DM
736}
737
7381;