IBX-8172: OpenAPI compatible location copy endpoint

#110

Author: barw4

src/bundle/Resources/config/input_parsers.yml

@@ -890,3 +890,11 @@ services:
             $validator: '@validator'
         tags:
             - { name: ibexa.rest.input.parser, mediaType: application/vnd.ibexa.api.MoveUserGroupInput }
+
+    Ibexa\Rest\Server\Input\Parser\CopyLocationInput:
+        parent: Ibexa\Rest\Server\Common\Parser
+        arguments:
+            $locationService: '@ibexa.api.service.location'
+            $validator: '@validator'
+        tags:
+            - { name: ibexa.rest.input.parser, mediaType: application/vnd.ibexa.api.CopyLocationInput }

src/bundle/Resources/config/routing.yml

@@ -432,6 +432,16 @@ ibexa.rest.languages.view:
 
 # Locations
 
+ibexa.rest.location.copy:
+    path: /content/locations/{locationPath}
+    controller: Ibexa\Rest\Server\Controller\Location::copy
+    condition: 'ibexa_get_media_type(request) === "CopyLocationInput"'
+    methods: [POST]
+    options:
+        options_route_suffix: 'CopyLocationInput'
+    requirements:
+        locationPath: "[0-9/]+"
+
 ibexa.rest.trash_location:
     path: /content/locations/{locationPath}
     controller: Ibexa\Rest\Server\Controller\Trash::trashLocation

src/lib/Server/Controller/Location.php

@@ -212,6 +212,34 @@ public function copySubtree($locationPath, Request $request)
         );
     }
 
+    /**
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
+     */
+    public function copy(string $locationPath, Request $request): Values\ResourceCreated
+    {
+        $locationId = $this->extractLocationIdFromPath($locationPath);
+        $location = $this->locationService->loadLocation($locationId);
+
+        $destinationLocation = $this->inputDispatcher->parse(
+            new Message(
+                ['Content-Type' => $request->headers->get('Content-Type')],
+                $request->getContent(),
+            ),
+        );
+
+        $newLocation = $this->locationService->copySubtree($location, $destinationLocation);
+
+        return new Values\ResourceCreated(
+            $this->router->generate(
+                'ibexa.rest.load_location',
+                [
+                    'locationPath' => trim($newLocation->pathString, '/'),
+                ],
+            )
+        );
+    }
+
     /**
      * Moves a subtree to a new location.
      *

src/lib/Server/Input/Parser/CopyLocationInput.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Rest\Server\Input\Parser;
+
+use Ibexa\Rest\Server\Validation\Builder\Input\Parser\BaseInputParserValidatorBuilder;
+use Ibexa\Rest\Server\Validation\Builder\Input\Parser\CopyLocationInputValidatorBuilder;
+
+final class CopyLocationInput extends AbstractDestinationLocationParser
+{
+    protected const string PARSER = 'CopyLocationInput';
+
+    protected function getValidatorBuilder(): BaseInputParserValidatorBuilder
+    {
+        return new CopyLocationInputValidatorBuilder($this->validator);
+    }
+}

src/lib/Server/Validation/Builder/Input/Parser/CopyLocationInputValidatorBuilder.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Rest\Server\Validation\Builder\Input\Parser;
+
+use Ibexa\Rest\Server\Input\Parser\CopyLocationInput;
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Constraints as Assert;
+
+final class CopyLocationInputValidatorBuilder extends BaseInputParserValidatorBuilder
+{
+    protected function buildConstraint(): Constraint
+    {
+        return new Assert\Collection(
+            [
+                CopyLocationInput::DESTINATION_KEY => [
+                    new Assert\NotBlank(),
+                    new Assert\Type('string'),
+                    new Assert\Regex('/^(\/\d+)+$/'),
+                ],
+            ],
+        );
+    }
+}

tests/bundle/Functional/HttpOptionsTest.php

@@ -80,6 +80,7 @@ public function providerForTestHttpOptions(): array
             ['/content/objectstategroups/1/objectstates/1', ['GET', 'PATCH', 'DELETE']],
             ['/content/objects/1/objectstates', ['GET', 'PATCH']],
             ['/content/locations', ['GET']],
+            ['/content/locations/1/2', ['POST'], 'CopyLocationInput+json'],
             ['/content/locations/1/2', ['POST'], 'MoveLocationInput+json'],
             ['/content/locations/1/2', ['POST'], 'SwapLocationInput+json'],
             ['/content/locations/1/2', ['GET', 'PATCH', 'DELETE', 'COPY', 'MOVE', 'SWAP']],

tests/bundle/Functional/LocationTest.php

@@ -333,4 +333,23 @@ public function testSwap(string $locationHref): void
 
         self::assertHttpResponseCodeEquals($response, 204);
     }
+
+    /**
+     * @depends testMoveLocation
+     */
+    public function testCopy(string $locationHref): void
+    {
+        $request = $this->createHttpRequest(
+            'POST',
+            $locationHref,
+            'CopyLocationInput+json',
+            '',
+            json_encode(['CopyLocationInput' => ['destination' => '/1/2']]) ?: '',
+        );
+
+        $response = $this->sendHttpRequest($request);
+
+        self::assertHttpResponseCodeEquals($response, 201);
+        self::assertHttpResponseHasHeader($response, 'Location');
+    }
 }

tests/bundle/Functional/SearchView/Criterion/IsContainerTest.php

@@ -28,7 +28,7 @@ public function getCriteriaPayloads(): iterable
             'is container' => [
                 'json',
                 $this->buildJsonCriterionQuery('"IsContainerCriterion": true'),
-                12,
+                13,
             ],
             'is not container' => [
                 'json',

tests/bundle/Functional/SearchView/Criterion/IsUserBasedTest.php

@@ -23,7 +23,7 @@ public function getCriteriaPayloads(): iterable
             'is not user based' => [
                 'json',
                 $this->buildJsonCriterionQuery('"IsUserBasedCriterion": false'),
-                12,
+                13,
             ],
         ];
     }

tests/bundle/Functional/SearchView/Criterion/ObjectStateIdentifierTest.php

@@ -18,12 +18,12 @@ public function getCriteriaPayloads(): iterable
             'identifier with target group' => [
                 'json',
                 $this->buildJsonCriterionQuery('"ObjectStateIdentifierCriterion": {"value": "not_locked", "target": "ez_lock"}'),
-                14,
+                15,
             ],
             'identifier without target group' => [
                 'json',
                 $this->buildJsonCriterionQuery('"ObjectStateIdentifierCriterion": {"value": "not_locked", "target": null}'),
-                14,
+                15,
             ],
         ];
     }