vendor/easycorp/easyadmin-bundle/src/EventListener/AdminRouterSubscriber.php line 102

Open in your IDE?
  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\EventListener;
  5. use EasyCorp\Bundle\EasyAdminBundle\Config\Option\EA;
  6. use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\CrudControllerInterface;
  7. use EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\DashboardControllerInterface;
  8. use EasyCorp\Bundle\EasyAdminBundle\Factory\AdminContextFactory;
  9. use EasyCorp\Bundle\EasyAdminBundle\Factory\ControllerFactory;
  10. use EasyCorp\Bundle\EasyAdminBundle\Registry\CrudControllerRegistry;
  11. use EasyCorp\Bundle\EasyAdminBundle\Registry\DashboardControllerRegistry;
  12. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  13. use Symfony\Component\HttpFoundation\Request;
  14. use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
  15. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  16. use Symfony\Component\HttpKernel\Event\RequestEvent;
  17. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  18. use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
  19. use Twig\Environment;
  21. /**
  22.  * This subscriber acts as a "proxy" of all backend requests. First, if the
  23.  * request is related to EasyAdmin, it creates the AdminContext variable and
  24.  * stores it in the Request as an attribute.
  25.  *
  26.  * Second, it uses Symfony events to serve all backend requests using a single
  27.  * route. The trick is to change dynamically the controller to execute when
  28.  * the request is related to a CRUD action or a normal Symfony route/action.
  29.  *
  30.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  31.  * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
  32.  * @author Yonel Ceruto <yonelceruto@gmail.com>
  33.  */
  34. class AdminRouterSubscriber implements EventSubscriberInterface
  35. {
  36.     private AdminContextFactory $adminContextFactory;
  37.     private DashboardControllerRegistry $dashboardControllerRegistry;
  38.     private CrudControllerRegistry $crudControllerRegistry;
  39.     private ControllerFactory $controllerFactory;
  40.     private ControllerResolverInterface $controllerResolver;
  41.     private UrlGeneratorInterface $urlGenerator;
  42.     private RequestMatcherInterface $requestMatcher;
  43.     private Environment $twig;
  45.     public function __construct(AdminContextFactory $adminContextFactory, DashboardControllerRegistry $dashboardControllerRegistry, CrudControllerRegistry $crudControllerRegistry, ControllerFactory $controllerFactory, ControllerResolverInterface $controllerResolver, UrlGeneratorInterface $urlGenerator, RequestMatcherInterface $requestMatcher, Environment $twig)
  46.     {
  47.         $this->adminContextFactory = $adminContextFactory;
  48.         $this->dashboardControllerRegistry = $dashboardControllerRegistry;
  49.         $this->crudControllerRegistry = $crudControllerRegistry;
  50.         $this->controllerFactory = $controllerFactory;
  51.         $this->controllerResolver = $controllerResolver;
  52.         $this->urlGenerator = $urlGenerator;
  53.         $this->requestMatcher = $requestMatcher;
  54.         $this->twig = $twig;
  55.     }
  57.     public static function getSubscribedEvents(): array
  58.     {
  59.         return [
  60.             RequestEvent::class => [
  61.                 ['onKernelRequest', 0],
  62.             ],
  63.             // the priority must be higher than 0 to run it before ParamConverterListener
  64.             ControllerEvent::class => ['onKernelController', 128],
  65.         ];
  66.     }
  68.     /**
  69.      * If this is an EasyAdmin request, it creates the AdminContext variable, stores it
  70.      * in the Request as an attribute and injects it as a global Twig variable.
  71.      */
  72.     public function onKernelRequest(RequestEvent $event): void
  73.     {
  74.         $request = $event->getRequest();
  75.         if (null === $dashboardControllerFqcn = $this->getDashboardControllerFqcn($request)) {
  76.             return;
  77.         }
  79.         if (null === $dashboardControllerInstance = $this->getDashboardControllerInstance($dashboardControllerFqcn, $request)) {
  80.             return;
  81.         }
  83.         // creating the context is expensive, so it's created once and stored in the request
  84.         // if the current request already has an AdminContext object, do nothing
  85.         if (null === $adminContext = $request->attributes->get(EA::CONTEXT_REQUEST_ATTRIBUTE)) {
  86.             $crudControllerInstance = $this->getCrudControllerInstance($request);
  87.             $adminContext = $this->adminContextFactory->create($request, $dashboardControllerInstance, $crudControllerInstance);
  88.         }
  90.         $request->attributes->set(EA::CONTEXT_REQUEST_ATTRIBUTE, $adminContext);
  92.         // this makes the AdminContext available in all templates as a short named variable
  93.         $this->twig->addGlobal('ea', $adminContext);
  94.     }
  96.     /**
  97.      * In EasyAdmin all backend requests are served via the same route (that allows to
  98.      * detect under which dashboard you want to process the request). This method handles
  99.      * the requests related to "CRUD controller actions" and "custom Symfony actions".
  100.      * The trick used is to change dynamically the controller executed by Symfony.
  101.      */
  102.     public function onKernelController(ControllerEvent $event): void
  103.     {
  104.         $request = $event->getRequest();
  105.         if (null === $request->attributes->get(EA::CONTEXT_REQUEST_ATTRIBUTE)) {
  106.             return;
  107.         }
  109.         // if the request is related to a CRUD controller, change the controller to be executed
  110.         if (null !== $crudControllerInstance = $this->getCrudControllerInstance($request)) {
  111.             $symfonyControllerFqcnCallable = [$crudControllerInstance, $request->query->get(EA::CRUD_ACTION)];
  112.             $symfonyControllerStringCallable = [\get_class($crudControllerInstance), $request->query->get(EA::CRUD_ACTION)];
  114.             // this makes Symfony believe that another controller is being executed
  115.             // (e.g. this is needed for the autowiring of controller action arguments)
  116.             // VERY IMPORTANT: here the Symfony controller must be passed as a string (['App\Controller\Foo', 'index'])
  117.             // Otherwise, the param converter of the controller method doesn't work
  118.             $event->getRequest()->attributes->set('_controller', $symfonyControllerStringCallable);
  120.             // this actually makes Symfony to execute the other controller
  121.             $event->setController($symfonyControllerFqcnCallable);
  122.         }
  124.         // if the request is related to a custom action, change the controller to be executed
  125.         if (null !== $request->query->get(EA::ROUTE_NAME)) {
  126.             $symfonyControllerAsString = $this->getSymfonyControllerFqcn($request);
  127.             $symfonyControllerCallable = $this->getSymfonyControllerInstance($symfonyControllerAsString, $request->query->all()[EA::ROUTE_PARAMS] ?? []);
  128.             if (false !== $symfonyControllerCallable) {
  129.                 // this makes Symfony believe that another controller is being executed
  130.                 // (e.g. this is needed for the autowiring of controller action arguments)
  131.                 // VERY IMPORTANT: here the Symfony controller must be passed as a string ('App\Controller\Foo::index')
  132.                 // Otherwise, the param converter of the controller method doesn't work
  133.                 $event->getRequest()->attributes->set('_controller', $symfonyControllerAsString);
  134.                 // route params must be added as route attribute; otherwise, param converters don't work
  135.                 $event->getRequest()->attributes->replace(array_merge(
  136.                     $request->query->all()[EA::ROUTE_PARAMS] ?? [],
  137.                     $event->getRequest()->attributes->all()
  138.                 ));
  140.                 // this actually makes Symfony to execute the other controller
  141.                 $event->setController($symfonyControllerCallable);
  142.             }
  143.         }
  144.     }
  146.     /**
  147.      * It returns the FQCN of the EasyAdmin Dashboard controller used to serve this
  148.      * request or null if this is not an EasyAdmin request.
  149.      * Because of how EasyAdmin works, all backend requests are handled via the
  150.      * Dashboard controller, so its enough to check if the request controller implements
  151.      * the DashboardControllerInterface.
  152.      */
  153.     private function getDashboardControllerFqcn(Request $request): ?string
  154.     {
  155.         $controller = $request->attributes->get('_controller');
  156.         $controllerFqcn = null;
  158.         if (\is_string($controller)) {
  159.             [$controllerFqcn, ] = explode('::', $controller);
  160.         }
  162.         if (\is_array($controller)) {
  163.             $controllerFqcn = $controller[0];
  164.         }
  166.         if (\is_object($controller)) {
  167.             $controllerFqcn = \get_class($controller);
  168.         }
  170.         return is_subclass_of($controllerFqcn, DashboardControllerInterface::class) ? $controllerFqcn : null;
  171.     }
  173.     private function getDashboardControllerInstance(string $dashboardControllerFqcn, Request $request): ?DashboardControllerInterface
  174.     {
  175.         return $this->controllerFactory->getDashboardControllerInstance($dashboardControllerFqcn, $request);
  176.     }
  178.     private function getCrudControllerInstance(Request $request): ?CrudControllerInterface
  179.     {
  180.         if (null !== $crudId = $request->query->get(EA::CRUD_ID)) {
  181.             $crudControllerFqcn = $this->crudControllerRegistry->findCrudFqcnByCrudId($crudId);
  182.         } else {
  183.             $crudControllerFqcn = $request->query->get(EA::CRUD_CONTROLLER_FQCN);
  184.         }
  186.         $crudAction = $request->query->get(EA::CRUD_ACTION);
  188.         return $this->controllerFactory->getCrudControllerInstance($crudControllerFqcn, $crudAction, $request);
  189.     }
  191.     private function getSymfonyControllerFqcn(Request $request): ?string
  192.     {
  193.         $routeName = $request->query->get(EA::ROUTE_NAME);
  194.         $routeParams = $request->query->all()[EA::ROUTE_PARAMS] ?? [];
  195.         $url = $this->urlGenerator->generate($routeName, $routeParams);
  197.         $newRequest = $request->duplicate();
  198.         $newRequest->attributes->remove('_controller');
  199.         $newRequest->attributes->set('_route', $routeName);
  200.         $newRequest->attributes->add($routeParams);
  201.         $newRequest->server->set('REQUEST_URI', $url);
  203.         $parameters = $this->requestMatcher->matchRequest($newRequest);
  205.         return $parameters['_controller'] ?? null;
  206.     }
  208.     private function getSymfonyControllerInstance(string $controllerFqcn, array $routeParams): callable|false
  209.     {
  210.         $newRequest = new Request([], [], ['_controller' => $controllerFqcn, '_route_params' => $routeParams], [], [], []);
  212.         return $this->controllerResolver->getController($newRequest);
  213.     }
  214. }