vendor/pimcore/pimcore/bundles/CoreBundle/EventListener/MaintenancePageListener.php line 84

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Bundle\CoreBundle\EventListener;
  18. use Pimcore\Bundle\CoreBundle\EventListener\Traits\ResponseInjectionTrait;
  19. use Pimcore\Tool\Session;
  20. use Symfony\Component\HttpFoundation\Response;
  21. use Symfony\Component\HttpKernel\Event\RequestEvent;
  22. use Symfony\Component\HttpKernel\KernelInterface;
  24. /**
  25.  * @internal
  26.  */
  27. class MaintenancePageListener
  28. {
  29.     use ResponseInjectionTrait;
  31.     /**
  32.      * @var string|null
  33.      */
  34.     protected $templateCode = null;
  36.     /**
  37.      * @param KernelInterface $kernel
  38.      */
  39.     public function __construct(protected KernelInterface $kernel)
  40.     {
  41.     }
  43.     /**
  44.      * @param string $code
  45.      */
  46.     public function setTemplateCode($code): void
  47.     {
  48.         $this->templateCode = $code;
  49.     }
  51.     /**
  52.      * @return string|null
  53.      */
  54.     public function getTemplateCode(): ?string
  55.     {
  56.         return $this->templateCode;
  57.     }
  59.     /**
  60.      * @param string $path
  61.      */
  62.     public function loadTemplateFromPath($path): void
  63.     {
  64.         $templateFile = PIMCORE_PROJECT_ROOT . $path;
  65.         if (file_exists($templateFile)) {
  66.             $this->setTemplateCode(file_get_contents($templateFile));
  67.         }
  68.     }
  70.     /**
  71.      * @param string $path
  72.      */
  73.     public function loadTemplateFromResource($path): void
  74.     {
  75.         $templateFile = $this->kernel->locateResource($path);
  76.         if (file_exists($templateFile)) {
  77.             $this->setTemplateCode(file_get_contents($templateFile));
  78.         }
  79.     }
  81.     /**
  82.      * @param RequestEvent $event
  83.      */
  84.     public function onKernelRequest(RequestEvent $event): void
  85.     {
  86.         if (!$event->isMainRequest()) {
  87.             return;
  88.         }
  90.         $request = $event->getRequest();
  92.         $maintenance = false;
  93.         $file = \Pimcore\Tool\Admin::getMaintenanceModeFile();
  95.         if (!is_file($file)) {
  96.             return;
  97.         }
  99.         $conf = include($file);
  100.         if (isset($conf['sessionId'])) {
  101.             $requestSessionId = Session::getSessionId();
  103.             $maintenance = true;
  104.             if ($conf['sessionId'] === $requestSessionId) {
  105.                 $maintenance = false;
  106.             }
  107.         } else {
  108.             @unlink($file);
  109.         }
  111.         // do not activate the maintenance for the server itself
  112.         // this is to avoid problems with monitoring agents
  113.         $serverIps = ['127.0.0.1'];
  115.         if ($maintenance && !in_array($request->getClientIp(), $serverIps)) {
  116.             $response = new Response($this->getTemplateCode(), 503);
  117.             $event->setResponse($response);
  118.         }
  119.     }
  120. }