Symfony Profiler

<?php
/**
* 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\CoreBundle\EventListener\Frontend;
use Pimcore\Bundle\AdminBundle\Security\User\UserLoader;
use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
use Pimcore\Cache\RuntimeCache;
use Pimcore\Config;
use Pimcore\Http\Request\Resolver\DocumentResolver;
use Pimcore\Http\Request\Resolver\EditmodeResolver;
use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
use Pimcore\Http\RequestHelper;
use Pimcore\Model\DataObject\Service;
use Pimcore\Model\Document;
use Pimcore\Model\Staticroute;
use Pimcore\Model\User;
use Pimcore\Model\Version;
use Pimcore\Targeting\Document\DocumentTargetingConfigurator;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\ControllerEvent;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\HttpKernel\KernelEvents;
/**
* Handles element setup logic from request.
*
* @internal
*/
class ElementListener implements EventSubscriberInterface, LoggerAwareInterface
{
use LoggerAwareTrait;
use PimcoreContextAwareTrait;
public const FORCE_ALLOW_PROCESSING_UNPUBLISHED_ELEMENTS = '_force_allow_processing_unpublished_elements';
public function __construct(
protected DocumentResolver $documentResolver,
protected EditmodeResolver $editmodeResolver,
protected RequestHelper $requestHelper,
protected UserLoader $userLoader,
private DocumentTargetingConfigurator $targetingConfigurator,
private Config $config
) {
}
/**
* {@inheritdoc}
*/
public static function getSubscribedEvents(): array
{
return [
KernelEvents::CONTROLLER => ['onKernelController', 30], // has to be after DocumentFallbackListener
];
}
public function onKernelController(ControllerEvent $event)
{
if ($event->isMainRequest()) {
$request = $event->getRequest();
if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
return;
}
if ($request->attributes->get('_route') === 'fos_js_routing_js') {
return;
}
$document = $this->documentResolver->getDocument($request);
$adminRequest =
$this->requestHelper->isFrontendRequestByAdmin($request) ||
$this->requestHelper->isFrontendRequestByAdmin($this->requestHelper->getMainRequest());
$user = null;
if ($adminRequest) {
$user = $this->userLoader->getUser();
}
if ($document && !$document->isPublished() && !$user && !$request->attributes->get(self::FORCE_ALLOW_PROCESSING_UNPUBLISHED_ELEMENTS)) {
$this->logger->warning('Denying access to document {document} as it is unpublished and there is no user in the session.', [
$document->getFullPath(),
]);
if (
(
($request->get('object') && $request->get('urlSlug')) ||
$request->get('pimcore_request_source') == 'staticroute'
) &&
!$this->config['routing']['allow_processing_unpublished_fallback_document']
) {
trigger_deprecation(
'pimcore/pimcore',
'10.2',
'Blocking routes where the underlying fallback document is unpublished is deprecated and will be
removed in Pimcore 11. If you rely on this behavior please change your controllers accordingly and
set the config option `pimcore.routing.allow_processing_unpublished_fallback_document=true`'
);
}
throw new AccessDeniedHttpException(sprintf('Access denied for %s', $document->getFullPath()));
}
// editmode, pimcore_preview & pimcore_version
if ($user) {
$document = $this->handleAdminUserDocumentParams($request, $document, $user);
$this->handleObjectParams($request);
}
if ($document) {
// for public versions
$document = $this->handleVersion($request, $document);
// apply target group configuration
$this->applyTargetGroups($request, $document);
$this->documentResolver->setDocument($request, $document);
}
}
}
/**
* @param Request $request
* @param Document $document
*
* @return Document
*/
protected function handleVersion(Request $request, Document $document)
{
if ($v = $request->get('v')) {
if ($version = Version::getById((int) $v)) {
if ($version->getPublic()) {
$this->logger->info('Setting version to {version} for document {document}', [
'version' => $version->getId(),
'document' => $document->getFullPath(),
]);
$document = $version->getData();
}
} else {
$this->logger->notice('Failed to load {version} for document {document}', [
'version' => $request->get('v'),
'document' => $document->getFullPath(),
]);
}
}
return $document;
}
protected function applyTargetGroups(Request $request, Document $document)
{
if (!$document instanceof Document\Targeting\TargetingDocumentInterface || null !== Staticroute::getCurrentRoute()) {
return;
}
// reset because of preview and editmode (saved in session)
$document->setUseTargetGroup(null);
$this->targetingConfigurator->configureTargetGroup($document);
if ($document->getUseTargetGroup()) {
$this->logger->info('Setting target group to {targetGroup} for document {document}', [
'targetGroup' => $document->getUseTargetGroup(),
'document' => $document->getFullPath(),
]);
}
}
/**
* @param Request $request
* @param Document|null $document
* @param User $user
*
* @return Document|null
*/
private function handleAdminUserDocumentParams(Request $request, ?Document $document, User $user)
{
if (!$document) {
return null;
}
// editmode document
if ($this->editmodeResolver->isEditmode($request)) {
$document = $this->handleEditmode($document, $user);
}
// document preview
if ($request->get('pimcore_preview')) {
// get document from session
// TODO originally, this was the following call. What was in this->getParam('document') and
// why was it an object?
// $docKey = "document_" . $this->getParam("document")->getId();
if ($documentFromSession = Document\Service::getElementFromSession('document', $document->getId())) {
// if there is a document in the session use it
$this->logger->debug('Loading preview document {document} from session', [
'document' => $document->getFullPath(),
]);
$document = $documentFromSession;
}
}
// for version preview
if ($request->get('pimcore_version')) {
// TODO there was a check with a registry flag here - check if the master request handling is sufficient
$version = Version::getById((int) $request->get('pimcore_version'));
if ($documentVersion = $version?->getData()) {
$document = $documentVersion;
$this->logger->debug('Loading version {version} for document {document} from pimcore_version parameter', [
'version' => $version->getId(),
'document' => $document->getFullPath(),
]);
} else {
$this->logger->warning('Failed to load {version} for document {document} from pimcore_version parameter', [
'version' => $request->get('pimcore_version'),
'document' => $document->getFullPath(),
]);
throw new NotFoundHttpException(
sprintf('Failed to load %s for document %s from pimcore_version parameter',
$request->get('pimcore_version'), $document->getFullPath()));
}
}
return $document;
}
/**
* @param Document $document
* @param User $user
*
* @return Document
*/
protected function handleEditmode(Document $document, User $user)
{
// check if there is the document in the session
if ($documentFromSession = Document\Service::getElementFromSession('document', $document->getId())) {
// if there is a document in the session use it
$this->logger->debug('Loading editmode document {document} from session', [
'document' => $document->getFullPath(),
]);
$document = $documentFromSession;
} else {
$this->logger->debug('Loading editmode document {document} from latest version', [
'document' => $document->getFullPath(),
]);
// set the latest available version for editmode if there is no doc in the session
if ($document instanceof Document\PageSnippet) {
$latestVersion = $document->getLatestVersion($user->getId());
if ($latestVersion) {
$latestDoc = $latestVersion->loadData();
if ($latestDoc instanceof Document\PageSnippet) {
$document = $latestDoc;
}
}
}
}
return $document;
}
/**
* @param Request $request
*/
protected function handleObjectParams(Request $request)
{
// object preview
if ($objectId = $request->get('pimcore_object_preview')) {
if ($object = Service::getElementFromSession('object', $objectId)) {
$this->logger->debug('Loading object {object} ({objectId}) from session', [
'object' => $object->getFullPath(),
'objectId' => $object->getId(),
]);
// TODO remove \Pimcore\Cache\Runtime
// add the object to the registry so every call to DataObject::getById() will return this object instead of the real one
RuntimeCache::set('object_' . $object->getId(), $object);
}
}
}
}

vendor/pimcore/pimcore/bundles/CoreBundle/EventListener/Frontend/ElementListener.php line 73