},
},
};
+
sub get_standard_mapping {
my ($name, $base) = @_;
return $res;
}
+my $gen_param_mapping_func = sub {
+ my ($cli_handler_class) = @_;
+
+ my $param_mapping = $cli_handler_class->can('param_mapping');
+
+ if (!$param_mapping) {
+ my $read_password = $cli_handler_class->can('read_password');
+ my $string_param_mapping = $cli_handler_class->can('string_param_file_mapping');
+
+ return $string_param_mapping if !$read_password;
+
+ $param_mapping = sub {
+ my ($name) = @_;
+
+ my $password_map = get_standard_mapping('pve-password', {
+ func => $read_password
+ });
+ my $map = $string_param_mapping ? $string_param_mapping->($name) : [];
+ return [@$map, $password_map];
+ };
+ }
+
+ return $param_mapping;
+};
+
my $assert_initialized = sub {
my @caller = caller;
die "$caller[0]:$caller[2] - not initialized\n"
$separator //= '';
$indent //= '';
- 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 $param_mapping_func = $gen_param_mapping_func->($cli_handler_class);
my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd($cmd);
$abort->("unknown command '$cmdstr'") if !defined($def) && ref($cmd) eq 'ARRAY';
$str .= $indent;
$str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
$fixed_param, $format,
- $read_password_func, $param_mapping_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,
- $read_password_func, $param_mapping_func);
+ $param_mapping_func);
}
return $str;
};
sub data_to_text {
my ($data) = @_;
- return undef if !defined($data);
+ return '' if !defined($data);
if (my $class = ref($data)) {
return to_json($data, { utf8 => 1, canonical => 1 });
}
# prints a formatted table with a title row.
-# $formatopts is an array of hashes, with the following keys:
-# '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)
-# sorts the output according to the leftmost column not containing any undef
+# $data - the data to print (array of objects)
+# $returnprops -json schema property description
+# $props_to_print - ordered list of properties to print
+# $sort_key can be used to sort after a column, if it isn't set we sort
+# after the leftmost column (with no undef value in $data) this can be
+# turned off by passing 0 as $sort_key
sub print_text_table {
- my ($formatopts, $data) = @_;
+ my ($data, $returnprops, $props_to_print, $sort_key) = @_;
- my ($formatstring, @keys, @titles, %cutoffs, %defaults, $sort_key);
- my $last_col = $formatopts->[$#{$formatopts}];
+ my $autosort = 1;
+ if (defined($sort_key) && $sort_key eq 0) {
+ $autosort = 0;
+ $sort_key = undef;
+ }
- foreach my $col ( @$formatopts ) {
- my ($key, $title, $cutoff) = @$col{qw(key title cutoff)};
- $title //= $key;
+ my $colopts = {};
+ my $formatstring = '';
- push @keys, $key;
- push @titles, $title;
- $defaults{$key} = $col->{default} // '';
+ my $column_count = scalar(@$props_to_print);
+
+ for (my $i = 0; $i < $column_count; $i++) {
+ my $prop = $props_to_print->[$i];
+ my $propinfo = $returnprops->{$prop} // {};
+
+ my $title = $propinfo->{title} // $prop;
+ my $cutoff = $propinfo->{print_width} // $propinfo->{maxLength};
# calculate maximal print width and cutoff
my $titlelen = length($title);
my $longest = $titlelen;
- my $sortable = 1;
+ my $sortable = $autosort;
foreach my $entry (@$data) {
- my $len = length(data_to_text($entry->{$key})) // 0;
+ my $len = length(data_to_text($entry->{$prop})) // 0;
$longest = $len if $len > $longest;
- $sortable = 0 if !defined($entry->{$key});
+ $sortable = 0 if !defined($entry->{$prop});
}
+ $cutoff = $longest if !defined($cutoff) || $cutoff > $longest;
+ $sort_key //= $prop if $sortable;
- $sort_key //= $key if $sortable;
- $cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest;
- $cutoffs{$key} = $cutoff;
+ $colopts->{$prop} = {
+ title => $title,
+ default => $propinfo->{default} // '',
+ cutoff => $cutoff,
+ };
- my $printalign = $cutoff > $titlelen ? '-' : '';
- if ($col == $last_col) {
- $formatstring .= "%${printalign}${titlelen}s\n";
- } else {
- $formatstring .= "%${printalign}${cutoff}s ";
- }
+ # skip alignment and cutoff on last column
+ $formatstring .= ($i == ($column_count - 1)) ? "%s\n" : "%-${cutoff}s ";
}
- printf $formatstring, @titles;
+ printf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
- if (defined($sort_key)){
- @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
+ if (defined($sort_key)) {
+ my $type = $returnprops->{$sort_key}->{type} // 'string';
+ if ($type eq 'integer' || $type eq 'number') {
+ @$data = sort { $a->{$sort_key} <=> $b->{$sort_key} } @$data;
+ } else {
+ @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
+ }
}
+
foreach my $entry (@$data) {
- printf $formatstring, map { substr((data_to_text($entry->{$_}) // $defaults{$_}), 0 , $cutoffs{$_}) } @keys;
+ printf $formatstring, map {
+ substr(data_to_text($entry->{$_}) // $colopts->{$_}->{default},
+ 0, $colopts->{$_}->{cutoff});
+ } @$props_to_print;
}
}
# takes all fields of the results property, with a fallback
# to all fields occuring in items of $data.
sub print_api_list {
- my ($data, $result_schema, $props_to_print) = @_;
+ my ($data, $result_schema, $props_to_print, $sort_key) = @_;
die "can only print object lists\n"
if !($result_schema->{type} eq 'array' && $result_schema->{items}->{type} eq 'object');
die "unable to detect list properties\n" if !scalar(@$props_to_print);
}
- 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);
+ print_text_table($data, $returnprops, $props_to_print, $sort_key);
}
sub print_api_result {
- my ($format, $data, $result_schema) = @_;
+ my ($format, $data, $result_schema, $props_to_print, $sort_key) = @_;
return if $result_schema->{type} eq 'null';
} elsif ($format eq 'text') {
my $type = $result_schema->{type};
if ($type eq 'object') {
- foreach my $key (sort keys %$data) {
+ $props_to_print = [ sort keys %$data ] if !defined($props_to_print);
+ foreach my $key (@$props_to_print) {
print $key . ": " . data_to_text($data->{$key}) . "\n";
}
} elsif ($type eq 'array') {
return if !scalar(@$data);
my $item_type = $result_schema->{items}->{type};
if ($item_type eq 'object') {
- print_api_list($data, $result_schema);
+ print_api_list($data, $result_schema, $props_to_print, $sort_key);
} else {
foreach my $entry (@$data) {
print data_to_text($entry) . "\n";
}
my $handle_cmd = sub {
- my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
+ my ($args, $preparefunc, $param_mapping_func) = @_;
$cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
$abort->("unknown command '$cmd_str'") if !$class;
- my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
+ my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $param_mapping_func);
if (defined $outsub) {
my $result_schema = $class->map_method_by_name($name)->{returns};
};
my $handle_simple_cmd = sub {
- my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
+ my ($args, $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, $read_password_func, $param_mapping_func);
+ my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $param_mapping_func);
if (defined $outsub) {
my $result_schema = $class->map_method_by_name($name)->{returns};
my $preparefunc = $params{prepare};
- my $read_password_func = $class->can('read_password');
- my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
- $class->can('string_param_file_mapping');
+ my $param_mapping_func = $gen_param_mapping_func->($cli_handler_class);
$exename = &$get_exe_name($class);
$cmddef = ${"${class}::cmddef"};
if (ref($cmddef) eq 'ARRAY') {
- &$handle_simple_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
+ $handle_simple_cmd->(\@ARGV, $preparefunc, $param_mapping_func);
} else {
- &$handle_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
+ $handle_cmd->(\@ARGV, $preparefunc, $param_mapping_func);
}
exit 0;