pve-api-definition.dat: add root index method

[pve-client.git] / PVE / APIClient / Helpers.pm

diff --git a/PVE/APIClient/Helpers.pm b/PVE/APIClient/Helpers.pm
index ec932ec5f261bc2a55d23946cfcfdb7372293fb9..9ee00e9d127bcdc17308bc4964141adb10430840 100644 (file)
--- a/PVE/APIClient/Helpers.pm
+++ b/PVE/APIClient/Helpers.pm
@@ -7,6 +7,7 @@ use Storable;
 use JSON;
 use File::Path qw(make_path);
 
+use PVE::APIClient::JSONSchema;
 use PVE::APIClient::Exception qw(raise);
 use Encode::Locale;
 use Encode;
@@ -50,29 +51,71 @@ sub print_result {
     # TODO: implement different output formats ($format)
 
     if ($format eq 'json') {
-       print to_json($data, {utf8 => 1, allow_nonref => 1, canonical => 1, pretty => 1 });
+       print to_json($data, {utf8 => 1, allow_nonref => 1, canonical => 1, pretty => 1 });
     } elsif ($format eq 'text') {
-       my $type = $result_schema->{type};
-       if ($type eq 'object') {
-           die "implement me";
-       } elsif ($type eq 'array') {
-           my $item_type = $result_schema->{items}->{type};
-           if ($item_type eq 'object') {
-               die "implement me";
-           } elsif ($item_type eq 'array') {
-               die "implement me";
-           } else {
-               foreach my $el (@$data) {
-                   print "$el\n"
+       my $type = $result_schema->{type};
+       if ($type eq 'object') {
+           die "implement me";
+       } elsif ($type eq 'array') {
+           my $item_type = $result_schema->{items}->{type};
+           if ($item_type eq 'object') {
+               die "implement me";
+           } elsif ($item_type eq 'array') {
+               die "implement me";
+           } else {
+               foreach my $el (@$data) {
+                   print "$el\n"
+               }
+           }
+       } else {
+           print "$data\n";
+       }
+    } else {
+       die "internal error: unknown output format"; # should not happen
+    }
+}
+
+my $__real_remove_formats; $__real_remove_formats = sub {
+    my ($properties) = @_;
+
+    foreach my $pname (keys %$properties) {
+       if (my $d = $properties->{$pname}) {
+           if (defined(my $format = $d->{format})) {
+               if (ref($format)) {
+                   $__real_remove_formats->($format);
+               } elsif (!PVE::APIClient::JSONSchema::get_format($format)) {
+                   # simply remove unknown format definitions
+                   delete $d->{format};
                }
            }
-       } else {
-           print "$data\n";
        }
-    } else {
-       die "internal error: unknown output format"; # should not happen
     }
-}
+};
+
+my $remove_unknown_formats; $remove_unknown_formats = sub {
+    my ($tree) = @_;
+
+    my $class = ref($tree);
+    return if !$class;
+
+    if ($class eq 'ARRAY') {
+       foreach my $el (@$tree) {
+          $remove_unknown_formats->($el);
+       }
+    } elsif ($class eq 'HASH') {
+       if (my $info = $tree->{info}) {
+           for my $method (qw(GET PUT PUSH DELETE)) {
+               next if !$info->{$method};
+               my $properties = $info->{$method}->{parameters}->{properties};
+               $__real_remove_formats->($properties) if $properties;
+           }
+       }
+       if ($tree->{children}) {
+           $remove_unknown_formats->($tree->{children});
+       }
+    }
+    return;
+};
 
 sub get_api_definition {
 
@@ -80,6 +123,8 @@ sub get_api_definition {
        open(my $fh, '<',  $pve_api_definition_fn) ||
            die "unable to open '$pve_api_definition_fn' - $!\n";
        $pve_api_definition = Storable::fd_retrieve($fh);
+
+       $remove_unknown_formats->($pve_api_definition);
     }
 
     return $pve_api_definition;
@@ -118,7 +163,9 @@ sub find_method_info {
 
     my $stack = [ grep { length($_) > 0 }  split('\/+' , $path)]; # skip empty fragments
 
-    my $child = $map_path_to_info->(get_api_definition(), $stack, $uri_param);
+    my $api = get_api_definition();
+
+    my $child = scalar(@$stack) ? $map_path_to_info->($api->{children}, $stack, $uri_param) : $api;
 
     if (!($child && $child->{info} && $child->{info}->{$method})) {
        return undef if $noerr;
@@ -172,10 +219,18 @@ sub complete_api_call_options {
     &$print_result(@option_list);
 }
 
+sub merge_api_definition_properties {
+    my ($path, $method, $properties) = @_;
+
+    my $info = PVE::APIClient::Helpers::find_method_info($path, $method);
+
+    return { %{$info->{parameters}->{properties}}, %$properties };
+}
+
 sub complete_api_path {
     my ($text) = @_;
 
-    get_api_definition(); # make sure API data is loaded
+    my $api = get_api_definition(); # make sure API data is loaded
 
     $text =~ s!^/!!;
 
@@ -184,10 +239,10 @@ sub complete_api_path {
     my $info;
     if (!defined($dir)) {
        $dir = '';
-       $info = { children => $pve_api_definition };
+       $info = $api;
     } else {
        my $stack = [ grep { length($_) > 0 }  split('\/+' , $dir)]; # skip empty fragments
-       $info = $map_path_to_info->($pve_api_definition, $stack, {});
+       $info = $map_path_to_info->($api->{children}, $stack, {});
     }
 
     my $res = [];
@@ -267,19 +322,42 @@ sub get_vmid_resource {
 }
 
 sub poll_task {
-    my ($conn, $node, $upid) = @_;
+    my ($conn, $node, $upid, $quiet) = @_;
 
     my $path = "api2/json/nodes/$node/tasks/$upid/status";
 
     my $task_status;
+    my $last_line = 0;
     while(1) {
+       if (!$quiet) {
+           my $path = "api2/json/nodes/$node/tasks/$upid/log";
+           my $task_log = $conn->get($path, {start => $last_line});
+
+           my $printme = '';
+           for my $li (@$task_log) {
+               if ($li->{t} eq 'no content') {
+                   next;
+               }
+               $printme .= $li->{t} . "\n";
+               $last_line = $li->{n};
+           }
+
+           if ($printme ne '') {
+               print $printme;
+           }
+       }
+
        $task_status = $conn->get($path, {});
 
        if ($task_status->{status} eq "stopped") {
            last;
        }
 
-       sleep(10);
+       sleep(2);
+    }
+
+    if ($task_status->{exitstatus} ne "OK") {
+       die $task_status->{exitstatus};
     }
 
     return $task_status->{exitstatus};