From 44a14fa90711f895bf2876be25710f13fb55770e Mon Sep 17 00:00:00 2001
From: Jakub Brzegowski <symfiz@gmail.com>
Date: Wed, 22 Nov 2023 15:23:05 +0100
Subject: [PATCH] IBX-7051: Preview button with siteaccess (#995)

---
 phpstan-baseline.neon                         |  5 --
 src/bundle/Controller/ContentController.php   | 11 +++
 src/bundle/Resources/config/routing.yaml      |  2 +
 .../translations/ibexa_menu.en.xliff          |  5 ++
 .../admin/content/content_preview.html.twig   | 19 ++++--
 src/lib/Menu/ContentRightSidebarBuilder.php   | 68 ++++++++++++++++++-
 .../ValueObjectVisitor/ContentTree/Node.php   |  6 ++
 src/lib/REST/Value/ContentTree/Node.php       | 16 +++++
 src/lib/UI/Module/ContentTree/NodeFactory.php | 47 ++++++++++++-
 9 files changed, 166 insertions(+), 13 deletions(-)

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
index c023bdaefe..49a85a07b8 100644
--- a/phpstan-baseline.neon
+++ b/phpstan-baseline.neon
@@ -9775,11 +9775,6 @@ parameters:
 			count: 1
 			path: src/lib/UI/Module/ContentTree/NodeFactory.php
 
-		-
-			message: "#^Parameter \\#9 \\$totalChildrenCount of class Ibexa\\\\AdminUi\\\\REST\\\\Value\\\\ContentTree\\\\Node constructor expects int, int\\|null given\\.$#"
-			count: 1
-			path: src/lib/UI/Module/ContentTree/NodeFactory.php
-
 		-
 			message: "#^Property Ibexa\\\\AdminUi\\\\UI\\\\Module\\\\ContentTree\\\\NodeFactory\\:\\:\\$bookmarkService is never read, only written\\.$#"
 			count: 1
diff --git a/src/bundle/Controller/ContentController.php b/src/bundle/Controller/ContentController.php
index 6dd9009c53..5352b23540 100644
--- a/src/bundle/Controller/ContentController.php
+++ b/src/bundle/Controller/ContentController.php
@@ -344,11 +344,14 @@ public function updateMainLocationAction(Request $request): Response
      * @return \Symfony\Component\HttpFoundation\Response
      */
     public function previewAction(
+        Request $request,
         Content $content,
         ?string $languageCode = null,
         ?int $versionNo = null,
         ?Location $location = null
     ): Response {
+        $preselectedSiteAccess = $request->query->get('preselectedSiteAccess');
+
         if (null === $languageCode) {
             $languageCode = $content->contentInfo->mainLanguageCode;
         }
@@ -379,12 +382,20 @@ public function previewAction(
             $siteAccessesList[$siteAccess->name] = $this->siteAccessNameGenerator->generate($siteAccess);
         }
 
+        if (
+            $preselectedSiteAccess !== null &&
+            !array_key_exists($preselectedSiteAccess, $siteAccessesList)
+        ) {
+            $preselectedSiteAccess = null;
+        }
+
         return $this->render('@ibexadesign/content/content_preview.html.twig', [
             'location' => $location,
             'content' => $content,
             'language_code' => $languageCode,
             'siteaccesses' => $siteAccessesList,
             'version_no' => $versionNo ?? $content->getVersionInfo()->versionNo,
+            'preselected_site_access' => $preselectedSiteAccess,
         ]);
     }
 
diff --git a/src/bundle/Resources/config/routing.yaml b/src/bundle/Resources/config/routing.yaml
index c847b35cb2..a93f27d90c 100644
--- a/src/bundle/Resources/config/routing.yaml
+++ b/src/bundle/Resources/config/routing.yaml
@@ -559,6 +559,8 @@ ibexa.content.preview:
         _controller: 'Ibexa\Bundle\AdminUi\Controller\ContentController::previewAction'
         languageCode: ~
         locationId: ~
+    options:
+        expose: true
 
 # IBX-1079: Translate routes with proxy suffix have to be prioritized to avoid issues with URL generations
 ibexa.content.translate.proxy:
diff --git a/src/bundle/Resources/translations/ibexa_menu.en.xliff b/src/bundle/Resources/translations/ibexa_menu.en.xliff
index 8d9f5d09af..2bbde169e5 100644
--- a/src/bundle/Resources/translations/ibexa_menu.en.xliff
+++ b/src/bundle/Resources/translations/ibexa_menu.en.xliff
@@ -46,6 +46,11 @@
         <target state="new">Move</target>
         <note>key: content__sidebar_right__move</note>
       </trans-unit>
+      <trans-unit id="e200a70bde86beb8c043e30b6fdb0a79e968c61c" resname="content__sidebar_right__preview">
+        <source>Preview</source>
+        <target state="new">Preview</target>
+        <note>key: content__sidebar_right__preview</note>
+      </trans-unit>
       <trans-unit id="bbf7b43821e5ac0ce57d977a3ce156baf9a9d7b7" resname="content__sidebar_right__reveal">
         <source>Reveal</source>
         <target state="new">Reveal</target>
diff --git a/src/bundle/Resources/views/themes/admin/content/content_preview.html.twig b/src/bundle/Resources/views/themes/admin/content/content_preview.html.twig
index 3e863ef8c0..bda6393db1 100644
--- a/src/bundle/Resources/views/themes/admin/content/content_preview.html.twig
+++ b/src/bundle/Resources/views/themes/admin/content/content_preview.html.twig
@@ -3,6 +3,7 @@
 {% trans_default_domain 'ibexa_content_preview' %}
 
 {% set is_published = content.contentInfo.published and content.contentInfo.mainLocationId is not null %}
+{% set preselected_site_access = preselected_site_access|default(siteaccesses|first) %}
 
 {% block body_class %}ibexa-content-preview{% endblock %}
 
@@ -23,25 +24,29 @@
         </div>
         <div class="ibexa-preview-header__item ibexa-preview-header__item--siteaccess">
             {% set value = '' %}
-            {% set choices = siteaccesses|map((site_accesses_name, site_access_label) => {
+            {% set choices = siteaccesses|map((site_access_name, site_access_label) => {
                 value: path(
                     'ibexa.version.preview',
                     {
                         'contentId': content.id,
                         'versionNo': version_no,
                         'language': language_code,
-                        'siteAccessName': site_accesses_name
+                        'siteAccessName': site_access_name
                     }
                 ),
-                label: site_access_label|trans({}, 'ezplatform_siteaccess')
+                label: site_access_label|trans({}, 'ezplatform_siteaccess'),
+                is_selected: site_access_name == preselected_site_access,
             }) %}
             {% set source %}
                 <select class="form-control ibexa-input">
                     {% for choice in choices %}
-                        {% if loop.first %}
+                        {% if choice.is_selected %}
                             {% set value = choice.value %}
                         {% endif %}
-                        <option value="{{ choice.value }}">
+                        <option
+                            value="{{ choice.value }}"
+                            {% if choice.is_selected %}selected{% endif %}
+                        >
                             {{ choice.label }}
                         </option>
                     {% endfor %}
@@ -78,7 +83,9 @@
 {% 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': siteaccesses|first}) }}" frameborder="0"></iframe>
+            <iframe src="{{ url('ibexa.version.preview', {
+                'contentId': content.id, 'versionNo': version_no, 'language': language_code, 'siteAccessName': preselected_site_access
+            }) }}" frameborder="0"></iframe>
         </div>
     </div>
 {% endblock %}
diff --git a/src/lib/Menu/ContentRightSidebarBuilder.php b/src/lib/Menu/ContentRightSidebarBuilder.php
index 520f4f02e2..d185ce84de 100644
--- a/src/lib/Menu/ContentRightSidebarBuilder.php
+++ b/src/lib/Menu/ContentRightSidebarBuilder.php
@@ -9,6 +9,7 @@
 namespace Ibexa\AdminUi\Menu;
 
 use Ibexa\AdminUi\Menu\Event\ConfigureMenuEvent;
+use Ibexa\AdminUi\Siteaccess\SiteaccessResolverInterface;
 use Ibexa\AdminUi\Specification\ContentType\ContentTypeIsUser;
 use Ibexa\AdminUi\Specification\ContentType\ContentTypeIsUserGroup;
 use Ibexa\AdminUi\Specification\Location\IsRoot;
@@ -21,6 +22,7 @@
 use Ibexa\Contracts\Core\Limitation\Target\Builder\VersionBuilder;
 use Ibexa\Contracts\Core\Repository\LocationService;
 use Ibexa\Contracts\Core\Repository\PermissionResolver;
+use Ibexa\Contracts\Core\Repository\Values\Content\Content;
 use Ibexa\Contracts\Core\Repository\Values\Content\Location;
 use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
 use JMS\TranslationBundle\Model\Message;
@@ -37,6 +39,7 @@ class ContentRightSidebarBuilder extends AbstractBuilder implements TranslationC
 {
     /* Menu items */
     public const ITEM__CREATE = 'content__sidebar_right__create';
+    public const ITEM__PREVIEW = 'content__sidebar_right__preview';
     public const ITEM__EDIT = 'content__sidebar_right__edit';
     public const ITEM__SEND_TO_TRASH = 'content__sidebar_right__send_to_trash';
     public const ITEM__COPY = 'content__sidebar_right__copy';
@@ -65,6 +68,8 @@ class ContentRightSidebarBuilder extends AbstractBuilder implements TranslationC
     /** @var \Ibexa\Contracts\AdminUi\Permission\PermissionCheckerInterface */
     private $permissionChecker;
 
+    private SiteaccessResolverInterface  $siteaccessResolver;
+
     public function __construct(
         MenuItemFactory $factory,
         EventDispatcherInterface $eventDispatcher,
@@ -73,7 +78,8 @@ public function __construct(
         ConfigResolverInterface $configResolver,
         LocationService $locationService,
         UniversalDiscoveryExtension $udwExtension,
-        PermissionCheckerInterface $permissionChecker
+        PermissionCheckerInterface $permissionChecker,
+        SiteaccessResolverInterface $siteaccessResolver
     ) {
         parent::__construct($factory, $eventDispatcher);
 
@@ -83,6 +89,7 @@ public function __construct(
         $this->locationService = $locationService;
         $this->udwExtension = $udwExtension;
         $this->permissionChecker = $permissionChecker;
+        $this->siteaccessResolver = $siteaccessResolver;
     }
 
     /**
@@ -193,6 +200,15 @@ public function createStructure(array $options): ItemInterface
             ),
         ]);
 
+        $previewItem = $this->getContentPreviewItem(
+            $location,
+            $content,
+            [
+                'extras' => ['orderNumber' => 12],
+            ],
+        );
+        $menu->addChild($previewItem);
+
         $canSendInvitation = $this->permissionResolver->canUser(
             'user',
             'invite',
@@ -301,6 +317,7 @@ public static function getTranslationMessages(): array
         return [
             (new Message(self::ITEM__CREATE, 'ibexa_menu'))->setDesc('Create content'),
             (new Message(self::ITEM__EDIT, 'ibexa_menu'))->setDesc('Edit'),
+            (new Message(self::ITEM__PREVIEW, 'ibexa_menu'))->setDesc('Preview'),
             (new Message(self::ITEM__SEND_TO_TRASH, 'ibexa_menu'))->setDesc('Send to trash'),
             (new Message(self::ITEM__COPY, 'ibexa_menu'))->setDesc('Copy'),
             (new Message(self::ITEM__COPY_SUBTREE, 'ibexa_menu'))->setDesc('Copy Subtree'),
@@ -443,6 +460,55 @@ private function getCopySubtreeLimit(): int
             'subtree_operations.copy_subtree.limit'
         );
     }
+
+    /**
+     * @param array<string, mixed> $options
+     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\BadStateException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
+     */
+    private function getContentPreviewItem(
+        Location $location,
+        Content $content,
+        array $options
+    ): ItemInterface {
+        $versionNo = $content->getVersionInfo()->versionNo;
+        $languageCode = $content->contentInfo->mainLanguageCode;
+
+        $siteAccesses = $this->siteaccessResolver->getSiteAccessesListForLocation(
+            $location,
+            $versionNo,
+            $languageCode
+        );
+
+        $canPreview = $this->permissionResolver->canUser(
+            'content',
+            'versionread',
+            $content,
+            [$location]
+        );
+
+        if ($canPreview && !empty($siteAccesses)) {
+            $actionOptions = [
+                'route' => 'ibexa.content.preview',
+                'routeParameters' => [
+                    'contentId' => $content->contentInfo->getId(),
+                    'versionNo' => $content->getVersionInfo()->versionNo,
+                    'languageCode' => $languageCode,
+                    'locationId' => $location->id,
+                ],
+            ];
+        } else {
+            $actionOptions = [
+                'attributes' => ['disabled' => 'disabled'],
+            ];
+        }
+
+        return $this->createMenuItem(
+            self::ITEM__PREVIEW,
+            array_merge($options, $actionOptions)
+        );
+    }
 }
 
 class_alias(ContentRightSidebarBuilder::class, 'EzSystems\EzPlatformAdminUi\Menu\ContentRightSidebarBuilder');
diff --git a/src/lib/REST/Output/ValueObjectVisitor/ContentTree/Node.php b/src/lib/REST/Output/ValueObjectVisitor/ContentTree/Node.php
index 327b69ecfa..80890d8bf3 100644
--- a/src/lib/REST/Output/ValueObjectVisitor/ContentTree/Node.php
+++ b/src/lib/REST/Output/ValueObjectVisitor/ContentTree/Node.php
@@ -34,6 +34,12 @@ public function visit(Visitor $visitor, Generator $generator, $data)
         $generator->startValueElement('contentId', $data->contentId);
         $generator->endValueElement('contentId');
 
+        $generator->valueElement('versionNo', $data->versionNo);
+
+        $generator->valueElement('translations', implode(',', $data->translations));
+
+        $generator->valueElement('previewableTranslations', implode(',', $data->previewableTranslations));
+
         $generator->startValueElement('name', $data->name);
         $generator->endValueElement('name');
 
diff --git a/src/lib/REST/Value/ContentTree/Node.php b/src/lib/REST/Value/ContentTree/Node.php
index c144b6cbfd..9e84736d03 100644
--- a/src/lib/REST/Value/ContentTree/Node.php
+++ b/src/lib/REST/Value/ContentTree/Node.php
@@ -21,6 +21,14 @@ class Node extends RestValue
     /** @var int */
     public $contentId;
 
+    public int $versionNo;
+
+    /** @var string[] */
+    public array $translations;
+
+    /** @var string[] */
+    public array $previewableTranslations;
+
     /** @var string */
     public $name;
 
@@ -50,6 +58,8 @@ class Node extends RestValue
      * @param int $depth
      * @param int $locationId
      * @param int $contentId
+     * @param string[] $translations
+     * @param string[] $previewableTranslations
      * @param string $name
      * @param string $contentTypeIdentifier
      * @param bool $isContainer
@@ -62,6 +72,9 @@ public function __construct(
         int $depth,
         int $locationId,
         int $contentId,
+        int $versionNo,
+        array $translations,
+        array $previewableTranslations,
         string $name,
         string $contentTypeIdentifier,
         bool $isContainer,
@@ -75,6 +88,9 @@ public function __construct(
         $this->depth = $depth;
         $this->locationId = $locationId;
         $this->contentId = $contentId;
+        $this->versionNo = $versionNo;
+        $this->translations = $translations;
+        $this->previewableTranslations = $previewableTranslations;
         $this->name = $name;
         $this->isInvisible = $isInvisible;
         $this->contentTypeIdentifier = $contentTypeIdentifier;
diff --git a/src/lib/UI/Module/ContentTree/NodeFactory.php b/src/lib/UI/Module/ContentTree/NodeFactory.php
index fda705617f..4bf00fe890 100644
--- a/src/lib/UI/Module/ContentTree/NodeFactory.php
+++ b/src/lib/UI/Module/ContentTree/NodeFactory.php
@@ -10,11 +10,13 @@
 
 use Ibexa\AdminUi\REST\Value\ContentTree\LoadSubtreeRequestNode;
 use Ibexa\AdminUi\REST\Value\ContentTree\Node;
+use Ibexa\AdminUi\Siteaccess\SiteaccessResolverInterface;
 use Ibexa\Contracts\Core\Repository\BookmarkService;
 use Ibexa\Contracts\Core\Repository\ContentService;
 use Ibexa\Contracts\Core\Repository\Exceptions\NotImplementedException;
 use Ibexa\Contracts\Core\Repository\PermissionResolver;
 use Ibexa\Contracts\Core\Repository\SearchService;
+use Ibexa\Contracts\Core\Repository\Values\Content\Content;
 use Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo;
 use Ibexa\Contracts\Core\Repository\Values\Content\Location;
 use Ibexa\Contracts\Core\Repository\Values\Content\LocationQuery;
@@ -57,6 +59,8 @@ final class NodeFactory
 
     private Repository $repository;
 
+    private SiteaccessResolverInterface  $siteaccessResolver;
+
     /** @var int */
     private $maxLocationIdsInSingleAggregation;
 
@@ -68,6 +72,7 @@ public function __construct(
         ConfigResolverInterface $configResolver,
         PermissionResolver $permissionResolver,
         Repository $repository,
+        SiteaccessResolverInterface $siteaccessResolver,
         int $maxLocationIdsInSingleAggregation
     ) {
         $this->bookmarkService = $bookmarkService;
@@ -77,6 +82,7 @@ public function __construct(
         $this->configResolver = $configResolver;
         $this->permissionResolver = $permissionResolver;
         $this->repository = $repository;
+        $this->siteaccessResolver = $siteaccessResolver;
         $this->maxLocationIdsInSingleAggregation = $maxLocationIdsInSingleAggregation;
     }
 
@@ -331,6 +337,9 @@ private function buildNode(
             $containerLocations[] = $location;
         }
 
+        $content = $location->getContent();
+        $versionInfo = $content->getVersionInfo();
+
         $limit = $this->resolveLoadLimit($loadSubtreeRequestNode);
         $offset = null !== $loadSubtreeRequestNode
             ? $loadSubtreeRequestNode->offset
@@ -340,7 +349,7 @@ private function buildNode(
         $children = [];
         if ($loadChildren && $depth < $this->getSetting('tree_max_depth')) {
             $searchResult = $this->findSubitems($location, $limit, $offset, $sortClause, $sortOrder);
-            $totalChildrenCount = $searchResult->totalCount;
+            $totalChildrenCount = (int) $searchResult->totalCount;
 
             /** @var \Ibexa\Contracts\Core\Repository\Values\Content\Location $childLocation */
             foreach (array_column($searchResult->searchHits, 'valueObject') as $childLocation) {
@@ -362,10 +371,19 @@ private function buildNode(
             }
         }
 
+        $translations = $versionInfo->languageCodes;
+        $previewableTranslations = array_filter(
+            $translations,
+            fn (string $languageCode): bool => $this->isPreviewable($location, $content, $languageCode)
+        );
+
         return new Node(
             $depth,
             $location->id,
             $location->contentId,
+            $versionInfo->versionNo,
+            $translations,
+            $previewableTranslations,
             '', // node name will be provided later by `supplyTranslatedContentName` method
             $contentType ? $contentType->identifier : '',
             $contentType ? $contentType->isContainer : true,
@@ -421,6 +439,33 @@ private function supplyChildrenCount(Node $node, ?array $aggregationResult = nul
             $this->supplyChildrenCount($child, $aggregationResult);
         }
     }
+
+    /**
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\BadStateException
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
+     */
+    private function isPreviewable(
+        Location $location,
+        Content $content,
+        string $languageCode
+    ): bool {
+        $versionNo = $content->getVersionInfo()->versionNo;
+
+        $siteAccesses = $this->siteaccessResolver->getSiteAccessesListForLocation(
+            $location,
+            $versionNo,
+            $languageCode
+        );
+
+        $canPreview = $this->permissionResolver->canUser(
+            'content',
+            'versionread',
+            $content,
+            [$location]
+        );
+
+        return $canPreview && !empty($siteAccesses);
+    }
 }
 
 class_alias(NodeFactory::class, 'EzSystems\EzPlatformAdminUi\UI\Module\ContentTree\NodeFactory');