install.core.inc 89.2 KB
Newer Older
1 2
<?php

3 4 5 6 7
/**
 * @file
 * API functions for installing Drupal.
 */

8
use Drupal\Component\Utility\UrlHelper;
katbailey's avatar
katbailey committed
9
use Drupal\Core\DrupalKernel;
10
use Drupal\Core\Database\Database;
11
use Drupal\Core\Database\DatabaseExceptionWrapper;
12
use Drupal\Core\Form\FormState;
13 14 15
use Drupal\Core\Installer\Exception\AlreadyInstalledException;
use Drupal\Core\Installer\Exception\InstallerException;
use Drupal\Core\Installer\Exception\NoProfilesException;
16
use Drupal\Core\Installer\InstallerKernel;
17
use Drupal\Core\Language\Language;
18
use Drupal\Core\Language\LanguageManager;
19
use Drupal\Core\Logger\LoggerChannelFactory;
20
use Drupal\Core\Site\Settings;
21
use Drupal\Core\StringTranslation\Translator\FileTranslation;
22
use Drupal\Core\StackMiddleware\ReverseProxyMiddleware;
23
use Drupal\Core\Extension\ExtensionDiscovery;
24
use Drupal\Core\DependencyInjection\ContainerBuilder;
25
use Drupal\Core\Url;
26
use Drupal\language\Entity\ConfigurableLanguage;
27
use Symfony\Cmf\Component\Routing\RouteObjectInterface;
28
use Symfony\Component\DependencyInjection\Reference;
29
use Symfony\Component\HttpFoundation\Request;
30
use Symfony\Component\HttpFoundation\Response;
31
use Symfony\Component\Routing\Route;
32
use Drupal\user\Entity\User;
33
use GuzzleHttp\Exception\RequestException;
34

35
/**
36
 * Do not run the task during the current installation request.
37 38 39 40 41 42 43 44 45
 *
 * This can be used to skip running an installation task when certain
 * conditions are met, even though the task may still show on the list of
 * installation tasks presented to the user. For example, the Drupal installer
 * uses this flag to skip over the database configuration form when valid
 * database connection information is already available from settings.php. It
 * also uses this flag to skip language import tasks when the installation is
 * being performed in English.
 */
46
const INSTALL_TASK_SKIP = 1;
47 48

/**
49
 * Run the task on each installation request that reaches it.
50 51 52
 *
 * This is primarily used by the Drupal installer for bootstrap-related tasks.
 */
53
const INSTALL_TASK_RUN_IF_REACHED = 2;
54 55

/**
56
 * Run the task on each installation request until the database is set up.
57 58 59 60 61 62 63 64
 *
 * This is the default method for running tasks and should be used for most
 * tasks that occur after the database is set up; these tasks will then run
 * once and be marked complete once they are successfully finished. For
 * example, the Drupal installer uses this flag for the batch installation of
 * modules on the new site, and also for the configuration form that collects
 * basic site information and sets up the site maintenance account.
 */
65
const INSTALL_TASK_RUN_IF_NOT_COMPLETED = 3;
66 67

/**
68
 * Installs Drupal either interactively or via an array of passed-in settings.
69 70 71 72 73 74 75 76 77
 *
 * The Drupal installation happens in a series of steps, which may be spread
 * out over multiple page requests. Each request begins by trying to determine
 * the last completed installation step (also known as a "task"), if one is
 * available from a previous request. Control is then passed to the task
 * handler, which processes the remaining tasks that need to be run until (a)
 * an error is thrown, (b) a new page needs to be displayed, or (c) the
 * installation finishes (whichever happens first).
 *
78 79 80 81
 * @param $class_loader
 *   The class loader. Normally Composer's ClassLoader, as included by the
 *   front controller, but may also be decorated; e.g.,
 *   \Symfony\Component\ClassLoader\ApcClassLoader.
82 83 84 85 86 87 88 89 90 91 92
 * @param $settings
 *   An optional array of installation settings. Leave this empty for a normal,
 *   interactive, browser-based installation intended to occur over multiple
 *   page requests. Alternatively, if an array of settings is passed in, the
 *   installer will attempt to use it to perform the installation in a single
 *   page request (optimized for the command line) and not send any output
 *   intended for the web browser. See install_state_defaults() for a list of
 *   elements that are allowed to appear in this array.
 *
 * @see install_state_defaults()
 */
93 94 95 96 97 98
function install_drupal($class_loader, $settings = array()) {
  // Support the old way of calling this function with just a settings array.
  // @todo Remove this when Drush is updated in the Drupal testing
  //   infrastructure in https://www.drupal.org/node/2389243
  if (is_array($class_loader) && $settings === array()) {
    $settings = $class_loader;
99
    $class_loader = require __DIR__ . '/../../autoload.php';
100 101
  }

102 103 104 105 106 107
  global $install_state;
  // Initialize the installation state with the settings that were passed in,
  // as well as a boolean indicating whether or not this is an interactive
  // installation.
  $interactive = empty($settings);
  $install_state = $settings + array('interactive' => $interactive) + install_state_defaults();
108

109 110 111
  try {
    // Begin the page request. This adds information about the current state of
    // the Drupal installation to the passed-in array.
112
    install_begin_request($class_loader, $install_state);
113 114 115 116 117 118 119 120 121 122 123 124 125 126
    // Based on the installation state, run the remaining tasks for this page
    // request, and collect any output.
    $output = install_run_tasks($install_state);
  }
  catch (InstallerException $e) {
    // In the non-interactive installer, exceptions are always thrown directly.
    if (!$install_state['interactive']) {
      throw $e;
    }
    $output = array(
      '#title' => $e->getTitle(),
      '#markup' => $e->getMessage(),
    );
  }
127

128 129 130 131 132 133 134
  // After execution, all tasks might be complete, in which case
  // $install_state['installation_finished'] is TRUE. In case the last task
  // has been processed, remove the global $install_state, so other code can
  // reliably check whether it is running during the installer.
  // @see drupal_installation_attempted()
  $state = $install_state;
  if (!empty($install_state['installation_finished'])) {
135
    unset($GLOBALS['install_state']);
136 137
  }

138 139 140
  // All available tasks for this page request are now complete. Interactive
  // installations can send output to the browser or redirect the user to the
  // next page.
141
  if ($state['interactive']) {
142 143 144 145
    // If a session has been initiated in this request, make sure to save it.
    if ($session = \Drupal::request()->getSession()) {
      $session->save();
    }
146
    if ($state['parameters_changed']) {
147
      // Redirect to the correct page if the URL parameters have changed.
148
      install_goto(install_redirect_url($state));
149 150 151 152 153
    }
    elseif (isset($output)) {
      // Display a page only if some output is available. Otherwise it is
      // possible that we are printing a JSON page and theme output should
      // not be shown.
154
      install_display_output($output, $state);
155
    }
156 157 158 159
    elseif ($state['installation_finished']) {
      // Redirect to the newly installed site.
      install_goto('');
    }
160 161 162 163
  }
}

/**
164
 * Returns an array of default settings for the global installation state.
165 166 167 168 169 170 171 172
 *
 * The installation state is initialized with these settings at the beginning
 * of each page request. They may evolve during the page request, but they are
 * initialized again once the next request begins.
 *
 * Non-interactive Drupal installations can override some of these default
 * settings by passing in an array to the installation script, most notably
 * 'parameters' (which contains one-time parameters such as 'profile' and
173
 * 'langcode' that are normally passed in via the URL) and 'forms' (which can
174 175
 * be used to programmatically submit forms during the installation; the keys
 * of each element indicate the name of the installation task that the form
176
 * submission is for, and the values are used as the $form_state->getValues()
177 178
 * array that is passed on to the form submission via
 * \Drupal::formBuilder()->submitForm()).
179
 *
180
 * @see \Drupal\Core\Form\FormBuilderInterface::submitForm()
181 182 183 184 185 186 187 188
 */
function install_state_defaults() {
  $defaults = array(
    // The current task being processed.
    'active_task' => NULL,
    // The last task that was completed during the previous installation
    // request.
    'completed_task' => NULL,
189
    // TRUE when there are valid config directories.
190
    'config_verified' => FALSE,
191
    // TRUE when there is a valid database connection.
192
    'database_verified' => FALSE,
193 194
    // TRUE if database is empty & ready to install.
    'database_ready' => FALSE,
195 196 197 198 199
    // TRUE when a valid settings.php exists (containing both database
    // connection information and config directory names).
    'settings_verified' => FALSE,
    // TRUE when the base system has been installed and is ready to operate.
    'base_system_verified' => FALSE,
200 201 202
    // Whether a translation file for the selected language will be downloaded
    // from the translation server.
    'download_translation' => FALSE,
203 204 205
    // An array of forms to be programmatically submitted during the
    // installation. The keys of each element indicate the name of the
    // installation task that the form submission is for, and the values are
206
    // used as the $form_state->getValues() array that is passed on to the form
207
    // submission via \Drupal::formBuilder()->submitForm().
208 209 210 211 212 213 214 215 216 217 218 219 220 221
    'forms' => array(),
    // This becomes TRUE only at the end of the installation process, after
    // all available tasks have been completed and Drupal is fully installed.
    // It is used by the installer to store correct information in the database
    // about the completed installation, as well as to inform theme functions
    // that all tasks are finished (so that the task list can be displayed
    // correctly).
    'installation_finished' => FALSE,
    // Whether or not this installation is interactive. By default this will
    // be set to FALSE if settings are passed in to install_drupal().
    'interactive' => TRUE,
    // An array of parameters for the installation, pre-populated by the URL
    // or by the settings passed in to install_drupal(). This is primarily
    // used to store 'profile' (the name of the chosen installation profile)
222
    // and 'langcode' (the code of the chosen installation language), since
223 224 225 226 227 228 229 230
    // these settings need to persist from page request to page request before
    // the database is available for storage.
    'parameters' => array(),
    // Whether or not the parameters have changed during the current page
    // request. For interactive installations, this will trigger a page
    // redirect.
    'parameters_changed' => FALSE,
    // An array of information about the chosen installation profile. This will
231
    // be filled in based on the profile's .info.yml file.
232 233 234
    'profile_info' => array(),
    // An array of available installation profiles.
    'profiles' => array(),
235 236
    // The name of the theme to use during installation.
    'theme' => 'seven',
237 238 239 240
    // The server URL where the interface translation files can be downloaded.
    // Tokens in the pattern will be replaced by appropriate values for the
    // required translation file.
    'server_pattern' => 'http://ftp.drupal.org/files/translations/%core/%project/%project-%version.%language.po',
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
    // Installation tasks can set this to TRUE to force the page request to
    // end (even if there is no themable output), in the case of an interactive
    // installation. This is needed only rarely; for example, it would be used
    // by an installation task that prints JSON output rather than returning a
    // themed page. The most common example of this is during batch processing,
    // but the Drupal installer automatically takes care of setting this
    // parameter properly in that case, so that individual installation tasks
    // which implement the batch API do not need to set it themselves.
    'stop_page_request' => FALSE,
    // Installation tasks can set this to TRUE to indicate that the task should
    // be run again, even if it normally wouldn't be. This can be used, for
    // example, if a single task needs to be spread out over multiple page
    // requests, or if it needs to perform some validation before allowing
    // itself to be marked complete. The most common examples of this are batch
    // processing and form submissions, but the Drupal installer automatically
    // takes care of setting this parameter properly in those cases, so that
    // individual installation tasks which implement the batch API or form API
    // do not need to set it themselves.
    'task_not_complete' => FALSE,
    // A list of installation tasks which have already been performed during
    // the current page request.
    'tasks_performed' => array(),
263 264 265
    // An array of translation files URIs available for the installation. Keyed
    // by the translation language code.
    'translations' => array(),
266 267 268 269 270
  );
  return $defaults;
}

/**
271
 * Begins an installation request, modifying the installation state as needed.
272 273 274 275
 *
 * This function performs commands that must run at the beginning of every page
 * request. It throws an exception if the installation should not proceed.
 *
276 277 278 279
 * @param $class_loader
 *   The class loader. Normally Composer's ClassLoader, as included by the
 *   front controller, but may also be decorated; e.g.,
 *   \Symfony\Component\ClassLoader\ApcClassLoader.
280 281 282 283
 * @param $install_state
 *   An array of information about the current installation state. This is
 *   modified with information gleaned from the beginning of the page request.
 */
284
function install_begin_request($class_loader, &$install_state) {
285 286
  $request = Request::createFromGlobals();

287
  // Add any installation parameters passed in via the URL.
288
  if ($install_state['interactive']) {
289
    $install_state['parameters'] += $request->query->all();
290
  }
291 292 293 294 295

  // Validate certain core settings that are used throughout the installation.
  if (!empty($install_state['parameters']['profile'])) {
    $install_state['parameters']['profile'] = preg_replace('/[^a-zA-Z_0-9]/', '', $install_state['parameters']['profile']);
  }
296 297
  if (!empty($install_state['parameters']['langcode'])) {
    $install_state['parameters']['langcode'] = preg_replace('/[^a-zA-Z_0-9\-]/', '', $install_state['parameters']['langcode']);
298 299
  }

300
  // Allow command line scripts to override server variables used by Drupal.
301
  require_once __DIR__ . '/bootstrap.inc';
302

303 304 305 306 307 308
  // Before having installed the system module and being able to do a module
  // rebuild, prime the drupal_get_filename() static cache with the module's
  // exact location.
  // @todo Remove as part of https://www.drupal.org/node/2186491
  drupal_get_filename('module', 'system', 'core/modules/system/system.info.yml');

309
  // If the hash salt leaks, it becomes possible to forge a valid testing user
310 311 312 313
  // agent, install a new copy of Drupal, and take over the original site.
  // The user agent header is used to pass a database prefix in the request when
  // running tests. However, for security reasons, it is imperative that no
  // installation be permitted using such a prefix.
314 315
  $user_agent = $request->cookies->get('SIMPLETEST_USER_AGENT') ?: $request->server->get('HTTP_USER_AGENT');
  if ($install_state['interactive'] && strpos($user_agent, 'simpletest') !== FALSE && !drupal_valid_test_ua()) {
316
    header($request->server->get('SERVER_PROTOCOL') . ' 403 Forbidden');
317 318 319
    exit;
  }

320
  $site_path = DrupalKernel::findSitePath($request, FALSE);
321
  Settings::initialize(dirname(dirname(__DIR__)), $site_path, $class_loader);
322

323 324
  // Ensure that procedural dependencies are loaded as early as possible,
  // since the error/exception handlers depend on them.
325 326 327 328 329
  require_once __DIR__ . '/../modules/system/system.install';
  require_once __DIR__ . '/common.inc';
  require_once __DIR__ . '/file.inc';
  require_once __DIR__ . '/install.inc';
  require_once __DIR__ . '/schema.inc';
330 331 332
  require_once __DIR__ . '/database.inc';
  require_once __DIR__ . '/form.inc';
  require_once __DIR__ . '/batch.inc';
333 334

  // Load module basics (needed for hook invokes).
335 336
  include_once __DIR__ . '/module.inc';
  require_once __DIR__ . '/entity.inc';
337

338 339 340 341 342 343 344 345
  // Create a minimal mocked container to support calls to t() in the pre-kernel
  // base system verification code paths below. The strings are not actually
  // used or output for these calls.
  // @todo Separate API level checks from UI-facing error messages.
  $container = new ContainerBuilder();
  $container->setParameter('language.default_values', Language::$defaultValues);
  $container
    ->register('language.default', 'Drupal\Core\Language\LanguageDefault')
346
    ->addArgument('%language.default_values%');
347 348
  $container
    ->register('string_translation', 'Drupal\Core\StringTranslation\TranslationManager')
349
    ->addArgument(new Reference('language.default'));
350

351 352 353 354
  // Register the stream wrapper manager.
  $container
    ->register('stream_wrapper_manager', 'Drupal\Core\StreamWrapper\StreamWrapperManager')
    ->addMethodCall('setContainer', array(new Reference('service_container')));
355 356 357 358 359
  $container
    ->register('file_system', 'Drupal\Core\File\FileSystem')
    ->addArgument(new Reference('stream_wrapper_manager'))
    ->addArgument(Settings::getInstance())
    ->addArgument((new LoggerChannelFactory())->get('file'));
360

361
  \Drupal::setContainer($container);
362

363
  // Determine whether base system services are ready to operate.
364
  $install_state['config_verified'] = install_ensure_config_directory(CONFIG_SYNC_DIRECTORY);
365
  $install_state['database_verified'] = install_verify_database_settings($site_path);
366
  $install_state['settings_verified'] = $install_state['config_verified'] && $install_state['database_verified'];
367

368 369 370 371 372 373 374
  // Install factory tables only after checking the database.
  if ($install_state['database_verified'] && $install_state['database_ready']) {
    $container
      ->register('path.matcher', 'Drupal\Core\Path\PathMatcher')
      ->addArgument(new Reference('config.factory'));
  }

375
  if ($install_state['settings_verified']) {
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
    try {
      $system_schema = system_schema();
      end($system_schema);
      $table = key($system_schema);
      $install_state['base_system_verified'] = Database::getConnection()->schema()->tableExists($table);
    }
    catch (DatabaseExceptionWrapper $e) {
      // The last defined table of the base system_schema() does not exist yet.
      // $install_state['base_system_verified'] defaults to FALSE, so the code
      // following below will use the minimal installer service container.
      // As soon as the base system is verified here, the installer operates in
      // a full and regular Drupal environment, without any kind of exceptions.
    }
  }

391 392 393 394 395
  // Replace services with in-memory and null implementations. This kernel is
  // replaced with a regular one in drupal_install_system().
  if (!$install_state['base_system_verified']) {
    $environment = 'install';
    $GLOBALS['conf']['container_service_providers']['InstallerServiceProvider'] = 'Drupal\Core\Installer\InstallerServiceProvider';
396 397
  }
  else {
398 399
    $environment = 'prod';
  }
400

401
  // Only allow dumping the container once the hash salt has been created.
402
  $kernel = InstallerKernel::createFromRequest($request, $class_loader, $environment, (bool) Settings::get('hash_salt', FALSE));
403
  $kernel->setSitePath($site_path);
404 405
  $kernel->boot();
  $container = $kernel->getContainer();
406 407
  // If Drupal is being installed behind a proxy, configure the request.
  ReverseProxyMiddleware::setSettingsOnRequest($request, Settings::getInstance());
408

409
  // Register the file translation service.
410 411
  if (isset($GLOBALS['config']['locale.settings']['translation']['path'])) {
    $directory = $GLOBALS['config']['locale.settings']['translation']['path'];
412
  }
413
  else {
414
    $directory = $site_path . '/files/translations';
415 416 417 418
  }
  $container->set('string_translator.file_translation', new FileTranslation($directory));
  $container->get('string_translation')
    ->addTranslator($container->get('string_translator.file_translation'));
419

420
  // Add list of all available profiles to the installation state.
421
  $listing = new ExtensionDiscovery($container->get('app.root'));
422 423 424 425 426
  $listing->setProfileDirectories(array());
  $install_state['profiles'] += $listing->scan('profile');

  // Prime drupal_get_filename()'s static cache.
  foreach ($install_state['profiles'] as $name => $profile) {
427
    drupal_get_filename('profile', $name, $profile->getPathname());
428
  }
429

430 431 432 433 434 435 436 437
  if ($profile = _install_select_profile($install_state)) {
    $install_state['parameters']['profile'] = $profile;
    install_load_profile($install_state);
    if (isset($install_state['profile_info']['distribution']['install']['theme'])) {
      $install_state['theme'] = $install_state['profile_info']['distribution']['install']['theme'];
    }
  }

438 439 440 441 442 443 444 445 446 447 448 449 450
  // Use the language from the profile configuration, if available, to override
  // the language previously set in the parameters.
  if (isset($install_state['profile_info']['distribution']['langcode'])) {
    $install_state['parameters']['langcode'] = $install_state['profile_info']['distribution']['langcode'];
  }

  // Set the default language to the selected language, if any.
  if (isset($install_state['parameters']['langcode'])) {
    $default_language = new Language(array('id' => $install_state['parameters']['langcode']));
    $container->get('language.default')->set($default_language);
    \Drupal::translation()->setDefaultLangcode($install_state['parameters']['langcode']);
  }

451 452 453
  // Override the module list with a minimal set of modules.
  $module_handler = \Drupal::moduleHandler();
  if (!$module_handler->moduleExists('system')) {
454
    $module_handler->addModule('system', 'core/modules/system');
455 456
  }
  if ($profile && !$module_handler->moduleExists($profile)) {
457
    $module_handler->addProfile($profile, $install_state['profiles'][$profile]->getPath());
458 459
  }

460 461 462 463 464 465 466 467
  // Load all modules and perform request related initialization.
  $kernel->preHandle($request);

  // Initialize a route on this legacy request similar to
  // \Drupal\Core\DrupalKernel::prepareLegacyRequest() since normal routing
  // will not happen.
  $request->attributes->set(RouteObjectInterface::ROUTE_OBJECT, new Route('<none>'));
  $request->attributes->set(RouteObjectInterface::ROUTE_NAME, '<none>');
468

469 470 471 472 473 474
  // Prepare for themed output. We need to run this at the beginning of the
  // page request to avoid a different theme accidentally getting set. (We also
  // need to run it even in the case of command-line installations, to prevent
  // any code in the installer that happens to initialize the theme system from
  // accessing the database before it is set up yet.)
  drupal_maintenance_theme();
475

476
  if ($install_state['database_verified']) {
477 478 479 480 481 482
    // Verify the last completed task in the database, if there is one.
    $task = install_verify_completed_task();
  }
  else {
    $task = NULL;

483
    // Do not install over a configured settings.php.
484
    if (Database::getConnectionInfo()) {
485
      throw new AlreadyInstalledException($container->get('string_translation'));
486 487 488
    }
  }

489
  // Ensure that the active configuration is empty before installation starts.
490
  if ($install_state['config_verified'] && empty($task)) {
491
    if (count($kernel->getConfigStorage()->listAll())) {
492
      $task = NULL;
493
      throw new AlreadyInstalledException($container->get('string_translation'));
494 495 496
    }
  }

497 498 499 500 501
  // Modify the installation state as appropriate.
  $install_state['completed_task'] = $task;
}

/**
502
 * Runs all tasks for the current installation request.
503 504 505 506 507 508 509 510 511
 *
 * In the case of an interactive installation, all tasks will be attempted
 * until one is reached that has output which needs to be displayed to the
 * user, or until a page redirect is required. Otherwise, tasks will be
 * attempted until the installation is finished.
 *
 * @param $install_state
 *   An array of information about the current installation state. This is
 *   passed along to each task, so it can be modified if necessary.
512
 *
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
 * @return
 *   HTML output from the last completed task.
 */
function install_run_tasks(&$install_state) {
  do {
    // Obtain a list of tasks to perform. The list of tasks itself can be
    // dynamic (e.g., some might be defined by the installation profile,
    // which is not necessarily known until the earlier tasks have run),
    // so we regenerate the remaining tasks based on the installation state,
    // each time through the loop.
    $tasks_to_perform = install_tasks_to_perform($install_state);
    // Run the first task on the list.
    reset($tasks_to_perform);
    $task_name = key($tasks_to_perform);
    $task = array_shift($tasks_to_perform);
    $install_state['active_task'] = $task_name;
    $original_parameters = $install_state['parameters'];
    $output = install_run_task($task, $install_state);
531 532 533 534 535
    // Ensure the maintenance theme is initialized. If the install task has
    // rebuilt the container the active theme will not be set. This can occur if
    // the task has installed a module.
    drupal_maintenance_theme();

536 537 538 539 540 541 542 543
    $install_state['parameters_changed'] = ($install_state['parameters'] != $original_parameters);
    // Store this task as having been performed during the current request,
    // and save it to the database as completed, if we need to and if the
    // database is in a state that allows us to do so. Also mark the
    // installation as 'done' when we have run out of tasks.
    if (!$install_state['task_not_complete']) {
      $install_state['tasks_performed'][] = $task_name;
      $install_state['installation_finished'] = empty($tasks_to_perform);
544
      if ($task['run'] == INSTALL_TASK_RUN_IF_NOT_COMPLETED || $install_state['installation_finished']) {
545
        \Drupal::state()->set('install_task', $install_state['installation_finished'] ? 'done' : $task_name);
546 547 548 549 550 551 552 553 554 555 556 557
      }
    }
    // Stop when there are no tasks left. In the case of an interactive
    // installation, also stop if we have some output to send to the browser,
    // the URL parameters have changed, or an end to the page request was
    // specifically called for.
    $finished = empty($tasks_to_perform) || ($install_state['interactive'] && (isset($output) || $install_state['parameters_changed'] || $install_state['stop_page_request']));
  } while (!$finished);
  return $output;
}

/**
558
 * Runs an individual installation task.
559 560
 *
 * @param $task
561
 *   An array of information about the task to be run as returned by
562
 *   hook_install_tasks().
563 564 565
 * @param $install_state
 *   An array of information about the current installation state. This is
 *   passed in by reference so that it can be modified by the task.
566
 *
567 568 569 570 571 572 573
 * @return
 *   The output of the task function, if there is any.
 */
function install_run_task($task, &$install_state) {
  $function = $task['function'];

  if ($task['type'] == 'form') {
574
    return install_get_form($function, $install_state);
575 576 577 578
  }
  elseif ($task['type'] == 'batch') {
    // Start a new batch based on the task function, if one is not running
    // already.
579
    $current_batch = \Drupal::state()->get('install_current_batch');
580
    if (!$install_state['interactive'] || !$current_batch) {
581 582
      $batches = $function($install_state);
      if (empty($batches)) {
583 584 585 586
        // If the task did some processing and decided no batch was necessary,
        // there is nothing more to do here.
        return;
      }
587 588 589
      // Create a one item list of batches if only one batch was provided.
      if (isset($batches['operations'])) {
        $batches = array($batches);
590
      }
591 592 593 594 595 596 597 598 599 600 601 602
      foreach ($batches as $batch) {
        batch_set($batch);
        // For interactive batches, we need to store the fact that this batch
        // task is currently running. Otherwise, we need to make sure the batch
        // will complete in one page request.
        if ($install_state['interactive']) {
          \Drupal::state()->set('install_current_batch', $function);
        }
        else {
          $batch =& batch_get();
          $batch['progressive'] = FALSE;
        }
603 604 605
      }
      // Process the batch. For progressive batches, this will redirect.
      // Otherwise, the batch will complete.
606 607
      // Disable the default script for the URL and clone the object, as
      // batch_process() will add additional options to the batch URL.
608
      $url = Url::fromUri('base:install.php', ['query' => $install_state['parameters'], 'script' => '']);
609
      $response = batch_process($url, clone $url);
610
      if ($response instanceof Response) {
611 612 613
        if ($session = \Drupal::request()->getSession()) {
          $session->save();
        }
614 615 616 617
        // Send the response.
        $response->send();
        exit;
      }
618 619 620 621
    }
    // If we are in the middle of processing this batch, keep sending back
    // any output from the batch process, until the task is complete.
    elseif ($current_batch == $function) {
622
      $output = _batch_page(\Drupal::request());
623
      // Because Batch API now returns a JSON response for intermediary steps,
624 625 626 627
      // but the installer doesn't handle Response objects yet, just send the
      // output here and emulate the old model.
      // @todo Replace this when we refactor the installer to use a request-
      //   response workflow.
628 629
      if ($output instanceof Response) {
        $output->send();
630
        $output = NULL;
631
      }
632 633 634
      // The task is complete when we try to access the batch page and receive
      // FALSE in return, since this means we are at a URL where we are no
      // longer requesting a batch ID.
635
      if ($output === FALSE) {
636
        // Return nothing so the next task will run in the same request.
637
        \Drupal::state()->delete('install_current_batch');
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
        return;
      }
      else {
        // We need to force the page request to end if the task is not
        // complete, since the batch API sometimes prints JSON output
        // rather than returning a themed page.
        $install_state['task_not_complete'] = $install_state['stop_page_request'] = TRUE;
        return $output;
      }
    }
  }

  else {
    // For normal tasks, just return the function result, whatever it is.
    return $function($install_state);
  }
}

/**
657
 * Returns a list of tasks to perform during the current installation request.
658 659 660 661 662 663 664
 *
 * Note that the list of tasks can change based on the installation state as
 * the page request evolves (for example, if an installation profile hasn't
 * been selected yet, we don't yet know which profile tasks need to be run).
 *
 * @param $install_state
 *   An array of information about the current installation state.
665
 *
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
 * @return
 *   A list of tasks to be performed, with associated metadata.
 */
function install_tasks_to_perform($install_state) {
  // Start with a list of all currently available tasks.
  $tasks = install_tasks($install_state);
  foreach ($tasks as $name => $task) {
    // Remove any tasks that were already performed or that never should run.
    // Also, if we started this page request with an indication of the last
    // task that was completed, skip that task and all those that come before
    // it, unless they are marked as always needing to run.
    if ($task['run'] == INSTALL_TASK_SKIP || in_array($name, $install_state['tasks_performed']) || (!empty($install_state['completed_task']) && empty($completed_task_found) && $task['run'] != INSTALL_TASK_RUN_IF_REACHED)) {
      unset($tasks[$name]);
    }
    if (!empty($install_state['completed_task']) && $name == $install_state['completed_task']) {
      $completed_task_found = TRUE;
    }
  }
  return $tasks;
}

/**
688
 * Returns a list of all tasks the installer currently knows about.
689 690 691 692 693 694 695
 *
 * This function will return tasks regardless of whether or not they are
 * intended to run on the current page request. However, the list can change
 * based on the installation state (for example, if an installation profile
 * hasn't been selected yet, we don't yet know which profile tasks will be
 * available).
 *
696 697
 * You can override this using hook_install_tasks() or
 * hook_install_tasks_alter().
698
 *
699 700
 * @param $install_state
 *   An array of information about the current installation state.
701
 *
702
 * @return
703 704
 *   A list of tasks, with associated metadata as returned by
 *   hook_install_tasks().
705 706
 */
function install_tasks($install_state) {
707 708
  // Determine whether a translation file must be imported during the
  // 'install_import_translations' task. Import when a non-English language is
709 710 711
  // available and selected. Also we will need translations even if the
  // installer language is English but there are other languages on the system.
  $needs_translations = (count($install_state['translations']) > 1 && !empty($install_state['parameters']['langcode']) && $install_state['parameters']['langcode'] != 'en') || \Drupal::languageManager()->isMultilingual();
712 713 714 715
  // Determine whether a translation file must be downloaded during the
  // 'install_download_translation' task. Download when a non-English language
  // is selected, but no translation is yet in the translations directory.
  $needs_download = isset($install_state['parameters']['langcode']) && !isset($install_state['translations'][$install_state['parameters']['langcode']]) && $install_state['parameters']['langcode'] != 'en';
716

717
  // Start with the core installation tasks that run before handing control
718
  // to the installation profile.
719
  $tasks = array(
720
    'install_select_language' => array(
721
      'display_name' => t('Choose language'),
722 723
      'run' => INSTALL_TASK_RUN_IF_REACHED,
    ),
724 725 726
    'install_download_translation' => array(
      'run' => $needs_download ? INSTALL_TASK_RUN_IF_REACHED : INSTALL_TASK_SKIP,
    ),
727
    'install_select_profile' => array(
728
      'display_name' => t('Choose profile'),
729
      'display' => empty($install_state['profile_info']['distribution']['name']) && count($install_state['profiles']) != 1,
730 731 732 733 734 735
      'run' => INSTALL_TASK_RUN_IF_REACHED,
    ),
    'install_load_profile' => array(
      'run' => INSTALL_TASK_RUN_IF_REACHED,
    ),
    'install_verify_requirements' => array(
736
      'display_name' => t('Verify requirements'),
737 738
    ),
    'install_settings_form' => array(
739
      'display_name' => t('Set up database'),
740
      'type' => 'form',
741 742 743
      // Even though the form only allows the user to enter database settings,
      // we still need to display it if settings.php is invalid in any way,
      // since the form submit handler is where settings.php is rewritten.
744
      'run' => $install_state['settings_verified'] ? INSTALL_TASK_SKIP : INSTALL_TASK_RUN_IF_NOT_COMPLETED,
745
      'function' => 'Drupal\Core\Installer\Form\SiteSettingsForm',
746
    ),
747 748
    'install_write_profile' => array(
    ),
749 750 751
    'install_verify_database_ready' => array(
      'run' => $install_state['database_ready'] ? INSTALL_TASK_SKIP : INSTALL_TASK_RUN_IF_NOT_COMPLETED,
    ),
752
    'install_base_system' => array(
753
      'run' => $install_state['base_system_verified'] ? INSTALL_TASK_SKIP : INSTALL_TASK_RUN_IF_NOT_COMPLETED,
754
    ),
755
    // All tasks below are executed in a regular, full Drupal environment.
756 757 758 759
    'install_bootstrap_full' => array(
      'run' => INSTALL_TASK_RUN_IF_REACHED,
    ),
    'install_profile_modules' => array(
760
      'display_name' => t('Install site'),
761 762
      'type' => 'batch',
    ),
763 764
    'install_profile_themes' => array(
    ),
765 766
    'install_install_profile' => array(
    ),
767
    'install_import_translations' => array(
768
      'display_name' => t('Set up translations'),
769 770 771 772 773
      'display' => $needs_translations,
      'type' => 'batch',
      'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
    ),
    'install_configure_form' => array(
774
      'display_name' => t('Configure site'),
775
      'type' => 'form',
776
      'function' => 'Drupal\Core\Installer\Form\SiteConfigureForm',
777 778 779 780 781
    ),
  );

  // Now add any tasks defined by the installation profile.
  if (!empty($install_state['parameters']['profile'])) {
782 783
    // Load the profile install file, because it is not always loaded when
    // hook_install_tasks() is invoked (e.g. batch processing).
784
    $profile = $install_state['parameters']['profile'];
785
    $profile_install_file = $install_state['profiles'][$profile]->getPath() . '/' . $profile . '.install';
786
    if (file_exists($profile_install_file)) {
787
      include_once \Drupal::root() . '/' . $profile_install_file;
788
    }
789 790 791 792 793 794 795 796 797 798 799
    $function = $install_state['parameters']['profile'] . '_install_tasks';
    if (function_exists($function)) {
      $result = $function($install_state);
      if (is_array($result)) {
        $tasks += $result;
      }
    }
  }

  // Finish by adding the remaining core tasks.
  $tasks += array(
800
    'install_finish_translations' => array(
801
      'display_name' => t('Finish translations'),
802 803 804 805 806 807 808 809 810 811
      'display' => $needs_translations,
      'type' => 'batch',
      'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
    ),
    'install_finished' => array(
    ),
  );

  // Allow the installation profile to modify the full list of tasks.
  if (!empty($install_state['parameters']['profile'])) {
812
    $profile = $install_state['parameters']['profile'];
813
    if ($install_state['profiles'][$profile]->load()) {
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
      $function = $install_state['parameters']['profile'] . '_install_tasks_alter';
      if (function_exists($function)) {
        $function($tasks, $install_state);
      }
    }
  }

  // Fill in default parameters for each task before returning the list.
  foreach ($tasks as $task_name => &$task) {
    $task += array(
      'display_name' => NULL,
      'display' => !empty($task['display_name']),
      'type' => 'normal',
      'run' => INSTALL_TASK_RUN_IF_NOT_COMPLETED,
      'function' => $task_name,
    );
  }
  return $tasks;
}

/**
835
 * Returns a list of tasks that should be displayed to the end user.
836 837
 *
 * The output of this function is a list suitable for sending to
838
 * maintenance-task-list.html.twig.
839 840 841
 *
 * @param $install_state
 *   An array of information about the current installation state.
842
 *
843 844 845 846
 * @return
 *   A list of tasks, with keys equal to the machine-readable task name and
 *   values equal to the name that should be displayed.
 *
847
 * @see maintenance-task-list.html.twig
848 849 850 851 852 853 854 855 856 857 858
 */
function install_tasks_to_display($install_state) {
  $displayed_tasks = array();
  foreach (install_tasks($install_state) as $name => $task) {
    if ($task['display']) {
      $displayed_tasks[$name] = $task['display_name'];
    }
  }
  return $displayed_tasks;
}

859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
/**
 * Builds and processes a form for the installer environment.
 *
 * Ensures that FormBuilder does not redirect after submitting a form, since the
 * installer uses a custom step/flow logic via install_run_tasks().
 *
 * @param string|array $form_id
 *   The form ID to build and process.
 * @param array $install_state
 *   The current state of the installation.
 *
 * @return array|null
 *   A render array containing the form to render, or NULL in case the form was
 *   successfully submitted.
 *
 * @throws \Drupal\Core\Installer\Exception\InstallerException
 */
function install_get_form($form_id, array &$install_state) {
  // Ensure the form will not redirect, since install_run_tasks() uses a custom
  // redirection logic.
879 880 881
  $form_state = (new FormState())
    ->addBuildInfo('args', [&$install_state])
    ->disableRedirect();
882
  $form_builder = \Drupal::formBuilder();
883
  if ($install_state['interactive']) {
884
    $form = $form_builder->buildForm($form_id, $form_state);
885 886
    // If the form submission was not successful, the form needs to be rendered,
    // which means the task is not complete yet.
887
    if (!$form_state->isExecuted()) {
888 889 890 891 892 893 894
      $install_state['task_not_complete'] = TRUE;
      return $form;
    }
  }
  else {
    // For non-interactive installs, submit the form programmatically with the
    // values taken from the installation state.
895 896
    $install_form_id = $form_builder->getFormId($form_id, $form_state);
    if (!empty($install_state['forms'][$install_form_id])) {
897
      $form_state->setValues($install_state['forms'][$install_form_id]);
898
    }
899
    $form_builder->submitForm($form_id, $form_state);
900 901

    // Throw an exception in case of any form validation error.
902
    if ($errors = $form_state->getErrors()) {
903 904 905 906 907
      throw new InstallerException(implode("\n", $errors));
    }
  }
}

908
/**
909
 * Returns the URL that should be redirected to during an installation request.
910 911 912 913 914
 *
 * The output of this function is suitable for sending to install_goto().
 *
 * @param $install_state
 *   An array of information about the current installation state.
915
 *
916 917 918 919 920 921
 * @return
 *   The URL to redirect to.
 *
 * @see install_full_redirect_url()
 */
function install_redirect_url($install_state) {
922
  return 'core/install.php?' . UrlHelper::buildQuery($install_state['parameters']);
923 924 925
}

/**
926
 * Returns the complete URL redirected to during an installation request.
927 928 929
 *
 * @param $install_state
 *   An array of information about the current installation state.
930
 *
931 932 933 934 935 936 937 938 939 940 941
 * @return
 *   The complete URL to redirect to.
 *
 * @see install_redirect_url()
 */
function install_full_redirect_url($install_state) {
  global $base_url;
  return $base_url . '/' . install_redirect_url($install_state);
}

/**
942
 * Displays themed installer output and ends the page request.
943
 *
944
 * Installation tasks should use #title to set the desired page
945 946 947 948 949 950 951 952 953
 * title, but otherwise this function takes care of theming the overall page
 * output during every step of the installation.
 *
 * @param $output
 *   The content to display on the main part of the page.
 * @param $install_state
 *   An array of information about the current installation state.
 */
function install_display_output($output, $install_state) {
954 955 956 957 958
  // Ensure the maintenance theme is initialized.
  // The regular initialization call in install_begin_request() may not be
  // reached in case of an early installer error.
  drupal_maintenance_theme();

959 960 961 962 963 964 965 966 967 968 969 970
  // Prevent install.php from being indexed when installed in a sub folder.
  // robots.txt rules are not read if the site is within domain.com/subfolder
  // resulting in /subfolder/install.php being found through search engines.
  // When settings.php is writeable this can be used via an external database
  // leading a malicious user to gain php access to the server.
  $noindex_meta_tag = array(
    '#tag' => 'meta',
    '#attributes' => array(
      'name' => 'robots',
      'content' => 'noindex, nofollow',
    ),
  );
971
  $output['#attached']['html_head'][] = [$noindex_meta_tag, 'install_meta_robots'];
972

973 974 975
  // Only show the task list if there is an active task; otherwise, the page
  // request has ended before tasks have even been started, so there is nothing
  // meaningful to show.
976
  $regions = array();
977 978 979 980
  if (isset($install_state['active_task'])) {
    // Let the theming function know when every step of the installation has
    // been completed.
    $active_task = $install_state['installation_finished'] ? NULL : $install_state['active_task'];
981
    $task_list = array(
982
      '#theme' => 'maintenance_task_list',