IBX-9266: Added REST endpoint loading available site accesses for location

src/bundle/Controller/SiteAccess/SiteAccessController.php

@@ -0,0 +1,46 @@
+<?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\Bundle\AdminUi\Controller\SiteAccess;
+
+use Ibexa\AdminUi\REST\Value\SiteAccess\SiteAccessesList;
+use Ibexa\Contracts\Core\Repository\Values\Content\Location;
+use Ibexa\Rest\Server\Controller as RestController;
+use Ibexa\Rest\Server\Exceptions\BadRequestException;
+use Psr\Container\NotFoundExceptionInterface;
+use Symfony\Component\DependencyInjection\ServiceLocator;
+use Symfony\Component\HttpFoundation\Request;
+
+final class SiteAccessController extends RestController
+{
+    private ServiceLocator $siteAccessResolvers;
+
+    public function __construct(
+        ServiceLocator $siteAccessResolvers
+    ) {
+        $this->siteAccessResolvers = $siteAccessResolvers;
+    }
+
+    /**
+     * @throws \Psr\Container\ContainerExceptionInterface
+     * @throws \Psr\Container\NotFoundExceptionInterface
+     */
+    public function loadForLocation(Request $request, Location $location): SiteAccessesList
+    {
+        $resolverType = $request->query->get('resolver_type', 'non_admin');
+
+        try {
+            /** @var \Ibexa\AdminUi\Siteaccess\SiteaccessResolverInterface $siteAccessResolver */
+            $siteAccessResolver = $this->siteAccessResolvers->get($resolverType);
+        } catch (NotFoundExceptionInterface $e) {
+            throw new BadRequestException($e->getMessage(), $e->getCode(), $e);
+        }
+
+        return new SiteAccessesList($siteAccessResolver->getSiteAccessesListForLocation($location));
+    }
+}

src/bundle/Resources/config/routing_rest.yaml

@@ -137,3 +137,14 @@ ibexa.rest.content_type.load_field_definitions_from_expression:
     methods: [POST]
     options:
         expose: true
+
+#
+# Site Access
+#
+
+ibexa.rest.site_access.load_for_location:
+    path: /site-access/by-location/{locationId}
+    controller: 'Ibexa\Bundle\AdminUi\Controller\SiteAccess\SiteAccessController::loadForLocation'
+    methods: [GET]
+    options:
+        expose: true

src/bundle/Resources/config/services/controllers.yaml

@@ -265,3 +265,13 @@ services:
             $fieldsByExpressionService: '@Ibexa\Contracts\AdminUi\ContentType\ContentTypeFieldsByExpressionServiceInterface'
         tags:
             - controller.service_arguments
+
+    Ibexa\Bundle\AdminUi\Controller\SiteAccess\SiteAccessController:
+        parent: Ibexa\Rest\Server\Controller
+        autowire: true
+        arguments:
+            $siteAccessResolvers: !tagged_locator
+                tag: 'ibexa.site_access.resolver'
+                index_by: type
+        tags:
+            - controller.service_arguments

src/bundle/Resources/config/services/rest.yaml

@@ -108,3 +108,10 @@ services:
         parent: Ibexa\Contracts\Rest\Output\ValueObjectVisitor
         tags:
             - { name: ibexa.rest.output.value_object.visitor, type: Ibexa\AdminUi\REST\Value\ContentType\FieldDefinitionInfoList }
+    #
+    # Site Accesses
+    #
+    Ibexa\AdminUi\REST\Output\ValueObjectVisitor\SiteAccess\SiteAccessesListVisitor:
+        parent: Ibexa\Contracts\Rest\Output\ValueObjectVisitor
+        tags:
+            - { name: ibexa.rest.output.value_object.visitor, type: Ibexa\AdminUi\REST\Value\SiteAccess\SiteAccessesList }

src/bundle/Resources/config/services/siteaccess.yaml

@@ -18,6 +18,8 @@ services:
     Ibexa\AdminUi\Siteaccess\NonAdminSiteaccessResolver:
         arguments:
             $siteAccessGroups: '%ibexa.site_access.groups%'
+        tags:
+            - { name: 'ibexa.site_access.resolver', type: 'non_admin' }
 
     Ibexa\AdminUi\Siteaccess\AdminSiteaccessPreviewVoter:
         arguments:

src/lib/REST/Output/ValueObjectVisitor/SiteAccess/SiteAccessesListVisitor.php

@@ -0,0 +1,37 @@
+<?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\AdminUi\REST\Output\ValueObjectVisitor\SiteAccess;
+
+use Ibexa\Contracts\Rest\Output\Generator;
+use Ibexa\Contracts\Rest\Output\ValueObjectVisitor;
+use Ibexa\Contracts\Rest\Output\Visitor;
+
+final class SiteAccessesListVisitor extends ValueObjectVisitor
+{
+    /**
+     * @param \Ibexa\AdminUi\REST\Value\SiteAccess\SiteAccessesList $data
+     */
+    public function visit(Visitor $visitor, Generator $generator, $data): void
+    {
+        $generator->startObjectElement('SiteAccessesList');
+        $visitor->setHeader('Content-Type', $generator->getMediaType('SiteAccessesList'));
+
+        $generator->startList('values');
+        foreach ($data->getSiteAccesses() as $siteAccess) {
+            $generator->startObjectElement('SiteAccess');
+
+            $generator->valueElement('name', $siteAccess->name);
+
+            $generator->endObjectElement('SiteAccess');
+        }
+        $generator->endList('values');
+
+        $generator->endObjectElement('SiteAccessesList');
+    }
+}

src/lib/REST/Value/SiteAccess/SiteAccessesList.php

@@ -0,0 +1,33 @@
+<?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\AdminUi\REST\Value\SiteAccess;
+
+use Ibexa\Rest\Value as RestValue;
+
+final class SiteAccessesList extends RestValue
+{
+    /** @var \Ibexa\Core\MVC\Symfony\SiteAccess[] */
+    private array $siteAccesses;
+
+    /**
+     * @param \Ibexa\Core\MVC\Symfony\SiteAccess[] $siteAccesses
+     */
+    public function __construct(array $siteAccesses = [])
+    {
+        $this->siteAccesses = $siteAccesses;
+    }
+
+    /**
+     * @return \Ibexa\Core\MVC\Symfony\SiteAccess[]
+     */
+    public function getSiteAccesses(): array
+    {
+        return $this->siteAccesses;
+    }
+}

tests/integration/REST/GetSiteAccessesListTest.php

@@ -0,0 +1,57 @@
+<?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\Tests\Integration\AdminUi\REST;
+
+use Ibexa\Contracts\Test\Rest\Request\Value\EndpointRequestDefinition;
+
+/**
+ * Coverage for /site-access/by-location/{locationId} REST endpoint.
+ */
+final class GetSiteAccessesListTest extends BaseAdminUiRestWebTestCase
+{
+    /**
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\ForbiddenException
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        // to create a new user before logging-in via REST
+        $this->getIbexaTestCore()->setAdministratorUser();
+
+        $this->loginAsUser(
+            $this->createUserWithPolicies(
+                'editor',
+                [
+                    'user/login' => [],
+                    'content/read' => [],
+                    'content/versionread' => [],
+                ]
+            )
+        );
+    }
+
+    protected static function getEndpointsToTest(): iterable
+    {
+        foreach (self::REQUIRED_FORMATS as $format) {
+            yield new EndpointRequestDefinition(
+                'GET',
+                '/api/ibexa/v2/site-access/by-location/2?resolver_type=non_admin',
+                'SiteAccessesList',
+                "application/vnd.ibexa.api.SiteAccessesList+$format",
+                ['HTTP_X-SiteAccess' => 'admin'],
+                null,
+                null,
+                'SiteAccessesList'
+            );
+        }
+    }
+}

tests/integration/Resources/REST/Schemas/SiteAccessesList.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "SiteAccessesList": {
+      "type": "object",
+      "properties": {
+        "_media-type": {
+          "type": "string"
+        },
+        "values": {
+          "type": "array",
+          "items": [
+            {
+              "type": "object",
+              "properties": {
+                "_media-type": {
+                  "type": "string"
+                },
+                "name": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "_media-type",
+                "name"
+              ]
+            }
+          ]
+        }
+      },
+      "required": [
+        "_media-type",
+        "values"
+      ]
+    }
+  },
+  "required": [
+    "SiteAccessesList"
+  ]
+}

tests/integration/Resources/REST/Schemas/SiteAccessesList.xsd

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
+    <xs:element name="SiteAccessesList">
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element name="SiteAccess" maxOccurs="unbounded" minOccurs="0">
+                    <xs:complexType>
+                        <xs:sequence>
+                            <xs:element name="name" type="xs:string" />
+                        </xs:sequence>
+                        <xs:attribute name="media-type" type="xs:string" use="required" />
+                    </xs:complexType>
+                </xs:element>
+            </xs:sequence>
+            <xs:attribute name="media-type" type="xs:string" use="required" />
+        </xs:complexType>
+    </xs:element>
+</xs:schema>

tests/integration/Resources/REST/Snapshots/SiteAccessesList.json

@@ -0,0 +1,27 @@
+{
+  "SiteAccessesList": {
+    "_media-type": "application/vnd.ibexa.api.SiteAccessesList+json",
+    "values": [
+      {
+        "_media-type": "application/vnd.ibexa.api.SiteAccess+json",
+        "name": "__default_site_access__"
+      },
+      {
+        "_media-type": "application/vnd.ibexa.api.SiteAccess+json",
+        "name": "__second_site_access__"
+      },
+      {
+        "_media-type": "application/vnd.ibexa.api.SiteAccess+json",
+        "name": "ger"
+      },
+      {
+        "_media-type": "application/vnd.ibexa.api.SiteAccess+json",
+        "name": "eng"
+      },
+      {
+        "_media-type": "application/vnd.ibexa.api.SiteAccess+json",
+        "name": "ku6\"H"
+      }
+    ]
+  }
+}

tests/integration/Resources/REST/Snapshots/SiteAccessesList.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SiteAccessesList media-type="application/vnd.ibexa.api.SiteAccessesList+xml">
+    <SiteAccess media-type="application/vnd.ibexa.api.SiteAccess+xml">
+        <name>__default_site_access__</name>
+    </SiteAccess>
+    <SiteAccess media-type="application/vnd.ibexa.api.SiteAccess+xml">
+        <name>__second_site_access__</name>
+    </SiteAccess>
+    <SiteAccess media-type="application/vnd.ibexa.api.SiteAccess+xml">
+        <name>ger</name>
+    </SiteAccess>
+    <SiteAccess media-type="application/vnd.ibexa.api.SiteAccess+xml">
+        <name>eng</name>
+    </SiteAccess>
+    <SiteAccess media-type="application/vnd.ibexa.api.SiteAccess+xml">
+        <name>ku6&quot;H</name>
+    </SiteAccess>
+</SiteAccessesList>