vendor/shopware/storefront/Controller/MaintenanceController.php line 73

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Controller;
  5. use Shopware\Core\Framework\Adapter\Kernel\HttpCacheKernel;
  6. use Shopware\Core\Framework\Log\Package;
  7. use Shopware\Core\Framework\Routing\RoutingException;
  8. use Shopware\Core\SalesChannelRequest;
  9. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  10. use Shopware\Core\System\SystemConfig\SystemConfigService;
  11. use Shopware\Storefront\Framework\Routing\MaintenanceModeResolver;
  12. use Shopware\Storefront\Page\Maintenance\MaintenancePageLoadedHook;
  13. use Shopware\Storefront\Page\Maintenance\MaintenancePageLoader;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\Routing\Annotation\Route;
  18. /**
  19.  * @internal
  20.  * Do not use direct or indirect repository calls in a controller. Always use a store-api route to get or put data
  21.  */
  22. #[Route(defaults: ['_routeScope' => ['storefront']])]
  23. #[Package('storefront')]
  24. class MaintenanceController extends StorefrontController
  25. {
  26.     /**
  27.      * @internal
  28.      */
  29.     public function __construct(
  30.         private readonly SystemConfigService $systemConfigService,
  31.         private readonly MaintenancePageLoader $maintenancePageLoader,
  32.         private readonly MaintenanceModeResolver $maintenanceModeResolver
  33.     ) {
  34.     }
  36.     #[Route(path: '/maintenance', name: 'frontend.maintenance.page', defaults: ['allow_maintenance' => true, '_httpCache' => true], methods: ['GET'])]
  37.     public function renderMaintenancePage(Request $request, SalesChannelContext $context): ?Response
  38.     {
  39.         $salesChannel = $context->getSalesChannel();
  41.         if ($this->maintenanceModeResolver->shouldRedirectToShop($request)) {
  42.             return $this->redirectToRoute('frontend.home.page');
  43.         }
  45.         $salesChannelId = $salesChannel->getId();
  46.         $maintenanceLayoutId = $this->systemConfigService->getString('core.basicInformation.maintenancePage', $salesChannelId);
  48.         if ($maintenanceLayoutId === '') {
  49.             $response = $this->renderStorefront(
  50.                 '@Storefront/storefront/page/error/error-maintenance.html.twig'
  51.             );
  53.             $response->setStatusCode(Response::HTTP_SERVICE_UNAVAILABLE, 'Service Temporarily Unavailable');
  54.             $response->headers->set('Retry-After', '3600');
  56.             $this->addWhitelistIpHeader($request, $response);
  58.             return $response;
  59.         }
  61.         $maintenancePage = $this->maintenancePageLoader->load($maintenanceLayoutId, $request, $context);
  63.         $this->hook(new MaintenancePageLoadedHook($maintenancePage, $context));
  65.         $response = $this->renderStorefront(
  66.             '@Storefront/storefront/page/error/error-maintenance.html.twig',
  67.             ['page' => $maintenancePage]
  68.         );
  70.         $response->setStatusCode(Response::HTTP_SERVICE_UNAVAILABLE, 'Service Temporarily Unavailable');
  71.         $response->headers->set('Retry-After', '3600');
  73.         $this->addWhitelistIpHeader($request, $response);
  75.         return $response;
  76.     }
  78.     /**
  79.      * Route for stand alone cms pages during maintenance
  80.      */
  81.     #[Route(path: '/maintenance/singlepage/{id}', name: 'frontend.maintenance.singlepage', defaults: ['allow_maintenance' => true, '_httpCache' => true], methods: ['GET'])]
  82.     public function renderSinglePage(string $id, Request $request, SalesChannelContext $salesChannelContext): Response
  83.     {
  84.         if (!$id) {
  85.             throw RoutingException::missingRequestParameter('id');
  86.         }
  88.         $cmsPage = $this->maintenancePageLoader->load($id, $request, $salesChannelContext);
  90.         $this->hook(new MaintenancePageLoadedHook($cmsPage, $salesChannelContext));
  92.         $response = $this->renderStorefront(
  93.             '@Storefront/storefront/page/content/single-cms-page.html.twig',
  94.             ['page' => $cmsPage]
  95.         );
  97.         $this->addWhitelistIpHeader($request, $response);
  99.         return $response;
  100.     }
  102.     private function addWhitelistIpHeader(Request $request, Response $response): void
  103.     {
  104.         if ($ips = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_SALES_CHANNEL_MAINTENANCE_IP_WHITLELIST)) {
  105.             $ips = implode(',', json_decode($ips, true, flags: \JSON_THROW_ON_ERROR));
  107.             $response->headers->set(HttpCacheKernel::MAINTENANCE_WHITELIST_HEADER, $ips);
  108.         }
  109.     }
  110. }