Issues in AdminLocaleListener.php - All Issues - Inspection of "[AllBundles] Switch from styleci to flintci" - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 5.6 (#2830)

by Jeroen

created 2020-11-06 12:16 UTC

AdminBundle/EventListener/AdminLocaleListener.php (1 issue)

Labels

Severity

Minor 1

Jeroen Thora 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Kunstmaan\AdminBundle\EventListener;

use Kunstmaan\AdminBundle\Helper\AdminRouteHelper;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\HttpKernel\Event\ResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Translation\TranslatorInterface;

/**
 * AdminLocaleListener to override default locale if user-specific locale is set in database
 */
class AdminLocaleListener implements EventSubscriberInterface
{
    /**
     * @var TokenStorageInterface
     */
    private $tokenStorage;

    /**
     * @var TranslatorInterface
     */
    private $translator;

    /**
     * @var string
     */
    private $defaultAdminLocale;

    /**
     * @var string
     */
    private $providerKey;

    /**
     * @var AdminRouteHelper
     */
    private $adminRouteHelper;

    /**
     * @param string $defaultAdminLocale
     * @param string $providerKey        Firewall name to check against
     */
    public function __construct(TokenStorageInterface $tokenStorage, TranslatorInterface $translator, AdminRouteHelper $adminRouteHelper, $defaultAdminLocale, $providerKey = 'main')
    {
        $this->translator = $translator;
        $this->tokenStorage = $tokenStorage;
        $this->defaultAdminLocale = $defaultAdminLocale;
        $this->providerKey = $providerKey;
        $this->adminRouteHelper = $adminRouteHelper;
    }

    /**
     * onKernelRequest
     *
     * @param GetResponseEvent|ResponseEvent $event
     */
    public function onKernelRequest($event)
    {
        if (!$event instanceof GetResponseEvent && !$event instanceof ResponseEvent) {
            throw new \InvalidArgumentException(\sprintf('Expected instance of type %s, %s given', \class_exists(ResponseEvent::class) ? ResponseEvent::class : GetResponseEvent::class, \is_object($event) ? \get_class($event) : \gettype($event)));
        }

        $url = $event->getRequest()->getRequestUri();
        if (!$this->adminRouteHelper->isAdminRoute($url)) {
            return;
        }

        $token = $this->tokenStorage->getToken();
        if ($token && $this->isAdminToken($this->providerKey, $token)) {
            $locale = $token->getUser()->getAdminLocale();

            if (!$locale) {
                $locale = $this->defaultAdminLocale;
            }

            $this->translator->setLocale($locale);
        }
    }

    /**
     * @param TokenInterface $token
     * @param                $providerKey
     *
     * @return bool
     */
    private function isAdminToken($providerKey, TokenInterface $token = null)
    {
        return \is_callable([$token, 'getProviderKey']) && $token->getProviderKey() === $providerKey;
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * getSubscribedEvents
     */
    public static function getSubscribedEvents()
    {
        return [
            // The event subscriber must be registered after the Symfony FirewallListener so the user token is populated.
            KernelEvents::REQUEST => [['onKernelRequest', 5]],
        ];
    }
}


1			<?php
2
3			namespace Kunstmaan\AdminBundle\EventListener;
4
5			use Kunstmaan\AdminBundle\Helper\AdminRouteHelper;
6			use Symfony\Component\EventDispatcher\EventSubscriberInterface;
7			use Symfony\Component\HttpKernel\Event\GetResponseEvent;
8			use Symfony\Component\HttpKernel\Event\ResponseEvent;
9			use Symfony\Component\HttpKernel\KernelEvents;
10			use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
11			use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
12			use Symfony\Component\Translation\TranslatorInterface;
13
14			/**
15			* AdminLocaleListener to override default locale if user-specific locale is set in database
16			*/
17			class AdminLocaleListener implements EventSubscriberInterface
18			{
19			/**
20			* @var TokenStorageInterface
21			*/
22			private $tokenStorage;
23
24			/**
25			* @var TranslatorInterface
26			*/
27			private $translator;
28
29			/**
30			* @var string
31			*/
32			private $defaultAdminLocale;
33
34			/**
35			* @var string
36			*/
37			private $providerKey;
38
39			/**
40			* @var AdminRouteHelper
41			*/
42			private $adminRouteHelper;
43
44			/**
45			* @param string $defaultAdminLocale
46			* @param string $providerKey Firewall name to check against
47			*/
48	3		public function __construct(TokenStorageInterface $tokenStorage, TranslatorInterface $translator, AdminRouteHelper $adminRouteHelper, $defaultAdminLocale, $providerKey = 'main')
49			{
50	3		$this->translator = $translator;
51	3		$this->tokenStorage = $tokenStorage;
52	3		$this->defaultAdminLocale = $defaultAdminLocale;
53	3		$this->providerKey = $providerKey;
54	3		$this->adminRouteHelper = $adminRouteHelper;
55	3		}
56
57			/**
58			* onKernelRequest
59			*
60			* @param GetResponseEvent\|ResponseEvent $event
61			*/
62	3		public function onKernelRequest($event)
63			{
64	3	View Code Duplication	if (!$event instanceof GetResponseEvent && !$event instanceof ResponseEvent) {
65			throw new \InvalidArgumentException(\sprintf('Expected instance of type %s, %s given', \class_exists(ResponseEvent::class) ? ResponseEvent::class : GetResponseEvent::class, \is_object($event) ? \get_class($event) : \gettype($event)));
66			}
67
68	3		$url = $event->getRequest()->getRequestUri();
69	3		if (!$this->adminRouteHelper->isAdminRoute($url)) {
70	1		return;
71			}
72
73	2		$token = $this->tokenStorage->getToken();
74	2		if ($token && $this->isAdminToken($this->providerKey, $token)) {
75	2		$locale = $token->getUser()->getAdminLocale();
76
77	2		if (!$locale) {
78	2		$locale = $this->defaultAdminLocale;
79			}
80
81	2		$this->translator->setLocale($locale);
82			}
83	2		}
84
85			/**
86			* @param TokenInterface $token
87			* @param $providerKey
88			*
89			* @return bool
90			*/
91	2		private function isAdminToken($providerKey, TokenInterface $token = null)
92			{
93	2		return \is_callable([$token, 'getProviderKey']) && $token->getProviderKey() === $providerKey;
			0 ignored issues – show Bug introduced 2020-06-23 15:28 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Symfony\Component\Securi...on\Token\TokenInterface` as the method `getProviderKey()` does only exist in the following implementations of said interface: `Symfony\Component\Securi...n\PreAuthenticatedToken`, `Symfony\Component\Securi...n\PreAuthenticatedToken`, `Symfony\Component\Securi...n\Token\RememberMeToken`, `Symfony\Component\Securi...n\Token\RememberMeToken`, `Symfony\Component\Securi...n\Token\SwitchUserToken`, `Symfony\Component\Securi...n\Token\SwitchUserToken`, `Symfony\Component\Securi...n\UsernamePasswordToken`, `Symfony\Component\Securi...n\UsernamePasswordToken`, `Symfony\Component\Securi...uthenticationGuardToken`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
94			}
95
96			/**
97			* getSubscribedEvents
98			*/
99	6		public static function getSubscribedEvents()
100			{
101			return [
102			// The event subscriber must be registered after the Symfony FirewallListener so the user token is populated.
103	6		KernelEvents::REQUEST => [['onKernelRequest', 5]],
104			];
105			}
106			}
107

Kunstmaan / KunstmaanBundlesCMS

Pull Request — 5.6 (#2830)

AdminBundle/EventListener/AdminLocaleListener.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like