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

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Bundle\AdminBundle\EventListener;
  18. use Pimcore\Bundle\AdminBundle\Security\User\TokenStorageUserResolver;
  19. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  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\RequestEvent;
  27. use Symfony\Component\HttpKernel\KernelEvents;
  29. /**
  30.  * @internal
  31.  */
  32. class UserPerspectiveListener implements EventSubscriberInterface, LoggerAwareInterface
  33. {
  34.     use LoggerAwareTrait;
  35.     use PimcoreContextAwareTrait;
  37.     /**
  38.      * @var TokenStorageUserResolver
  39.      */
  40.     protected $userResolver;
  42.     /**
  43.      * @param TokenStorageUserResolver $userResolver
  44.      */
  45.     public function __construct(TokenStorageUserResolver $userResolver)
  46.     {
  47.         $this->userResolver = $userResolver;
  48.     }
  50.     /**
  51.      * {@inheritdoc}
  52.      */
  53.     public static function getSubscribedEvents()
  54.     {
  55.         return [
  56.             KernelEvents::REQUEST => 'onKernelRequest',
  57.         ];
  58.     }
  60.     public function onKernelRequest(RequestEvent $event)
  61.     {
  62.         $request = $event->getRequest();
  64.         if (!$event->isMainRequest()) {
  65.             return;
  66.         }
  68.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_ADMIN)) {
  69.             return;
  70.         }
  72.         if ($user = $this->userResolver->getUser()) {
  73.             $this->setRequestedPerspective($user, $request);
  74.         }
  75.     }
  77.     /**
  78.      * @param User $user
  79.      * @param Request $request
  80.      */
  81.     protected function setRequestedPerspective(User $user, Request $request)
  82.     {
  83.         // update perspective settings
  84.         $requestedPerspective = $request->get('perspective');
  86.         if ($requestedPerspective) {
  87.             if ($requestedPerspective !== $user->getActivePerspective()) {
  88.                 $existingPerspectives = array_keys(\Pimcore\Perspective\Config::get()->toArray());
  89.                 if (!in_array($requestedPerspective, $existingPerspectives)) {
  90.                     $this->logger->warning('Requested perspective {perspective} for {user} does not exist.', [
  91.                         'user' => $user->getName(),
  92.                         'perspective' => $requestedPerspective,
  93.                     ]);
  95.                     $requestedPerspective = null;
  96.                 }
  97.             }
  98.         }
  100.         if (!$requestedPerspective || !$user->isAllowed($requestedPerspective, 'perspective')) {
  101.             $previouslyRequested = $requestedPerspective;
  103.             // choose active perspective or a first allowed
  104.             $requestedPerspective = $user->isAllowed($user->getActivePerspective(), 'perspective')
  105.                 ? $user->getActivePerspective()
  106.                 : $user->getFirstAllowedPerspective();
  108.             if ($previouslyRequested) {
  109.                 $this->logger->warning('User {user} is not allowed requested perspective {requestedPerspective}. Falling back to {perspective}.', [
  110.                     'user' => $user->getName(),
  111.                     'requestedPerspective' => $previouslyRequested,
  112.                     'perspective' => $requestedPerspective,
  113.                 ]);
  114.             } else {
  115.                 $this->logger->debug('Perspective for user {user} was not requested. Falling back to {perspective}.', [
  116.                     'user' => $user->getName(),
  117.                     'perspective' => $requestedPerspective,
  118.                 ]);
  119.             }
  120.         }
  122.         if ($requestedPerspective !== $user->getActivePerspective()) {
  123.             $this->logger->info('Setting active perspective for user {user} to {perspective}.', [
  124.                 'user' => $user->getName(),
  125.                 'perspective' => $requestedPerspective,
  126.             ]);
  128.             $user->setActivePerspective($requestedPerspective);
  129.             $user->save();
  130.         }
  131.     }
  132. }