src/InstallBundle/Listener/RequestListener.php line 93

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of SolidInvoice project.
  7.  *
  8.  * (c) Pierre du Plessis <open-source@solidworx.co>
  9.  *
  10.  * This source file is subject to the MIT license that is bundled
  11.  * with this source code in the file LICENSE.
  12.  */
  14. namespace SolidInvoice\InstallBundle\Listener;
  16. use SolidInvoice\InstallBundle\Exception\ApplicationInstalledException;
  17. use SolidInvoice\UserBundle\Repository\UserRepositoryInterface;
  18. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. use Symfony\Component\HttpFoundation\RedirectResponse;
  20. use Symfony\Component\HttpKernel\Event\RequestEvent;
  21. use Symfony\Component\HttpKernel\HttpKernelInterface;
  22. use Symfony\Component\HttpKernel\KernelEvents;
  23. use Symfony\Component\Routing\RouterInterface;
  24. use function in_array;
  26. /**
  27.  * Listener class to intercept requests
  28.  * and redirect to the installer if necessary.
  29.  * @see \SolidInvoice\InstallBundle\Tests\Listener\RequestListenerTest
  30.  */
  31. final class RequestListener implements EventSubscriberInterface
  32. {
  33.     public const INSTALLER_ROUTE = '_install_check_requirements';
  35.     /**
  36.      * Core routes.
  37.      *
  38.      * @var list<string>
  39.      */
  40.     private array $allowRoutes = self::INSTALL_ROUTES;
  42.     /**
  43.      * @var list<string>
  44.      */
  45.     private const INSTALL_ROUTES = [
  46.         self::INSTALLER_ROUTE,
  47.         '_install_config',
  48.         '_install_install',
  49.         ...self::SETUP_ROUTES
  50.     ];
  52.     /**
  53.      * @var list<string>
  54.      */
  55.     private const SETUP_ROUTES = [
  56.         '_install_setup',
  57.         '_install_finish',
  58.     ];
  60.     /**
  61.      * @var list<string>
  62.      */
  63.     private const DEBUG_ROUTES = [
  64.         '_wdt',
  65.         '_profiler',
  66.         '_profiler_search',
  67.         '_profiler_search_bar',
  68.         '_profiler_search_results',
  69.         '_profiler_router',
  70.     ];
  72.     public static function getSubscribedEvents(): array
  73.     {
  74.         return [
  75.             KernelEvents::REQUEST => ['onKernelRequest', 10],
  76.         ];
  77.     }
  79.     public function __construct(
  80.         private readonly RouterInterface $router,
  81.         private readonly UserRepositoryInterface $userRepository,
  82.         private readonly ?string $installed,
  83.         private readonly bool $debug = false
  84.     ) {
  85.         if ($this->debug) {
  86.             $this->allowRoutes = array_merge($this->allowRoutes, self::DEBUG_ROUTES);
  87.         }
  88.     }
  90.     /**
  91.      * @throws ApplicationInstalledException
  92.      */
  93.     public function onKernelRequest(RequestEvent $event): void
  94.     {
  95.         if (HttpKernelInterface::MAIN_REQUEST !== $event->getRequestType()) {
  96.             return;
  97.         }
  99.         $request = $event->getRequest();
  100.         $session = $request->getSession();
  101.         $route = $request->get('_route');
  103.         if (null !== $this->installed && '' !== $this->installed) {
  104.             // If the application is installed, but we don't have any users
  105.             // Redirect to the setup page
  106.             if ($this->userRepository->getUserCount() === 0) {
  107.                 if (! in_array($route, [...self::SETUP_ROUTES, ...($this->debug ? self::DEBUG_ROUTES : [])], true)) {
  108.                     $this->redirectToRoute($event, '_install_setup');
  109.                 }
  111.                 return;
  112.             }
  114.             // If the application is installed, and we already have users, and the installer route is requested
  115.             // then throw an exception
  116.             if (in_array($route, self::INSTALL_ROUTES, true) && ! $session->has('installation_step')) {
  117.                 throw new ApplicationInstalledException();
  118.             }
  119.         } elseif (! in_array($route, $this->allowRoutes, true)) {
  120.             $this->redirectToRoute($event, self::INSTALLER_ROUTE);
  121.         }
  122.     }
  124.     private function redirectToRoute(RequestEvent $event, string $route): void
  125.     {
  126.         $response = new RedirectResponse($this->router->generate($route));
  128.         $event->setResponse($response);
  129.         $event->stopPropagation();
  130.     }
  131. }