UpdateKernel.php in Drupal 8

Namespace

Drupal\Core\Update

File

core/lib/Drupal/Core/Update/UpdateKernel.php

<?php

namespace Drupal\Core\Update;

use Drupal\Core\DrupalKernel;
use Drupal\Core\Session\AnonymousUserSession;
use Drupal\Core\Site\Settings;
use Drupal\Core\StackMiddleware\ReverseProxyMiddleware;
use Symfony\Cmf\Component\Routing\RouteObjectInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\ParameterBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;

/**
 * Defines a kernel which is used primarily to run the update of Drupal.
 *
 * We use a dedicated kernel + front controller (update.php) in order to be able
 * to repair Drupal if it is in a broken state.
 *
 * @see update.php
 * @see \Drupal\system\Controller\DbUpdateController
 */
class UpdateKernel extends DrupalKernel {

  /**
   * {@inheritdoc}
   */
  public function discoverServiceProviders() {
    parent::discoverServiceProviders();
    $this->serviceProviderClasses['app']['update_kernel'] = 'Drupal\\Core\\Update\\UpdateServiceProvider';
  }

  /**
   * {@inheritdoc}
   */
  protected function initializeContainer() {

    // Always force a container rebuild, in order to be able to override some
    // services, see \Drupal\Core\Update\UpdateServiceProvider.
    $this->containerNeedsRebuild = TRUE;
    $container = parent::initializeContainer();
    return $container;
  }

  /**
   * {@inheritdoc}
   */
  protected function cacheDrupalContainer(array $container_definition) {

    // Don't save this particular container to cache, so it does not leak into
    // the main site at all.
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function handle(Request $request, $type = self::MASTER_REQUEST, $catch = TRUE) {
    try {
      static::bootEnvironment();

      // First boot up basic things, like loading the include files.
      $this
        ->initializeSettings($request);
      ReverseProxyMiddleware::setSettingsOnRequest($request, Settings::getInstance());
      $this
        ->boot();
      $container = $this
        ->getContainer();

      /** @var \Symfony\Component\HttpFoundation\RequestStack $request_stack */
      $request_stack = $container
        ->get('request_stack');
      $request_stack
        ->push($request);
      $this
        ->preHandle($request);

      // Handle the actual request. We need the session both for authentication
      // as well as the DB update, like
      // \Drupal\system\Controller\DbUpdateController::batchFinished.
      $this
        ->bootSession($request, $type);
      $result = $this
        ->handleRaw($request);
      $this
        ->shutdownSession($request);
      return $result;
    } catch (\Exception $e) {
      return $this
        ->handleException($e, $request, $type);
    }
  }

  /**
   * Generates the actual result of update.php.
   *
   * The actual logic of the update is done in the db update controller.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The incoming request.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   A response object.
   *
   * @see \Drupal\system\Controller\DbUpdateController
   */
  protected function handleRaw(Request $request) {
    $container = $this
      ->getContainer();
    $this
      ->handleAccess($request, $container);

    /** @var \Drupal\Core\Controller\ControllerResolverInterface $controller_resolver */
    $controller_resolver = $container
      ->get('controller_resolver');

    /** @var callable $db_update_controller */
    $db_update_controller = $controller_resolver
      ->getControllerFromDefinition('\\Drupal\\system\\Controller\\DbUpdateController::handle');
    $this
      ->setupRequestMatch($request);

    /** @var \Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface $argument_resolver */
    $argument_resolver = $container
      ->get('http_kernel.controller.argument_resolver');
    $arguments = $argument_resolver
      ->getArguments($request, $db_update_controller);
    return call_user_func_array($db_update_controller, $arguments);
  }

  /**
   * Boots up the session.
   *
   * This method + shutdownSession() basically simulates what
   * \Drupal\Core\StackMiddleware\Session does.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The incoming request.
   */
  protected function bootSession(Request $request) {
    $container = $this
      ->getContainer();

    /** @var \Symfony\Component\HttpFoundation\Session\SessionInterface $session */
    $session = $container
      ->get('session');
    $session
      ->start();
    $request
      ->setSession($session);
  }

  /**
   * Ensures that the session is saved.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The incoming request.
   */
  protected function shutdownSession(Request $request) {
    if ($request
      ->hasSession()) {
      $request
        ->getSession()
        ->save();
    }
  }

  /**
   * Set up the request with fake routing data for update.php.
   *
   * This fake routing data is needed in order to make batch API work properly.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The incoming request.
   */
  protected function setupRequestMatch(Request $request) {
    $path = $request
      ->getPathInfo();
    $args = explode('/', ltrim($path, '/'));
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_NAME, 'system.db_update');
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_OBJECT, $this
      ->getContainer()
      ->get('router.route_provider')
      ->getRouteByName('system.db_update'));
    $op = $args[0] ?: 'info';
    $request->attributes
      ->set('op', $op);
    $request->attributes
      ->set('_raw_variables', new ParameterBag([
      'op' => $op,
    ]));
  }

  /**
   * Checks if the current user has rights to access updates page.
   *
   * If the current user does not have the rights, an exception is thrown.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The incoming request.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
   *   Thrown when update.php should not be accessible.
   */
  protected function handleAccess(Request $request) {

    /** @var \Drupal\Core\Authentication\AuthenticationManager $authentication_manager */
    $authentication_manager = $this
      ->getContainer()
      ->get('authentication');
    $account = $authentication_manager
      ->authenticate($request) ?: new AnonymousUserSession();

    /** @var \Drupal\Core\Session\AccountProxyInterface $current_user */
    $current_user = $this
      ->getContainer()
      ->get('current_user');
    $current_user
      ->setAccount($account);

    /** @var \Drupal\system\Access\DbUpdateAccessCheck $db_update_access */
    $db_update_access = $this
      ->getContainer()
      ->get('access_check.db_update');
    if (!Settings::get('update_free_access', FALSE) && !$db_update_access
      ->access($account)
      ->isAllowed()) {
      throw new AccessDeniedHttpException('In order to run update.php you need to either have "Administer software updates" permission or have set $settings[\'update_free_access\'] in your settings.php.');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function loadLegacyIncludes() {
    parent::loadLegacyIncludes();
    static::fixSerializedExtensionObjects($this->container);
  }

  /**
   * Fixes caches and theme info if they contain old Extension objects.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The container.
   *
   * @internal
   *   This function is only to be called by the Drupal core update process.
   *   Additionally, this function will be removed in minor release of Drupal.
   *
   * @todo https://www.drupal.org/project/drupal/issues/3031322 Remove once
   *   Drupal 8.6.x is not supported.
   */
  public static function fixSerializedExtensionObjects(ContainerInterface $container) {

    // Create a custom error handler that will clear caches if a warning occurs
    // while getting 'system.theme.data' from state. If this state value was
    // created by Drupal <= 8.6.7 then when it is read by Drupal >= 8.6.8 there
    // will be PHP warnings. This silently fixes Drupal so that the update can
    // continue.
    $clear_caches = FALSE;
    $callable = function ($errno, $errstr) use ($container, &$clear_caches) {
      if ($errstr === 'Class Drupal\\Core\\Extension\\Extension has no unserializer') {
        $clear_caches = TRUE;
      }
    };
    set_error_handler($callable, E_ERROR | E_WARNING);
    $container
      ->get('state')
      ->get('system.theme.data', []);
    restore_error_handler();
    if ($clear_caches) {

      // Reset static caches in profile list so the module list is rebuilt
      // correctly.
      $container
        ->get('extension.list.profile')
        ->reset();
      foreach ($container
        ->getParameter('cache_bins') as $service_id => $bin) {
        $container
          ->get($service_id)
          ->deleteAll();
      }

      // The system.theme.data key is no longer used in Drupal 8.7.x.
      $container
        ->get('state')
        ->delete('system.theme.data');

      // Also rebuild themes because it uses state as cache.
      $container
        ->get('theme_handler')
        ->refreshInfo();
    }
  }

}

Classes

Name	Description
UpdateKernel	Defines a kernel which is used primarily to run the update of Drupal.