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

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Enterprise License (PEL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  12.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  13.  */
  15. namespace Pimcore\Bundle\AdminBundle\Controller;
  17. use Pimcore\Bundle\AdminBundle\HttpFoundation\JsonResponse;
  18. use Pimcore\Bundle\AdminBundle\Security\CsrfProtectionHandler;
  19. use Pimcore\Bundle\AdminBundle\Security\User\TokenStorageUserResolver;
  20. use Pimcore\Bundle\AdminBundle\Security\User\User as UserProxy;
  21. use Pimcore\Controller\Controller;
  22. use Pimcore\Model\User;
  23. use Symfony\Component\HttpFoundation\Request;
  24. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  25. use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
  26. use Symfony\Component\Serializer\Encoder\DecoderInterface;
  27. use Symfony\Component\Serializer\SerializerInterface;
  28. use Symfony\Component\Translation\Exception\InvalidArgumentException;
  30. abstract class AdminController extends Controller implements AdminControllerInterface
  31. {
  32.     /**
  33.      * @inheritDoc
  34.      */
  35.     public function needsSessionDoubleAuthenticationCheck()
  36.     {
  37.         return true;
  38.     }
  40.     /**
  41.      * @inheritDoc
  42.      */
  43.     public function needsStorageDoubleAuthenticationCheck()
  44.     {
  45.         return true;
  46.     }
  48.     /**
  49.      * Get user from user proxy object which is registered on security component
  50.      *
  51.      * @param bool $proxyUser Return the proxy user (UserInterface) instead of the pimcore model
  52.      *
  53.      * @return UserProxy|User
  54.      */
  55.     protected function getAdminUser($proxyUser = false)
  56.     {
  57.         $resolver = $this->get(TokenStorageUserResolver::class);
  59.         if ($proxyUser) {
  60.             return $resolver->getUserProxy();
  61.         } else {
  62.             return $resolver->getUser();
  63.         }
  64.     }
  66.     /**
  67.      * Check user permission
  68.      *
  69.      * @param string $permission
  70.      *
  71.      * @throws AccessDeniedHttpException
  72.      */
  73.     protected function checkPermission($permission)
  74.     {
  75.         if (!$this->getAdminUser() || !$this->getAdminUser()->isAllowed($permission)) {
  76.             $this->get('monolog.logger.security')->error(
  77.                 'User {user} attempted to access {permission}, but has no permission to do so',
  78.                 [
  79.                     'user' => $this->getAdminUser()->getName(),
  80.                     'permission' => $permission,
  81.                 ]
  82.             );
  84.             throw $this->createAccessDeniedHttpException();
  85.         }
  86.     }
  88.     /**
  89.      * @param string $message
  90.      * @param \Throwable|null $previous
  91.      * @param int $code
  92.      * @param array $headers
  93.      *
  94.      * @return AccessDeniedHttpException
  95.      */
  96.     protected function createAccessDeniedHttpException(string $message = 'Access Denied.', \Throwable $previous = null, int $code = 0, array $headers = []): AccessDeniedHttpException
  97.     {
  98.         // $headers parameter not supported by Symfony 3.4
  99.         return new AccessDeniedHttpException($message, $previous, $code);
  100.     }
  102.     /**
  103.      * @param string[] $permissions
  104.      */
  105.     protected function checkPermissionsHasOneOf(array $permissions)
  106.     {
  107.         $allowed = false;
  108.         $permission = null;
  109.         foreach ($permissions as $permission) {
  110.             if ($this->getAdminUser()->isAllowed($permission)) {
  111.                 $allowed = true;
  112.                 break;
  113.             }
  114.         }
  116.         if (!$this->getAdminUser() || !$allowed) {
  117.             $this->get('monolog.logger.security')->error(
  118.                 'User {user} attempted to access {permission}, but has no permission to do so',
  119.                 [
  120.                     'user' => $this->getAdminUser()->getName(),
  121.                     'permission' => $permission,
  122.                 ]
  123.             );
  125.             throw new AccessDeniedHttpException('Attempt to access ' . $permission . ', but has no permission to do so.');
  126.         }
  127.     }
  129.     /**
  130.      * Check permission against all controller actions. Can optionally exclude a list of actions.
  131.      *
  132.      * @param FilterControllerEvent $event
  133.      * @param string $permission
  134.      * @param array $unrestrictedActions
  135.      */
  136.     protected function checkActionPermission(FilterControllerEvent $event, string $permission, array $unrestrictedActions = [])
  137.     {
  138.         $actionName = null;
  139.         $controller = $event->getController();
  141.         if (is_array($controller) && count($controller) === 2 && is_string($controller[1])) {
  142.             $actionName = $controller[1];
  143.         }
  145.         if (null === $actionName || !in_array($actionName, $unrestrictedActions)) {
  146.             $this->checkPermission($permission);
  147.         }
  148.     }
  150.     /**
  151.      * Encodes data into JSON string
  152.      *
  153.      * @param mixed $data    The data to be encoded
  154.      * @param array $context Context to pass to serializer when using serializer component
  155.      * @param int $options   Options passed to json_encode
  156.      * @param bool $useAdminSerializer
  157.      *
  158.      * @return string
  159.      */
  160.     protected function encodeJson($data, array $context = [], $options = JsonResponse::DEFAULT_ENCODING_OPTIONS, bool $useAdminSerializer = true)
  161.     {
  162.         /** @var SerializerInterface $serializer */
  163.         $serializer = null;
  165.         if ($useAdminSerializer) {
  166.             $serializer = $this->container->get('pimcore_admin.serializer');
  167.         } else {
  168.             $serializer = $this->container->get('serializer');
  169.         }
  171.         return $serializer->serialize($data, 'json', array_merge([
  172.             'json_encode_options' => $options,
  173.         ], $context));
  174.     }
  176.     /**
  177.      * Decodes a JSON string into an array/object
  178.      *
  179.      * @param mixed $json       The data to be decoded
  180.      * @param bool $associative Whether to decode into associative array or object
  181.      * @param array $context    Context to pass to serializer when using serializer component
  182.      * @param bool $useAdminSerializer
  183.      *
  184.      * @return mixed
  185.      */
  186.     protected function decodeJson($json, $associative = true, array $context = [], bool $useAdminSerializer = true)
  187.     {
  188.         /** @var SerializerInterface|DecoderInterface $serializer */
  189.         $serializer = null;
  191.         if ($useAdminSerializer) {
  192.             $serializer = $this->container->get('pimcore_admin.serializer');
  193.         } else {
  194.             $serializer = $this->container->get('serializer');
  195.         }
  197.         if ($associative) {
  198.             $context['json_decode_associative'] = true;
  199.         }
  201.         return $serializer->decode($json, 'json', $context);
  202.     }
  204.     /**
  205.      * Returns a JsonResponse that uses the admin serializer
  206.      *
  207.      * @param mixed $data    The response data
  208.      * @param int $status    The status code to use for the Response
  209.      * @param array $headers Array of extra headers to add
  210.      * @param array $context Context to pass to serializer when using serializer component
  211.      * @param bool $useAdminSerializer
  212.      *
  213.      * @return JsonResponse
  214.      */
  215.     protected function adminJson($data, $status = 200, $headers = [], $context = [], bool $useAdminSerializer = true)
  216.     {
  217.         $json = $this->encodeJson($data, $context, JsonResponse::DEFAULT_ENCODING_OPTIONS, $useAdminSerializer);
  219.         return new JsonResponse($json, $status, $headers, true);
  220.     }
  222.     /**
  223.      * Translates the given message.
  224.      *
  225.      * @param string $id The message id (may also be an object that can be cast to string)
  226.      * @param array $parameters An array of parameters for the message
  227.      * @param string|null $domain The domain for the message or null to use the default
  228.      * @param string|null $locale The locale or null to use the default
  229.      *
  230.      * @return string The translated string
  231.      *
  232.      * @throws InvalidArgumentException If the locale contains invalid characters
  233.      */
  234.     public function trans($id, array $parameters = [], $domain = 'admin', $locale = null)
  235.     {
  236.         $translator = $this->get('translator');
  238.         return $translator->trans($id, $parameters, $domain, $locale);
  239.     }
  241.     /**
  242.      * @param Request $request
  243.      *
  244.      * @deprecated
  245.      */
  246.     public function checkCsrfToken(Request $request)
  247.     {
  248.         @trigger_error(sprintf('Calling '.__METHOD__.' is deprecated since version 6.9.0 and will be removed in Pimcore 10. ' .
  249.             'Use %s service instead.', CsrfProtectionHandler::class), E_USER_DEPRECATED);
  251.         $csrfCheck = $this->container->get('Pimcore\Bundle\AdminBundle\EventListener\CsrfProtectionListener');
  252.         $csrfCheck->checkCsrfToken($request);
  253.     }
  254. }