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

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