vendor/pimcore/pimcore/bundles/AdminBundle/EventListener/UserPerspectiveListener.php line 57

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\EventListener;
  17. use Pimcore\Bundle\AdminBundle\Security\User\TokenStorageUserResolver;
  18. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  19. use Pimcore\Config;
  20. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  21. use Pimcore\Model\User;
  22. use Psr\Log\LoggerAwareInterface;
  23. use Psr\Log\LoggerAwareTrait;
  24. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  25. use Symfony\Component\HttpFoundation\Request;
  26. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  27. use Symfony\Component\HttpKernel\KernelEvents;
  29. class UserPerspectiveListener implements EventSubscriberInterface, LoggerAwareInterface
  30. {
  31.     use LoggerAwareTrait;
  32.     use PimcoreContextAwareTrait;
  34.     /**
  35.      * @var TokenStorageUserResolver
  36.      */
  37.     protected $userResolver;
  39.     /**
  40.      * @param TokenStorageUserResolver $userResolver
  41.      */
  42.     public function __construct(TokenStorageUserResolver $userResolver)
  43.     {
  44.         $this->userResolver = $userResolver;
  45.     }
  47.     /**
  48.      * @inheritDoc
  49.      */
  50.     public static function getSubscribedEvents()
  51.     {
  52.         return [
  53.             KernelEvents::REQUEST => 'onKernelRequest'
  54.         ];
  55.     }
  57.     public function onKernelRequest(GetResponseEvent $event)
  58.     {
  59.         $request = $event->getRequest();
  61.         if (!$event->isMasterRequest()) {
  62.             return;
  63.         }
  65.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_ADMIN)) {
  66.             return;
  67.         }
  69.         if ($user = $this->userResolver->getUser()) {
  70.             $this->setRequestedPerspective($user, $request);
  71.         }
  72.     }
  74.     /**
  75.      * @param User $user
  76.      * @param Request $request
  77.      */
  78.     protected function setRequestedPerspective(User $user, Request $request)
  79.     {
  80.         // update perspective settings
  81.         $requestedPerspective = $request->get('perspective');
  83.         if ($requestedPerspective) {
  84.             if ($requestedPerspective !== $user->getActivePerspective()) {
  85.                 $existingPerspectives = array_keys(Config::getPerspectivesConfig()->toArray());
  86.                 if (!in_array($requestedPerspective, $existingPerspectives)) {
  87.                     $this->logger->warning('Requested perspective {perspective} for {user} is not does not exist.', [
  88.                         'user' => $user->getName(),
  89.                         'perspective' => $requestedPerspective
  90.                     ]);
  92.                     $requestedPerspective = null;
  93.                 }
  94.             }
  95.         }
  97.         if (!$requestedPerspective || !$user->isAllowed($requestedPerspective, 'perspective')) {
  98.             $previouslyRequested = $requestedPerspective;
  100.             // choose active perspective or a first allowed
  101.             $requestedPerspective = $user->isAllowed($user->getActivePerspective(), 'perspective')
  102.                 ? $user->getActivePerspective()
  103.                 : $user->getFirstAllowedPerspective();
  105.             if (null !== $previouslyRequested) {
  106.                 $this->logger->warning('User {user} is not allowed requested perspective {requestedPerspective}. Falling back to {perspective}.', [
  107.                     'user' => $user->getName(),
  108.                     'requestedPerspective' => $previouslyRequested,
  109.                     'perspective' => $requestedPerspective
  110.                 ]);
  111.             } else {
  112.                 $this->logger->debug('Perspective for user {user} was not requested. Falling back to {perspective}.', [
  113.                     'user' => $user->getName(),
  114.                     'perspective' => $requestedPerspective
  115.                 ]);
  116.             }
  117.         }
  119.         if ($requestedPerspective !== $user->getActivePerspective()) {
  120.             $this->logger->info('Setting active perspective for user {user} to {perspective}.', [
  121.                 'user' => $user->getName(),
  122.                 'perspective' => $requestedPerspective
  123.             ]);
  125.             $user->setActivePerspective($requestedPerspective);
  126.             $user->save();
  127.         }
  128.     }
  129. }