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\AdminBundle\Controller;
use Pimcore\Bundle\AdminBundle\HttpFoundation\JsonResponse;
use Pimcore\Bundle\AdminBundle\Security\User\TokenStorageUserResolver;
use Pimcore\Bundle\AdminBundle\Security\User\User as UserProxy;
use Pimcore\Controller\Controller;
use Pimcore\Extension\Bundle\PimcoreBundleManager;
use Pimcore\Logger;
use Pimcore\Model\User;
use Symfony\Component\HttpKernel\Event\ControllerEvent;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\Serializer\Encoder\DecoderInterface;
use Symfony\Component\Serializer\SerializerInterface;
use Symfony\Component\Translation\Exception\InvalidArgumentException;
use Symfony\Contracts\Translation\TranslatorInterface;
abstract class AdminController extends Controller implements AdminControllerInterface
{
/**
* @var TokenStorageUserResolver
*/
protected $tokenResolver;
/**
* @var TranslatorInterface
*/
protected $translator;
/**
* @var PimcoreBundleManager
*/
protected $bundleManager;
/**
* @return string[]
*/
public static function getSubscribedServices()// : array
{
$services = parent::getSubscribedServices();
$services['translator'] = TranslatorInterface::class;
$services[TokenStorageUserResolver::class] = TokenStorageUserResolver::class;
$services[PimcoreBundleManager::class] = PimcoreBundleManager::class;
$services['pimcore_admin.serializer'] = '?Pimcore\\Admin\\Serializer';
return $services;
}
/**
* {@inheritdoc}
*/
public function needsSessionDoubleAuthenticationCheck()
{
return true;
}
/**
* {@inheritdoc}
*/
public function needsStorageDoubleAuthenticationCheck()
{
return true;
}
public function getTranslator()
{
return $this->container->get('translator');
}
public function getBundleManager()
{
return $this->container->get(PimcoreBundleManager::class);
}
public function getTokenResolver()
{
return $this->container->get(TokenStorageUserResolver::class);
}
/**
* Get user from user proxy object which is registered on security component
*
* @param bool $proxyUser Return the proxy user (UserInterface) instead of the pimcore model
*
* @return UserProxy|User|null
*/
protected function getAdminUser($proxyUser = false)
{
if ($proxyUser) {
return $this->getTokenResolver()->getUserProxy();
}
return $this->getTokenResolver()->getUser();
}
/**
* Check user permission
*
* @param string $permission
*
* @throws AccessDeniedHttpException
*/
protected function checkPermission($permission)
{
if (!$this->getAdminUser() || !$this->getAdminUser()->isAllowed($permission)) {
Logger::error(
'User {user} attempted to access {permission}, but has no permission to do so',
[
'user' => $this->getAdminUser()?->getName(),
'permission' => $permission,
]
);
throw $this->createAccessDeniedHttpException();
}
}
/**
* @param string $message
* @param \Throwable|null $previous
* @param int $code
* @param array $headers
*
* @return AccessDeniedHttpException
*/
protected function createAccessDeniedHttpException(string $message = 'Access Denied.', \Throwable $previous = null, int $code = 0, array $headers = []): AccessDeniedHttpException
{
// $headers parameter not supported by Symfony 3.4
return new AccessDeniedHttpException($message, $previous, $code, $headers);
}
/**
* @param string[] $permissions
*/
protected function checkPermissionsHasOneOf(array $permissions)
{
$allowed = false;
$permission = null;
foreach ($permissions as $permission) {
if ($this->getAdminUser()->isAllowed($permission)) {
$allowed = true;
break;
}
}
if (!$this->getAdminUser() || !$allowed) {
Logger::error(
'User {user} attempted to access {permission}, but has no permission to do so',
[
'user' => $this->getAdminUser()->getName(),
'permission' => $permission,
]
);
throw new AccessDeniedHttpException('Attempt to access ' . $permission . ', but has no permission to do so.');
}
}
/**
* Check permission against all controller actions. Can optionally exclude a list of actions.
*
* @param ControllerEvent $event
* @param string $permission
* @param array $unrestrictedActions
*/
protected function checkActionPermission(ControllerEvent $event, string $permission, array $unrestrictedActions = [])
{
$actionName = null;
$controller = $event->getController();
if (is_array($controller) && count($controller) === 2 && is_string($controller[1])) {
$actionName = $controller[1];
}
if (null === $actionName || !in_array($actionName, $unrestrictedActions)) {
$this->checkPermission($permission);
}
}
/**
* Encodes data into JSON string
*
* @param mixed $data The data to be encoded
* @param array $context Context to pass to serializer when using serializer component
* @param int $options Options passed to json_encode
* @param bool $useAdminSerializer
*
* @TODO check if $useAdminSerializer still required?
*
* @return string
*/
protected function encodeJson($data, array $context = [], $options = JsonResponse::DEFAULT_ENCODING_OPTIONS, bool $useAdminSerializer = true)
{
/** @var SerializerInterface $serializer */
$serializer = null;
if ($useAdminSerializer) {
$serializer = $this->container->get('pimcore_admin.serializer');
} else {
$serializer = $this->container->get('serializer');
}
return $serializer->serialize($data, 'json', array_merge([
'json_encode_options' => $options,
], $context));
}
/**
* Decodes a JSON string into an array/object
*
* @param mixed $json The data to be decoded
* @param bool $associative Whether to decode into associative array or object
* @param array $context Context to pass to serializer when using serializer component
* @param bool $useAdminSerializer
*
* @return mixed
*/
protected function decodeJson($json, $associative = true, array $context = [], bool $useAdminSerializer = true)
{
/** @var SerializerInterface|DecoderInterface $serializer */
$serializer = null;
if ($useAdminSerializer) {
$serializer = $this->container->get('pimcore_admin.serializer');
} else {
$serializer = $this->container->get('serializer');
}
if ($associative) {
$context['json_decode_associative'] = true;
}
return $serializer->decode($json, 'json', $context);
}
/**
* Returns a JsonResponse that uses the admin serializer
*
* @param mixed $data The response data
* @param int $status The status code to use for the Response
* @param array $headers Array of extra headers to add
* @param array $context Context to pass to serializer when using serializer component
* @param bool $useAdminSerializer
*
* @return JsonResponse
*/
protected function adminJson($data, $status = 200, $headers = [], $context = [], bool $useAdminSerializer = true)
{
$json = $this->encodeJson($data, $context, JsonResponse::DEFAULT_ENCODING_OPTIONS, $useAdminSerializer);
return new JsonResponse($json, $status, $headers, true);
}
/**
* Translates the given message.
*
* @param string $id The message id (may also be an object that can be cast to string)
* @param array $parameters An array of parameters for the message
* @param string|null $domain The domain for the message or null to use the default
* @param string|null $locale The locale or null to use the default
*
* @return string The translated string
*
* @throws InvalidArgumentException If the locale contains invalid characters
*/
public function trans($id, array $parameters = [], $domain = 'admin', $locale = null)
{
return $this->getTranslator()->trans($id, $parameters, $domain, $locale);
}
}

vendor/pimcore/pimcore/bundles/AdminBundle/Controller/AdminController.php line 262