use PVE::SafeSyslog;
use PVE::Exception qw(raise raise_param_exc);
use PVE::RESTHandler;
+use PVE::PTY;
use PVE::INotify;
use base qw(PVE::RESTHandler);
my $exename;
my $cli_handler_class;
+my $standard_mappings = {
+ 'pve-password' => {
+ name => 'password',
+ desc => '<password>',
+ interactive => 1,
+ func => sub {
+ my ($value) = @_;
+ return $value if $value;
+ return PVE::PTY::get_confirmed_password();
+ },
+ },
+};
+sub get_standard_mapping {
+ my ($name, $base) = @_;
+
+ my $std = $standard_mappings->{$name};
+ die "no such standard mapping '$name'\n" if !$std;
+
+ my $res = $base || {};
+
+ foreach my $opt (keys %$std) {
+ next if defined($res->{$opt});
+ $res->{$opt} = $std->{$opt};
+ }
+
+ return $res;
+}
+
my $assert_initialized = sub {
my @caller = caller;
die "$caller[0]:$caller[2] - not initialized\n"
# prints a formatted table with a title row.
# $formatopts is an array of hashes, with the following keys:
-# 'key' - the key in the data-objects to use for this column
-# 'title' - the title to print above the column, defaults to 'key' - always gets printed in full
-# 'cutoff' - the maximal length of the data, overlong values will be truncated
-# 'default' - an optional default value for the column
-# the last column always gets printed in full
+# 'key' - key of $data element to print
+# 'title' - column title, defaults to 'key' - won't get cutoff
+# 'cutoff' - maximal (print) length of this column values, if set
+# the last column will never be cutoff
+# 'default' - optional default value for the column
+# formatopts element order defines column order (left to right)
sub print_text_table {
my ($formatopts, $data) = @_;
- my ($formatstring, @keys, @titles, %cutoffs, %defaults, $last_col);
- $last_col = $formatopts->[$#{$formatopts}];
+ my ($formatstring, @keys, @titles, %cutoffs, %defaults);
+ my $last_col = $formatopts->[$#{$formatopts}];
+
foreach my $col ( @$formatopts ) {
- my ($key, $title, $cutoff, $default) = @$col{ qw(key title cutoff default)};
+ my ($key, $title, $cutoff) = @$col{qw(key title cutoff)};
$title //= $key;
push @keys, $key;
push @titles, $title;
- $defaults{$key} = $default;
+ $defaults{$key} = $col->{default} // '';
- #calculate maximal print width and cutoff
+ # calculate maximal print width and cutoff
my $titlelen = length($title);
my $longest = $titlelen;
printf $formatstring, @titles;
- foreach my $entry (sort { $a->{$keys[0]} cmp $b->{$keys[0]} } @$data){
+ foreach my $entry (sort { $a->{$keys[0]} cmp $b->{$keys[0]} } @$data) {
printf $formatstring, map { substr(($entry->{$_} // $defaults{$_}), 0 , $cutoffs{$_}) } @keys;
}
}
sub print_entry {
my $entry = shift;
+
#TODO: handle objects/hashes as well
foreach my $item (sort keys %$entry) {
- if (ref($entry->{$item}) eq 'ARRAY'){
+ if (ref($entry->{$item}) eq 'ARRAY') {
printf "%s: [ %s ]\n", $item, join(", ", @{$entry->{$item}});
} else {
printf "%s: %s\n", $item, $entry->{$item};
}
}
+# prints the result of an API GET call returning an array
+# and to have the results key of the API call defined.
+sub print_api_list {
+ my ($props_to_print, $data, $returninfo) = @_;
+
+ die "can only print array result" if $returninfo->{type} ne 'array';
+
+ my $returnprops = $returninfo->{items}->{properties};
+
+ my $formatopts = [];
+ foreach my $prop ( @$props_to_print ) {
+ my $propinfo = $returnprops->{$prop};
+ my $colopts = {
+ key => $prop,
+ title => $propinfo->{title},
+ default => $propinfo->{default},
+ cutoff => $propinfo->{print_width} // $propinfo->{maxLength},
+ };
+ push @$formatopts, $colopts;
+ }
+
+ print_text_table($formatopts, $data);
+}
+
sub verify_api {
my ($class) = @_;
my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
- &$outsub($res) if $outsub;
+ if (defined $outsub) {
+ my $returninfo = $class->map_method_by_name($name)->{returns};
+ $outsub->($res, $returninfo);
+ }
};
my $handle_simple_cmd = sub {
my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
- &$outsub($res) if $outsub;
+ if (defined $outsub) {
+ my $returninfo = $class->map_method_by_name($name)->{returns};
+ $outsub->($res, $returninfo);
+ }
};
sub run_cli_handler {