Added extension point to resolve preview URL (#1693)

* Added extension point to resolve preview URL
* Add unit tests for VersionPreviewUrlResolver
* Add unit tests for SystemVersionPreviewUrlSubscriber
* [PHPStan] Resolved phpstan issues
* Applied code review suggestions

Author: adamwojs

phpstan-baseline.neon

@@ -198,12 +198,6 @@ parameters:
 			count: 1
 			path: src/bundle/Controller/ContentController.php
 
-		-
-			message: '#^Parameter \#1 \$location of method Ibexa\\AdminUi\\Siteaccess\\SiteaccessResolverInterface\:\:getSiteAccessesListForLocation\(\) expects Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location, Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location\|false given\.$#'
-			identifier: argument.type
-			count: 1
-			path: src/bundle/Controller/ContentController.php
-
 		-
 			message: '#^Parameter \#1 \$locationId of method Ibexa\\Contracts\\Core\\Repository\\LocationService\:\:loadLocation\(\) expects int, int\|null given\.$#'
 			identifier: argument.type

src/bundle/Controller/ContentController.php

@@ -18,7 +18,7 @@
 use Ibexa\AdminUi\Form\Factory\FormFactory;
 use Ibexa\AdminUi\Form\SubmitHandler;
 use Ibexa\AdminUi\Form\Type\Content\Translation\MainTranslationUpdateType;
-use Ibexa\AdminUi\Form\Type\Preview\SiteAccessChoiceType;
+use Ibexa\AdminUi\Form\Type\Preview\VersionPreviewUrlChoiceType;
 use Ibexa\AdminUi\Permission\LookupLimitationsTransformer;
 use Ibexa\AdminUi\Siteaccess\SiteAccessNameGeneratorInterface;
 use Ibexa\AdminUi\Siteaccess\SiteaccessResolverInterface;
@@ -28,10 +28,12 @@
 use Ibexa\Contracts\AdminUi\Event\ContentEditEvent;
 use Ibexa\Contracts\AdminUi\Event\ContentProxyCreateEvent;
 use Ibexa\Contracts\AdminUi\Notification\TranslatableNotificationHandlerInterface;
+use Ibexa\Contracts\AdminUi\PreviewUrlResolver\VersionPreviewUrlResolverInterface;
 use Ibexa\Contracts\Core\Limitation\Target;
 use Ibexa\Contracts\Core\Repository\ContentService;
 use Ibexa\Contracts\Core\Repository\Exceptions as ApiException;
 use Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException;
+use Ibexa\Contracts\Core\Repository\LanguageService;
 use Ibexa\Contracts\Core\Repository\LocationService;
 use Ibexa\Contracts\Core\Repository\PermissionResolver;
 use Ibexa\Contracts\Core\Repository\UserService;
@@ -42,6 +44,7 @@
 use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
 use Ibexa\Core\Base\Exceptions\BadStateException;
 use Ibexa\Core\Helper\TranslationHelper;
+use Ibexa\Core\MVC\Symfony\SiteAccess\SiteAccessServiceInterface;
 use JMS\TranslationBundle\Annotation\Desc;
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -96,6 +99,12 @@ class ContentController extends Controller
 
     private FormFactoryInterface $baseFormFactory;
 
+    private VersionPreviewUrlResolverInterface $previewUrlResolver;
+
+    private LanguageService $languageService;
+
+    private SiteAccessServiceInterface $siteAccessService;
+
     public function __construct(
         TranslatableNotificationHandlerInterface $notificationHandler,
         ContentService $contentService,
@@ -111,7 +120,10 @@ public function __construct(
         ConfigResolverInterface $configResolver,
         SiteAccessNameGeneratorInterface $siteAccessNameGenerator,
         EventDispatcherInterface $eventDispatcher,
-        FormFactoryInterface $baseFormFactory
+        FormFactoryInterface $baseFormFactory,
+        VersionPreviewUrlResolverInterface $previewUrlResolver,
+        LanguageService $languageService,
+        SiteAccessServiceInterface $siteAccessService
     ) {
         $this->notificationHandler = $notificationHandler;
         $this->contentService = $contentService;
@@ -128,6 +140,9 @@ public function __construct(
         $this->siteAccessNameGenerator = $siteAccessNameGenerator;
         $this->eventDispatcher = $eventDispatcher;
         $this->baseFormFactory = $baseFormFactory;
+        $this->previewUrlResolver = $previewUrlResolver;
+        $this->languageService = $languageService;
+        $this->siteAccessService = $siteAccessService;
     }
 
     /**
@@ -386,12 +401,11 @@ public function previewAction(
             $versionNo = null;
         }
 
-        if (null === $location) {
+        if (!$location instanceof Location) {
             $location = $this->locationService->loadLocation($content->contentInfo->mainLocationId);
         }
 
         $siteAccesses = $this->siteaccessResolver->getSiteAccessesListForLocation($location, $versionNo, $languageCode);
-
         if (empty($siteAccesses)) {
             throw new BadStateException(
                 'siteaccess',
@@ -404,30 +418,28 @@ public function previewAction(
             $siteAccessesList[$siteAccess->name] = $this->siteAccessNameGenerator->generate($siteAccess);
         }
 
-        $preselectedSiteAccess = $request->query->get('preselectedSiteAccess', reset($siteAccessesList));
-
-        if (!array_key_exists($preselectedSiteAccess, $siteAccessesList)) {
-            $preselectedSiteAccess = reset($siteAccessesList);
+        $preselectedSiteAccessName = $request->query->get('preselectedSiteAccessName', reset($siteAccessesList));
+        if (!array_key_exists($preselectedSiteAccessName, $siteAccessesList)) {
+            $preselectedSiteAccessName = reset($siteAccessesList);
         }
 
-        $urlValue = $this->generateUrl(
-            'ibexa.version.preview',
-            [
-                'contentId' => $content->id,
-                'versionNo' => $versionNo ?? $content->getVersionInfo()->versionNo,
-                'language' => $languageCode,
-                'siteAccessName' => $preselectedSiteAccess,
-            ]
+        $versionInfo = $this->contentService->loadVersionInfo($content->getContentInfo(), $versionNo);
+        $language = $this->languageService->loadLanguage($languageCode);
+
+        $previewUrl = $this->previewUrlResolver->resolveUrl(
+            $versionInfo,
+            $location,
+            $language,
+            $this->siteAccessService->get($preselectedSiteAccessName)
         );
 
         $siteAccessSelector = $this->baseFormFactory->create(
-            SiteAccessChoiceType::class,
-            $urlValue,
+            VersionPreviewUrlChoiceType::class,
+            $previewUrl,
             [
                 'location' => $location,
-                'content' => $content,
-                'versionNo' => $versionNo ?? $content->getVersionInfo()->versionNo,
-                'languageCode' => $languageCode,
+                'version_info' => $versionInfo,
+                'language' => $language,
             ]
         );
 
@@ -438,8 +450,9 @@ public function previewAction(
             'siteaccesses' => $siteAccessesList,
             'site_access_form' => $siteAccessSelector->createView(),
             'version_no' => $versionNo ?? $content->getVersionInfo()->versionNo,
-            'preselected_site_access' => $preselectedSiteAccess,
+            'preselected_site_access' => $preselectedSiteAccessName,
             'referrer' => $referrer ?? 'content_draft_edit',
+            'preview_url' => $previewUrl,
         ]);
     }
 

src/bundle/Resources/config/services.yaml

@@ -26,6 +26,7 @@ imports:
     - { resource: services/user_settings.yaml }
     - { resource: services/rest.yaml }
     - { resource: services/permissions.yaml }
+    - { resource: services/preview.yaml }
     - { resource: services/forms.yaml }
     - { resource: services/strategies.yaml }
     - { resource: services/query_types.yaml }

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

@@ -424,4 +424,9 @@ services:
             $siteAccessResolver: '@Ibexa\AdminUi\Siteaccess\NonAdminSiteaccessResolver'
             $siteAccessNameGenerator: '@Ibexa\AdminUi\Siteaccess\SiteAccessNameGenerator'
 
+    Ibexa\AdminUi\Form\Type\Preview\VersionPreviewUrlChoiceType:
+        arguments:
+            $siteAccessResolver: '@Ibexa\AdminUi\Siteaccess\NonAdminSiteaccessResolver'
+            $siteAccessNameGenerator: '@Ibexa\AdminUi\Siteaccess\SiteAccessNameGenerator'
+
     Ibexa\AdminUi\Form\Type\LanguageSwitchType: ~

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

@@ -0,0 +1,10 @@
+services:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+        public: false
+
+    Ibexa\Contracts\AdminUi\PreviewUrlResolver\VersionPreviewUrlResolverInterface:
+        alias: Ibexa\AdminUi\PreviewUrlResolver\VersionPreviewUrlResolver
+
+    Ibexa\AdminUi\PreviewUrlResolver\VersionPreviewUrlResolver: ~

src/bundle/Resources/views/themes/admin/content/content_preview.html.twig

@@ -65,9 +65,7 @@
     {% block content %}
         <div class="ibexa-preview">
             <div class="ibexa-preview__iframe ibexa-preview__iframe--desktop">
-                <iframe src="{{ url('ibexa.version.preview', {
-                    'contentId': content.id, 'versionNo': version_no, 'language': language_code, 'siteAccessName': preselected_site_access
-                }) }}" frameborder="0"></iframe>
+                <iframe src="{{ preview_url }}" frameborder="0"></iframe>
             </div>
         </div>
     {% endblock %}

src/contracts/Event/ResolveVersionPreviewUrlEvent.php

@@ -0,0 +1,70 @@
+<?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\Contracts\AdminUi\Event;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Language;
+use Ibexa\Contracts\Core\Repository\Values\Content\Location;
+use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
+use Ibexa\Core\MVC\Symfony\SiteAccess;
+use Symfony\Contracts\EventDispatcher\Event;
+
+final class ResolveVersionPreviewUrlEvent extends Event
+{
+    private VersionInfo $versionInfo;
+
+    private Language $language;
+
+    private Location $location;
+
+    private SiteAccess $siteAccess;
+
+    private ?string $previewUrl = null;
+
+    public function __construct(
+        VersionInfo $versionInfo,
+        Language $language,
+        Location $location,
+        SiteAccess $siteAccess
+    ) {
+        $this->versionInfo = $versionInfo;
+        $this->language = $language;
+        $this->location = $location;
+        $this->siteAccess = $siteAccess;
+    }
+
+    public function getVersionInfo(): VersionInfo
+    {
+        return $this->versionInfo;
+    }
+
+    public function getLanguage(): Language
+    {
+        return $this->language;
+    }
+
+    public function getLocation(): Location
+    {
+        return $this->location;
+    }
+
+    public function getSiteAccess(): SiteAccess
+    {
+        return $this->siteAccess;
+    }
+
+    public function getPreviewUrl(): ?string
+    {
+        return $this->previewUrl;
+    }
+
+    public function setPreviewUrl(?string $previewUrl): void
+    {
+        $this->previewUrl = $previewUrl;
+    }
+}

src/contracts/Exception/UnresolvedPreviewUrlException.php

@@ -0,0 +1,16 @@
+<?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\Contracts\AdminUi\Exception;
+
+use Ibexa\Contracts\Core\Repository\Exceptions\Exception as RepositoryException;
+use RuntimeException;
+
+final class UnresolvedPreviewUrlException extends RuntimeException implements RepositoryException
+{
+}

src/contracts/PreviewUrlResolver/VersionPreviewUrlResolverInterface.php

@@ -0,0 +1,24 @@
+<?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\Contracts\AdminUi\PreviewUrlResolver;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Language;
+use Ibexa\Contracts\Core\Repository\Values\Content\Location;
+use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
+use Ibexa\Core\MVC\Symfony\SiteAccess;
+
+interface VersionPreviewUrlResolverInterface
+{
+    public function resolveUrl(
+        VersionInfo $versionInfo,
+        Location $location,
+        Language $language,
+        SiteAccess $siteAccess
+    ): string;
+}

src/lib/EventListener/SystemVersionPreviewUrlSubscriber.php

@@ -0,0 +1,50 @@
+<?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\EventListener;
+
+use Ibexa\Contracts\AdminUi\Event\ResolveVersionPreviewUrlEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+final class SystemVersionPreviewUrlSubscriber implements EventSubscriberInterface
+{
+    private UrlGeneratorInterface $urlGenerator;
+
+    public function __construct(UrlGeneratorInterface $urlGenerator)
+    {
+        $this->urlGenerator = $urlGenerator;
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            ResolveVersionPreviewUrlEvent::class => ['onResolveVersionPreviewUrl', -100],
+        ];
+    }
+
+    public function onResolveVersionPreviewUrl(ResolveVersionPreviewUrlEvent $event): void
+    {
+        if ($event->getPreviewUrl() !== null) {
+            // Do not override already set preview URL
+            return;
+        }
+
+        $previewUrl = $this->urlGenerator->generate(
+            'ibexa.version.preview',
+            [
+                'contentId' => $event->getVersionInfo()->getContentInfo()->getId(),
+                'versionNo' => $event->getVersionInfo()->getVersionNo(),
+                'language' => $event->getLanguage()->getLanguageCode(),
+                'siteAccessName' => $event->getSiteAccess()->name,
+            ],
+        );
+
+        $event->setPreviewUrl($previewUrl);
+    }
+}