src/EventSubscriber/MaintenanceSubscriber.php line 40

Open in your IDE?
  1. <?php
  3. namespace App\EventSubscriber;
  5. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  6. use Symfony\Component\HttpFoundation\Response;
  7. use Symfony\Component\HttpKernel\Event\RequestEvent;
  8. use Twig\Environment;
  9. use Twig\Error\LoaderError;
  10. use Twig\Error\RuntimeError;
  11. use Twig\Error\SyntaxError;
  13. /**
  14.  *
  15.  */
  16. class MaintenanceSubscriber implements EventSubscriberInterface
  17. {
  18.     /**
  19.      * @var Environment
  20.      */
  21.     private $twig;
  23.     /**
  24.      * @param Environment $twig
  25.      */
  26.     public function __construct(Environment $twig)
  27.     {
  28.         $this->twig = $twig;
  29.     }
  32.     /**
  33.      * @param RequestEvent $event
  34.      *
  35.      * @return void
  36.      * @throws LoaderError
  37.      * @throws RuntimeError
  38.      * @throws SyntaxError
  39.      */
  40.     public function onKernelRequest(RequestEvent $event): void
  41.     {
  42.         $maintenanceRawValue = $_ENV['MAINTENANCE_MODE'] ?? 0;
  43.         if (!filter_var($maintenanceRawValue, FILTER_VALIDATE_BOOLEAN)) {
  44.             return;
  45.         }
  46.         $myIp                    = $_SERVER['REMOTE_ADDR'];
  47.         $exclusionList           = [];
  48.         $maintenanceRawExclusion = $_ENV['MAINTENANCE_EXCLUSION'] ?? null;
  49.         if ($maintenanceRawExclusion) {
  50.             $exclusionList = array_map('trim', explode(',', $maintenanceRawExclusion));
  51.         }
  53.         if (in_array($myIp, $exclusionList)) {
  54.             return;
  55.         }
  57.         $content  = $this->twig->render('default/maintenance.html.twig', [
  58.                 'ip' => $myIp,
  59.             ]
  60.         );
  61.         $response = new response($content, Response::HTTP_SERVICE_UNAVAILABLE);
  62.         $event->setResponse($response);
  63.         $event->stopPropagation();
  64.     }
  66.     /**
  67.      * Returns an array of event names this subscriber wants to listen to.
  68.      *
  69.      * The array keys are event names and the value can be:
  70.      *
  71.      *  * The method name to call (priority defaults to 0)
  72.      *  * An array composed of the method name to call and the priority
  73.      *  * An array of arrays composed of the method names to call and respective
  74.      *    priorities, or 0 if unset
  75.      *
  76.      * For instance:
  77.      *
  78.      *  * ['eventName' => 'methodName']
  79.      *  * ['eventName' => ['methodName', $priority]]
  80.      *  * ['eventName' => [['methodName1', $priority], ['methodName2']]]
  81.      *
  82.      * The code must not depend on runtime state as it will only be called at compile time.
  83.      * All logic depending on runtime state must be put into the individual methods handling the events.
  84.      *
  85.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  86.      */
  87.     public static function getSubscribedEvents(): array
  88.     {
  89.         return [
  90.             'kernel.request' => 'onKernelRequest',
  91.         ];
  92.     }
  93. }