src/EventListener/ForceRoute/AbstractForceRouteListener.php line 39

Open in your IDE?
  1. <?php
  2. namespace App\EventListener\ForceRoute;
  4. use Symfony\Component\HttpFoundation\RedirectResponse;
  5. use Symfony\Component\HttpFoundation\Request;
  7. use Symfony\Component\HttpKernel\Event\RequestEvent;
  8. use Symfony\Component\Routing\Exception\ResourceNotFoundException;
  9. use Symfony\Component\Routing\RouterInterface;
  10. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  11. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  12. use Symfony\Component\Security\Core\User\UserInterface;
  15. abstract class AbstractForceRouteListener implements ForceRouteListenerInterface{
  16.     const MODE_REJECT_ROUTES = 'mode_reject_routes';
  17.     const MODE_ALLOW_ROUTES = 'mode_allow_routes';
  19.     protected RouterInterface $router;
  21.     protected TokenStorageInterface $tokenStorage;
  23.     protected AuthorizationCheckerInterface $authorizationChecker;
  24.     protected string $environment;
  25.     protected RequestEvent $event;
  27.     public function __construct(
  28.         RouterInterface $router,
  29.         TokenStorageInterface $tokenStorage,
  30.         AuthorizationCheckerInterface $authorizationChecker,
  31.         string $environment
  32.     ){
  33.         $this->router = $router;
  34.         $this->tokenStorage = $tokenStorage;
  35.         $this->authorizationChecker = $authorizationChecker;
  36.         $this->environment = $environment;
  37.     }
  39.     public function onCheckExpired(RequestEvent $event): void {
  40.         $this->event = $event;
  41.         $request = $event->getRequest();
  43.         // Force the route if we are not using the test environments nor if the route is authorized
  44.         if(
  45.             $this->environment !== 'test'
  46.             && !$this->isRequestedRouteAllowed($request)
  47.             && $this->mustForceRoute($request)
  48.         ){
  49.             $response = new RedirectResponse(
  50.                 $this->router->generate(
  51.                     $this->getRouteToForce(),
  52.                     $this->getRouteParametersToForce()
  53.                 )
  54.             );
  55.             $event->setResponse($response);
  56.         }
  57.     }
  59.     /**
  60.      * Get the requested route name
  61.      * @param Request $request
  62.      * @return string
  63.      */
  64.     public function getRequestedRouteName(Request $request): string {
  65.         $pathInfo = $request->getPathInfo();
  66.         try{
  67.             $route = $this->router->match($pathInfo);
  68.         }catch(ResourceNotFoundException $exception){
  69.             return '';
  70.         }
  71.         return $route['_route'];
  72.     }
  74.     /**
  75.      * Checks if the requested route is the change password route
  76.      * @param Request $request
  77.      * @return bool
  78.      */
  79.     public function isRequestedRouteAllowed(Request $request): bool
  80.     {
  81.         $routeName = $this->getRequestedRouteName($request);
  83.         $routeInObservedRoutes = in_array($routeName, $this->getRoutes(), true);
  85.         return $routeName === $this->getRouteToForce()
  86.             || $this->getMode() === self::MODE_REJECT_ROUTES && !$routeInObservedRoutes
  87.             || $this->getMode() === self::MODE_ALLOW_ROUTES && $routeInObservedRoutes
  88.         ;
  89.     }
  92.     /**
  93.      * Returns the current user
  94.      * @return UserInterface
  95.      */
  96.     public function getCurrentUser(): UserInterface {
  97.         return $this->tokenStorage->getToken()->getUser();
  98.     }
  101.     /**
  102.      * Checks if the requester is a user that is fully authenticated
  103.      * @return bool
  104.      */
  105.     public function isRequesterAnAuthenticatedUser(): bool {
  106.         return $this->tokenStorage->getToken()
  107.             && $this->authorizationChecker->isGranted('IS_AUTHENTICATED_FULLY');
  108.     }
  111.     /**
  112.      * @param $role
  113.      * @return bool
  114.      */
  115.     public function isGranted($role): bool {
  116.         return $this->authorizationChecker->isGranted($role);
  117.     }
  119.     public function getMode(): string
  120.     {
  121.         return self::MODE_ALLOW_ROUTES;
  122.     }
  124.     /**
  125.      * @return array
  126.      */
  127.     public function getRouteParametersToForce(): array
  128.     {
  129.         return [];
  130.     }
  131. }