]>
Commit | Line | Data |
---|---|---|
e143e9d8 DM |
1 | package PVE::CLIHandler; |
2 | ||
3 | use strict; | |
4 | use warnings; | |
340c9862 | 5 | use JSON; |
e143e9d8 | 6 | |
93ddd7bc | 7 | use PVE::SafeSyslog; |
e143e9d8 DM |
8 | use PVE::Exception qw(raise raise_param_exc); |
9 | use PVE::RESTHandler; | |
0da61ab3 | 10 | use PVE::PTY; |
881eb755 | 11 | use PVE::INotify; |
e143e9d8 DM |
12 | |
13 | use 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 |
38 | my $cmddef; |
39 | my $exename; | |
891b798d | 40 | my $cli_handler_class; |
e143e9d8 | 41 | |
37f010e7 TL |
42 | my $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 | }; | |
54 | sub 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 |
70 | my $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 |
76 | my $abort = sub { |
77 | my ($reason, $cmd) = @_; | |
78 | print_usage_short (\*STDERR, $reason, $cmd); | |
79 | exit (-1); | |
80 | }; | |
81 | ||
e143e9d8 DM |
82 | my $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 |
95 | my $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 |
100 | my $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 | |
107 | sub 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 |
152 | sub 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 | 275 | sub 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 | 284 | sub 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 | 298 | sub 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 | ||
308 | sub 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 | 333 | my $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 |
432 | sub 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) | |
e05f7cdd | 452 | # sorts the output according to the leftmost column not containing any undef |
8042c2cc SI |
453 | sub print_text_table { |
454 | my ($formatopts, $data) = @_; | |
8042c2cc | 455 | |
e05f7cdd | 456 | my ($formatstring, @keys, @titles, %cutoffs, %defaults, $sort_key); |
85b9def2 TL |
457 | my $last_col = $formatopts->[$#{$formatopts}]; |
458 | ||
8042c2cc | 459 | foreach my $col ( @$formatopts ) { |
ba49de85 | 460 | my ($key, $title, $cutoff) = @$col{qw(key title cutoff)}; |
8042c2cc SI |
461 | $title //= $key; |
462 | ||
463 | push @keys, $key; | |
464 | push @titles, $title; | |
ba49de85 | 465 | $defaults{$key} = $col->{default} // ''; |
8042c2cc | 466 | |
85b9def2 | 467 | # calculate maximal print width and cutoff |
8042c2cc SI |
468 | my $titlelen = length($title); |
469 | ||
470 | my $longest = $titlelen; | |
e05f7cdd | 471 | my $sortable = 1; |
8042c2cc | 472 | foreach my $entry (@$data) { |
340c9862 | 473 | my $len = length(data_to_text($entry->{$key})) // 0; |
8042c2cc | 474 | $longest = $len if $len > $longest; |
e05f7cdd | 475 | $sortable = 0 if !defined($entry->{$key}); |
8042c2cc SI |
476 | } |
477 | ||
e05f7cdd | 478 | $sort_key //= $key if $sortable; |
8042c2cc SI |
479 | $cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest; |
480 | $cutoffs{$key} = $cutoff; | |
481 | ||
482 | my $printalign = $cutoff > $titlelen ? '-' : ''; | |
483 | if ($col == $last_col) { | |
484 | $formatstring .= "%${printalign}${titlelen}s\n"; | |
485 | } else { | |
486 | $formatstring .= "%${printalign}${cutoff}s "; | |
487 | } | |
488 | } | |
489 | ||
490 | printf $formatstring, @titles; | |
491 | ||
e05f7cdd SI |
492 | if (defined($sort_key)){ |
493 | @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data; | |
494 | } | |
495 | foreach my $entry (@$data) { | |
340c9862 | 496 | printf $formatstring, map { substr((data_to_text($entry->{$_}) // $defaults{$_}), 0 , $cutoffs{$_}) } @keys; |
8042c2cc SI |
497 | } |
498 | } | |
499 | ||
acd6f383 | 500 | # prints the result of an API GET call returning an array |
a604bf22 SI |
501 | # and to have the results key of the API call defined. |
502 | sub print_api_list { | |
ec3cbded | 503 | my ($data, $result_schema, $props_to_print) = @_; |
85b9def2 | 504 | |
2edb0abb | 505 | die "can only print object lists\n" |
ec3cbded | 506 | if !($result_schema->{type} eq 'array' && $result_schema->{items}->{type} eq 'object'); |
305fc1e1 | 507 | |
ec3cbded | 508 | my $returnprops = $result_schema->{items}->{properties}; |
85b9def2 | 509 | |
eb04f1e2 DM |
510 | if (!defined($props_to_print)) { |
511 | $props_to_print = [ sort keys %$returnprops ]; | |
512 | if (!scalar(@$props_to_print)) { | |
9b8f2f8f SI |
513 | my $all_props = {}; |
514 | foreach my $obj (@{$data}) { | |
515 | foreach my $key (keys %{$obj}) { | |
516 | $all_props->{ $key } = 1; | |
517 | } | |
518 | } | |
519 | $props_to_print = [ sort keys %{$all_props} ]; | |
eb04f1e2 DM |
520 | } |
521 | die "unable to detect list properties\n" if !scalar(@$props_to_print); | |
522 | } | |
523 | ||
85b9def2 | 524 | my $formatopts = []; |
a604bf22 SI |
525 | foreach my $prop ( @$props_to_print ) { |
526 | my $propinfo = $returnprops->{$prop}; | |
527 | my $colopts = { | |
528 | key => $prop, | |
529 | title => $propinfo->{title}, | |
530 | default => $propinfo->{default}, | |
531 | cutoff => $propinfo->{print_width} // $propinfo->{maxLength}, | |
532 | }; | |
533 | push @$formatopts, $colopts; | |
534 | } | |
535 | ||
536 | print_text_table($formatopts, $data); | |
537 | } | |
538 | ||
340c9862 DM |
539 | sub print_api_result { |
540 | my ($format, $data, $result_schema) = @_; | |
541 | ||
542 | return if $result_schema->{type} eq 'null'; | |
543 | ||
544 | if ($format eq 'json') { | |
545 | print to_json($data, {utf8 => 1, allow_nonref => 1, canonical => 1, pretty => 1 }); | |
546 | } elsif ($format eq 'text') { | |
547 | my $type = $result_schema->{type}; | |
548 | if ($type eq 'object') { | |
549 | foreach my $key (sort keys %$data) { | |
550 | print $key . ": " . data_to_text($data->{$key}) . "\n"; | |
551 | } | |
552 | } elsif ($type eq 'array') { | |
553 | return if !scalar(@$data); | |
554 | my $item_type = $result_schema->{items}->{type}; | |
555 | if ($item_type eq 'object') { | |
8587474c | 556 | print_api_list($data, $result_schema); |
340c9862 DM |
557 | } else { |
558 | foreach my $entry (@$data) { | |
559 | print data_to_text($entry) . "\n"; | |
560 | } | |
561 | } | |
562 | } else { | |
563 | print "$data\n"; | |
564 | } | |
565 | } else { | |
566 | die "internal error: unknown output format"; # should not happen | |
567 | } | |
568 | } | |
569 | ||
1f130ba6 DM |
570 | sub verify_api { |
571 | my ($class) = @_; | |
572 | ||
573 | # simply verify all registered methods | |
574 | PVE::RESTHandler::validate_method_schemas(); | |
575 | } | |
576 | ||
8f3712f8 DM |
577 | my $get_exe_name = sub { |
578 | my ($class) = @_; | |
3ef20687 | 579 | |
8f3712f8 DM |
580 | my $name = $class; |
581 | $name =~ s/^.*:://; | |
582 | $name =~ s/_/-/g; | |
583 | ||
584 | return $name; | |
585 | }; | |
586 | ||
c45707a0 DM |
587 | sub generate_bash_completions { |
588 | my ($class) = @_; | |
589 | ||
590 | # generate bash completion config | |
591 | ||
8f3712f8 | 592 | $exename = &$get_exe_name($class); |
c45707a0 DM |
593 | |
594 | print <<__EOD__; | |
595 | # $exename bash completion | |
596 | ||
597 | # see http://tiswww.case.edu/php/chet/bash/FAQ | |
598 | # and __ltrim_colon_completions() in /usr/share/bash-completion/bash_completion | |
599 | # this modifies global var, but I found no better way | |
600 | COMP_WORDBREAKS=\${COMP_WORDBREAKS//:} | |
601 | ||
e4a1d8e2 | 602 | complete -o default -C '$exename bashcomplete' $exename |
c45707a0 DM |
603 | __EOD__ |
604 | } | |
605 | ||
fe3f1fde DM |
606 | sub generate_asciidoc_synopsys { |
607 | my ($class) = @_; | |
0a5a1eee FG |
608 | $class->generate_asciidoc_synopsis(); |
609 | }; | |
610 | ||
611 | sub generate_asciidoc_synopsis { | |
612 | my ($class) = @_; | |
fe3f1fde DM |
613 | |
614 | $cli_handler_class = $class; | |
615 | ||
616 | $exename = &$get_exe_name($class); | |
617 | ||
618 | no strict 'refs'; | |
619 | my $def = ${"${class}::cmddef"}; | |
57e67ea3 | 620 | $cmddef = $def; |
fe3f1fde DM |
621 | |
622 | if (ref($def) eq 'ARRAY') { | |
4c802a57 | 623 | print_simple_asciidoc_synopsis(); |
fe3f1fde | 624 | } else { |
fe3f1fde DM |
625 | $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ]; |
626 | ||
0a5a1eee | 627 | print_asciidoc_synopsis(); |
fe3f1fde DM |
628 | } |
629 | } | |
630 | ||
7b7f99c9 DM |
631 | # overwrite this if you want to run/setup things early |
632 | sub setup_environment { | |
633 | my ($class) = @_; | |
634 | ||
635 | # do nothing by default | |
636 | } | |
637 | ||
891b798d | 638 | my $handle_cmd = sub { |
8d3eb3ce | 639 | my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_; |
e143e9d8 | 640 | |
6627ae09 | 641 | $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ]; |
e143e9d8 | 642 | |
f9326469 | 643 | my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd($args); |
7b7f99c9 | 644 | |
918140af TL |
645 | $abort->("no command specified") if !$cmd; |
646 | ||
647 | # call verifyapi before setup_environment(), don't execute any real code in | |
648 | # this case | |
649 | if ($cmd eq 'verifyapi') { | |
e143e9d8 DM |
650 | PVE::RESTHandler::validate_method_schemas(); |
651 | return; | |
7b7f99c9 DM |
652 | } |
653 | ||
654 | $cli_handler_class->setup_environment(); | |
655 | ||
656 | if ($cmd eq 'bashcomplete') { | |
50b89b88 | 657 | &$print_bash_completion(undef, @$cmd_args); |
d8053c08 | 658 | return; |
e143e9d8 DM |
659 | } |
660 | ||
50b89b88 | 661 | # checked special commands, if def is still a hash we got an incomplete sub command |
131f316b | 662 | $abort->("incomplete command '$cmd_str'", $args) if ref($def) eq 'HASH'; |
8e3e9929 | 663 | |
50b89b88 | 664 | &$preparefunc() if $preparefunc; |
e143e9d8 | 665 | |
b8dc4366 | 666 | my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []}; |
50b89b88 | 667 | $abort->("unknown command '$cmd_str'") if !$class; |
e143e9d8 | 668 | |
f9326469 | 669 | my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func); |
2026f4b5 | 670 | |
a604bf22 | 671 | if (defined $outsub) { |
ec3cbded DM |
672 | my $result_schema = $class->map_method_by_name($name)->{returns}; |
673 | $outsub->($res, $result_schema); | |
a604bf22 | 674 | } |
891b798d | 675 | }; |
2026f4b5 | 676 | |
891b798d | 677 | my $handle_simple_cmd = sub { |
8d3eb3ce | 678 | my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_; |
2026f4b5 | 679 | |
57e67ea3 | 680 | my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef}; |
2026f4b5 DM |
681 | die "no class specified" if !$class; |
682 | ||
d8053c08 | 683 | if (scalar(@$args) >= 1) { |
2026f4b5 DM |
684 | if ($args->[0] eq 'help') { |
685 | my $str = "USAGE: $name help\n"; | |
4c802a57 | 686 | $str .= generate_usage_str('long'); |
2026f4b5 DM |
687 | print STDERR "$str\n\n"; |
688 | return; | |
689 | } elsif ($args->[0] eq 'verifyapi') { | |
690 | PVE::RESTHandler::validate_method_schemas(); | |
691 | return; | |
2026f4b5 | 692 | } |
e143e9d8 | 693 | } |
2026f4b5 | 694 | |
7b7f99c9 DM |
695 | $cli_handler_class->setup_environment(); |
696 | ||
697 | if (scalar(@$args) >= 1) { | |
698 | if ($args->[0] eq 'bashcomplete') { | |
699 | shift @$args; | |
57e67ea3 | 700 | &$print_bash_completion($name, @$args); |
7b7f99c9 DM |
701 | return; |
702 | } | |
703 | } | |
704 | ||
7fe1f565 DM |
705 | &$preparefunc() if $preparefunc; |
706 | ||
8d3eb3ce | 707 | my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $read_password_func, $param_mapping_func); |
2026f4b5 | 708 | |
a604bf22 | 709 | if (defined $outsub) { |
ec3cbded DM |
710 | my $result_schema = $class->map_method_by_name($name)->{returns}; |
711 | $outsub->($res, $result_schema); | |
a604bf22 | 712 | } |
891b798d DM |
713 | }; |
714 | ||
891b798d DM |
715 | sub run_cli_handler { |
716 | my ($class, %params) = @_; | |
717 | ||
718 | $cli_handler_class = $class; | |
719 | ||
720 | $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin'; | |
721 | ||
aa9b9af5 | 722 | foreach my $key (keys %params) { |
5ae87c41 | 723 | next if $key eq 'prepare'; |
1042b82c DM |
724 | next if $key eq 'no_init'; # not used anymore |
725 | next if $key eq 'no_rpcenv'; # not used anymore | |
aa9b9af5 DM |
726 | die "unknown parameter '$key'"; |
727 | } | |
728 | ||
5ae87c41 | 729 | my $preparefunc = $params{prepare}; |
891b798d | 730 | |
8d3eb3ce | 731 | my $read_password_func = $class->can('read_password'); |
c44ec0f6 DM |
732 | my $param_mapping_func = $cli_handler_class->can('param_mapping') || |
733 | $class->can('string_param_file_mapping'); | |
891b798d DM |
734 | |
735 | $exename = &$get_exe_name($class); | |
736 | ||
737 | initlog($exename); | |
738 | ||
891b798d | 739 | no strict 'refs'; |
57e67ea3 | 740 | $cmddef = ${"${class}::cmddef"}; |
891b798d | 741 | |
57e67ea3 | 742 | if (ref($cmddef) eq 'ARRAY') { |
8d3eb3ce | 743 | &$handle_simple_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func); |
891b798d | 744 | } else { |
8d3eb3ce | 745 | &$handle_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func); |
891b798d DM |
746 | } |
747 | ||
748 | exit 0; | |
e143e9d8 DM |
749 | } |
750 | ||
751 | 1; |