class MaintenanceModeSubscriber in Drupal 9

Maintenance mode subscriber for controller requests.

Hierarchy

• class \Drupal\Core\EventSubscriber\MaintenanceModeSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface uses StringTranslationTrait

1 string reference to 'MaintenanceModeSubscriber'

core.services.yml in core/core.services.yml

core/core.services.yml

1 service uses MaintenanceModeSubscriber

maintenance_mode_subscriber in core/core.services.yml

Drupal\Core\EventSubscriber\MaintenanceModeSubscriber

File

core/lib/Drupal/Core/EventSubscriber/MaintenanceModeSubscriber.php, line 23

Namespace

Drupal\Core\EventSubscriber

class MaintenanceModeSubscriber implements EventSubscriberInterface {
  use StringTranslationTrait;

  /**
   * The maintenance mode.
   *
   * @var \Drupal\Core\Site\MaintenanceModeInterface
   */
  protected $maintenanceMode;

  /**
   * The current account.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $account;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $config;

  /**
   * The url generator.
   *
   * @var \Drupal\Core\Routing\UrlGeneratorInterface
   */
  protected $urlGenerator;

  /**
   * The bare HTML page renderer.
   *
   * @var \Drupal\Core\Render\BareHtmlPageRendererInterface
   */
  protected $bareHtmlPageRenderer;

  /**
   * The messenger.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs a new MaintenanceModeSubscriber.
   *
   * @param \Drupal\Core\Site\MaintenanceModeInterface $maintenance_mode
   *   The maintenance mode.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
   *   The string translation.
   * @param \Drupal\Core\Routing\UrlGeneratorInterface $url_generator
   *   The url generator.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The current user.
   * @param \Drupal\Core\Render\BareHtmlPageRendererInterface $bare_html_page_renderer
   *   The bare HTML page renderer.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   */
  public function __construct(MaintenanceModeInterface $maintenance_mode, ConfigFactoryInterface $config_factory, TranslationInterface $translation, UrlGeneratorInterface $url_generator, AccountInterface $account, BareHtmlPageRendererInterface $bare_html_page_renderer, MessengerInterface $messenger) {
    $this->maintenanceMode = $maintenance_mode;
    $this->config = $config_factory;
    $this->stringTranslation = $translation;
    $this->urlGenerator = $url_generator;
    $this->account = $account;
    $this->bareHtmlPageRenderer = $bare_html_page_renderer;
    $this->messenger = $messenger;
  }

  /**
   * Returns the site maintenance page if the site is offline.
   *
   * @param \Symfony\Component\HttpKernel\Event\RequestEvent $event
   *   The event to process.
   */
  public function onKernelRequestMaintenance(RequestEvent $event) {
    $request = $event
      ->getRequest();
    $route_match = RouteMatch::createFromRequest($request);
    if ($this->maintenanceMode
      ->applies($route_match)) {

      // Don't cache maintenance mode pages.
      \Drupal::service('page_cache_kill_switch')
        ->trigger();
      if (!$this->maintenanceMode
        ->exempt($this->account)) {

        // Deliver the 503 page if the site is in maintenance mode and the
        // logged in user is not allowed to bypass it.
        // If the request format is not 'html' then show default maintenance
        // mode page else show a text/plain page with maintenance message.
        if ($request
          ->getRequestFormat() !== 'html') {
          $response = new Response($this
            ->getSiteMaintenanceMessage(), 503, [
            'Content-Type' => 'text/plain',
          ]);
          $event
            ->setResponse($response);
          return;
        }
        drupal_maintenance_theme();
        $response = $this->bareHtmlPageRenderer
          ->renderBarePage([
          '#markup' => $this
            ->getSiteMaintenanceMessage(),
        ], $this
          ->t('Site under maintenance'), 'maintenance_page');
        $response
          ->setStatusCode(503);
        $event
          ->setResponse($response);
      }
      else {

        // Display a message if the logged in user has access to the site in
        // maintenance mode. However, suppress it on the maintenance mode
        // settings page.
        if ($route_match
          ->getRouteName() != 'system.site_maintenance_mode') {
          if ($this->account
            ->hasPermission('administer site configuration')) {
            $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);
          }
          else {
            $this->messenger
              ->addMessage($this
              ->t('Operating in maintenance mode.'), 'status', FALSE);
          }
        }
      }
    }
  }

  /**
   * Gets the site maintenance message.
   *
   * @return \Drupal\Component\Render\MarkupInterface
   *   The formatted site maintenance message.
   */
  protected function getSiteMaintenanceMessage() {
    return new FormattableMarkup($this->config
      ->get('system.maintenance')
      ->get('message'), [
      '@site' => $this->config
        ->get('system.site')
        ->get('name'),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events[KernelEvents::REQUEST][] = [
      'onKernelRequestMaintenance',
      30,
    ];
    $events[KernelEvents::EXCEPTION][] = [
      'onKernelRequestMaintenance',
    ];
    return $events;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MaintenanceModeSubscriber::$account	protected	property	The current account.
MaintenanceModeSubscriber::$bareHtmlPageRenderer	protected	property	The bare HTML page renderer.
MaintenanceModeSubscriber::$config	protected	property	The config factory.
MaintenanceModeSubscriber::$maintenanceMode	protected	property	The maintenance mode.
MaintenanceModeSubscriber::$messenger	protected	property	The messenger.
MaintenanceModeSubscriber::$urlGenerator	protected	property	The url generator.
MaintenanceModeSubscriber::getSiteMaintenanceMessage	protected	function	Gets the site maintenance message.
MaintenanceModeSubscriber::getSubscribedEvents	public static	function
MaintenanceModeSubscriber::onKernelRequestMaintenance	public	function	Returns the site maintenance page if the site is offline.
MaintenanceModeSubscriber::__construct	public	function	Constructs a new MaintenanceModeSubscriber.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.