PreviewUrlService.php

<?php
declare(strict_types=1);

/**
 * Pimcore
 *
 * This source file is available under two different licenses:
 * - GNU General Public License version 3 (GPLv3)
 * - Pimcore Commercial License (PCL)
 * Full copyright and license information is available in
 * LICENSE.md which is distributed with this source code.
 *
 *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
 *  @license    http://www.pimcore.org/license     GPLv3 and PCL
 */

namespace Pimcore\Bundle\StudioBackendBundle\DataObject\Service;

use Exception;
use Pimcore\Bundle\StaticResolverBundle\Models\Element\ServiceResolverInterface;
use Pimcore\Bundle\StudioBackendBundle\DataObject\MappedParameter\PreviewParameter;
use Pimcore\Bundle\StudioBackendBundle\Exception\Api\InvalidArgumentException;
use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
use Pimcore\Bundle\StudioBackendBundle\Util\Trait\RequestTrait;
use Pimcore\Model\DataObject\ClassDefinition\PreviewGeneratorInterface;
use Pimcore\Model\DataObject\Concrete;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * @interal
 */
final readonly class PreviewUrlService implements PreviewUrlServiceInterface
{
    use RequestTrait;

    public function __construct(
        private RequestStack $requestStack,
        private PreviewGeneratorInterface $defaultPreviewGenerator,
        private ServiceResolverInterface $serviceResolver
    ) {
    }

    /**
     * @throws Exception|NotFoundException
     */
    public function getPreviewUrl(PreviewParameter $previewParameter): string
    {
        $session = $this->getCurrentSession($this->requestStack);

        $dataObject = $this->serviceResolver->getElementFromSession(
            'object',
            $previewParameter->getId(),
            $session->getId()
        );

        if (!$dataObject instanceof Concrete) {
            throw new NotFoundException('Data Object', $previewParameter->getId());
        }

        $url = $this->getPreviewGenerator($dataObject)?->generatePreviewUrl(
            $dataObject,
            ['preview' => true, 'context' => $this]
        );

        if (!$url) {
            throw new InvalidArgumentException('Could not generate preview url');
        }

        return $this->buildRedirectUrl($url, $previewParameter);
    }

    /**
     * @throws Exception
     */
    private function getPreviewGenerator(Concrete $dataObject): ?PreviewGeneratorInterface
    {
        $previewService = $dataObject->getClass()->getPreviewGenerator();

        if (!$previewService && $dataObject->getClass()->getLinkGenerator()) {
            $previewService = $this->defaultPreviewGenerator;
        }

        return $previewService;
    }

    private function buildRedirectUrl(string $url, PreviewParameter $previewParameter): string
    {
        // replace all remaining % signs
        $url = str_replace('%', '%25', $url);
        $urlParts = parse_url($url);

        $redirectParameters = array_filter([
            'pimcore_object_preview' => $previewParameter->getId(),
            'site' => $previewParameter->getSite(),
            'dc' => time(),
        ]);

        $previewUrl = $urlParts['path'] . '?' . http_build_query($redirectParameters);

        if (isset($urlParts['query'])) {
            $previewUrl .= '&' . $urlParts['query'];
        }

        return $previewUrl;
    }
}