Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\EventSubscriber;
Chris@0: 
Chris@17: use Drupal\Component\Render\FormattableMarkup;
Chris@0: use Drupal\Core\Config\ConfigFactoryInterface;
Chris@0: use Drupal\Core\Render\BareHtmlPageRendererInterface;
Chris@14: use Drupal\Core\Messenger\MessengerInterface;
Chris@0: use Drupal\Core\Routing\RouteMatch;
Chris@0: use Drupal\Core\Routing\UrlGeneratorInterface;
Chris@0: use Drupal\Core\Session\AccountInterface;
Chris@0: use Drupal\Core\Site\MaintenanceModeInterface;
Chris@0: use Drupal\Core\StringTranslation\StringTranslationTrait;
Chris@0: use Drupal\Core\StringTranslation\TranslationInterface;
Chris@0: use Symfony\Component\EventDispatcher\EventSubscriberInterface;
Chris@0: use Symfony\Component\HttpFoundation\Response;
Chris@0: use Symfony\Component\HttpKernel\Event\GetResponseEvent;
Chris@0: use Symfony\Component\HttpKernel\KernelEvents;
Chris@0: 
Chris@0: /**
Chris@0:  * Maintenance mode subscriber for controller requests.
Chris@0:  */
Chris@0: class MaintenanceModeSubscriber implements EventSubscriberInterface {
Chris@0: 
Chris@0:   use StringTranslationTrait;
Chris@0: 
Chris@0:   /**
Chris@0:    * The maintenance mode.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Site\MaintenanceModeInterface
Chris@0:    */
Chris@0:   protected $maintenanceMode;
Chris@0: 
Chris@0:   /**
Chris@0:    * The current account.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Session\AccountInterface
Chris@0:    */
Chris@0:   protected $account;
Chris@0: 
Chris@0:   /**
Chris@0:    * The config factory.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Config\ConfigFactoryInterface
Chris@0:    */
Chris@0:   protected $config;
Chris@0: 
Chris@0:   /**
Chris@0:    * The url generator.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Routing\UrlGeneratorInterface
Chris@0:    */
Chris@0:   protected $urlGenerator;
Chris@0: 
Chris@0:   /**
Chris@0:    * The bare HTML page renderer.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Render\BareHtmlPageRendererInterface
Chris@0:    */
Chris@0:   protected $bareHtmlPageRenderer;
Chris@0: 
Chris@0:   /**
Chris@14:    * The messenger.
Chris@14:    *
Chris@14:    * @var \Drupal\Core\Messenger\MessengerInterface
Chris@14:    */
Chris@14:   protected $messenger;
Chris@14: 
Chris@14:   /**
Chris@0:    * Constructs a new MaintenanceModeSubscriber.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Site\MaintenanceModeInterface $maintenance_mode
Chris@0:    *   The maintenance mode.
Chris@0:    * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
Chris@0:    *   The config factory.
Chris@0:    * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
Chris@0:    *   The string translation.
Chris@0:    * @param \Drupal\Core\Routing\UrlGeneratorInterface $url_generator
Chris@0:    *   The url generator.
Chris@0:    * @param \Drupal\Core\Session\AccountInterface $account
Chris@0:    *   The current user.
Chris@0:    * @param \Drupal\Core\Render\BareHtmlPageRendererInterface $bare_html_page_renderer
Chris@0:    *   The bare HTML page renderer.
Chris@14:    * @param \Drupal\Core\Messenger\MessengerInterface $messenger
Chris@14:    *   The messenger.
Chris@0:    */
Chris@14:   public function __construct(MaintenanceModeInterface $maintenance_mode, ConfigFactoryInterface $config_factory, TranslationInterface $translation, UrlGeneratorInterface $url_generator, AccountInterface $account, BareHtmlPageRendererInterface $bare_html_page_renderer, MessengerInterface $messenger) {
Chris@0:     $this->maintenanceMode = $maintenance_mode;
Chris@0:     $this->config = $config_factory;
Chris@0:     $this->stringTranslation = $translation;
Chris@0:     $this->urlGenerator = $url_generator;
Chris@0:     $this->account = $account;
Chris@0:     $this->bareHtmlPageRenderer = $bare_html_page_renderer;
Chris@14:     $this->messenger = $messenger;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the site maintenance page if the site is offline.
Chris@0:    *
Chris@0:    * @param \Symfony\Component\HttpKernel\Event\GetResponseEvent $event
Chris@0:    *   The event to process.
Chris@0:    */
Chris@0:   public function onKernelRequestMaintenance(GetResponseEvent $event) {
Chris@0:     $request = $event->getRequest();
Chris@0:     $route_match = RouteMatch::createFromRequest($request);
Chris@0:     if ($this->maintenanceMode->applies($route_match)) {
Chris@0:       // Don't cache maintenance mode pages.
Chris@0:       \Drupal::service('page_cache_kill_switch')->trigger();
Chris@0: 
Chris@0:       if (!$this->maintenanceMode->exempt($this->account)) {
Chris@0:         // Deliver the 503 page if the site is in maintenance mode and the
Chris@0:         // logged in user is not allowed to bypass it.
Chris@0: 
Chris@0:         // If the request format is not 'html' then show default maintenance
Chris@0:         // mode page else show a text/plain page with maintenance message.
Chris@0:         if ($request->getRequestFormat() !== 'html') {
Chris@0:           $response = new Response($this->getSiteMaintenanceMessage(), 503, ['Content-Type' => 'text/plain']);
Chris@0:           $event->setResponse($response);
Chris@0:           return;
Chris@0:         }
Chris@0:         drupal_maintenance_theme();
Chris@0:         $response = $this->bareHtmlPageRenderer->renderBarePage(['#markup' => $this->getSiteMaintenanceMessage()], $this->t('Site under maintenance'), 'maintenance_page');
Chris@0:         $response->setStatusCode(503);
Chris@0:         $event->setResponse($response);
Chris@0:       }
Chris@0:       else {
Chris@0:         // Display a message if the logged in user has access to the site in
Chris@0:         // maintenance mode. However, suppress it on the maintenance mode
Chris@0:         // settings page.
Chris@0:         if ($route_match->getRouteName() != 'system.site_maintenance_mode') {
Chris@0:           if ($this->account->hasPermission('administer site configuration')) {
Chris@14:             $this->messenger->addMessage($this->t('Operating in maintenance mode. <a href=":url">Go online.</a>', [':url' => $this->urlGenerator->generate('system.site_maintenance_mode')]), 'status', FALSE);
Chris@0:           }
Chris@0:           else {
Chris@14:             $this->messenger->addMessage($this->t('Operating in maintenance mode.'), 'status', FALSE);
Chris@0:           }
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the site maintenance message.
Chris@0:    *
Chris@0:    * @return \Drupal\Component\Render\MarkupInterface
Chris@0:    *   The formatted site maintenance message.
Chris@0:    */
Chris@0:   protected function getSiteMaintenanceMessage() {
Chris@17:     return new FormattableMarkup($this->config->get('system.maintenance')->get('message'), [
Chris@0:       '@site' => $this->config->get('system.site')->get('name'),
Chris@0:     ]);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function getSubscribedEvents() {
Chris@0:     $events[KernelEvents::REQUEST][] = ['onKernelRequestMaintenance', 30];
Chris@0:     $events[KernelEvents::EXCEPTION][] = ['onKernelRequestMaintenance'];
Chris@0:     return $events;
Chris@0:   }
Chris@0: 
Chris@0: }