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

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

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

41
/**
42
 * Do not run the task during the current installation request.
43 44 45 46 47 48 49 50 51
 *
 * 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.
 */
52
const INSTALL_TASK_SKIP = 1;
53 54

/**
55
 * Run the task on each installation request that reaches it.
56 57 58
 *
 * This is primarily used by the Drupal installer for bootstrap-related tasks.
 */
59
const INSTALL_TASK_RUN_IF_REACHED = 2;
60 61

/**
62
 * Run the task on each installation request until the database is set up.
63 64 65 66 67 68 69 70
 *
 * 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.
 */
71
const INSTALL_TASK_RUN_IF_NOT_COMPLETED = 3;
72 73

/**
74
 * Installs Drupal either interactively or via an array of passed-in settings.
75 76 77 78 79 80 81 82 83
 *
 * 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).
 *
84 85 86 87
 * @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.
88 89 90 91 92 93 94 95
 * @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.
96 97 98
 * @param callable $callback
 *   (optional) A callback to allow command line processes to update a progress
 *   bar. The callback is passed the $install_state variable.
99 100 101
 *
 * @see install_state_defaults()
 */
102
function install_drupal($class_loader, $settings = [], callable $callback = NULL) {
103 104 105
  // 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
106
  if (is_array($class_loader) && $settings === []) {
107
    $settings = $class_loader;
108
    $class_loader = require __DIR__ . '/../../autoload.php';
109 110
  }

111 112 113 114 115
  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);
116
  $install_state = $settings + ['interactive' => $interactive] + install_state_defaults();
117

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

137 138 139 140 141 142 143
  // 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'])) {
144
    unset($GLOBALS['install_state']);
145 146 147
    // If installation is finished ensure any further container rebuilds do not
    // use the installer's service provider.
    unset($GLOBALS['conf']['container_service_providers']['InstallerServiceProvider']);
148 149
  }

150 151 152
  // 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.
153
  if ($state['interactive']) {
154 155 156 157
    // If a session has been initiated in this request, make sure to save it.
    if ($session = \Drupal::request()->getSession()) {
      $session->save();
    }
158
    if ($state['parameters_changed']) {
159
      // Redirect to the correct page if the URL parameters have changed.
160
      install_goto(install_redirect_url($state));
161 162 163 164 165
    }
    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.
166
      install_display_output($output, $state);
167
    }
168 169
    elseif ($state['installation_finished']) {
      // Redirect to the newly installed site.
170 171 172 173 174
      $finish_url = '';
      if (isset($install_state['profile_info']['distribution']['install']['finish_url'])) {
        $finish_url = $install_state['profile_info']['distribution']['install']['finish_url'];
      }
      install_goto($finish_url);
175
    }
176 177 178 179
  }
}

/**
180
 * Returns an array of default settings for the global installation state.
181 182 183 184 185 186 187 188
 *
 * 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
189
 * 'langcode' that are normally passed in via the URL) and 'forms' (which can
190 191
 * be used to programmatically submit forms during the installation; the keys
 * of each element indicate the name of the installation task that the form
192
 * submission is for, and the values are used as the $form_state->getValues()
193 194
 * array that is passed on to the form submission via
 * \Drupal::formBuilder()->submitForm()).
195
 *
196
 * @see \Drupal\Core\Form\FormBuilderInterface::submitForm()
197 198
 */
function install_state_defaults() {
199
  $defaults = [
200 201 202 203 204
    // The current task being processed.
    'active_task' => NULL,
    // The last task that was completed during the previous installation
    // request.
    'completed_task' => NULL,
205 206 207 208
    // Partial configuration cached during an installation from existing config.
    'config' => NULL,
    // The path to the configuration to install when installing from config.
    'config_install_path' => NULL,
209
    // TRUE when there are valid config directories.
210
    'config_verified' => FALSE,
211
    // TRUE when there is a valid database connection.
212
    'database_verified' => FALSE,
213 214
    // TRUE if database is empty & ready to install.
    'database_ready' => FALSE,
215 216 217 218 219
    // 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,
220 221 222
    // Whether a translation file for the selected language will be downloaded
    // from the translation server.
    'download_translation' => FALSE,
223 224 225
    // 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
226
    // used as the $form_state->getValues() array that is passed on to the form
227
    // submission via \Drupal::formBuilder()->submitForm().
228
    'forms' => [],
229 230 231 232 233 234 235 236 237 238 239 240 241
    // 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)
242
    // and 'langcode' (the code of the chosen installation language), since
243 244
    // these settings need to persist from page request to page request before
    // the database is available for storage.
245
    'parameters' => [],
246 247 248 249 250
    // 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
251
    // be filled in based on the profile's .info.yml file.
252
    'profile_info' => [],
253
    // An array of available installation profiles.
254
    'profiles' => [],
255 256
    // The name of the theme to use during installation.
    'theme' => 'seven',
257 258 259 260
    // 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',
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
    // 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.
282
    'tasks_performed' => [],
283 284
    // An array of translation files URIs available for the installation. Keyed
    // by the translation language code.
285 286
    'translations' => [],
  ];
287 288 289 290
  return $defaults;
}

/**
291
 * Begins an installation request, modifying the installation state as needed.
292 293 294 295
 *
 * This function performs commands that must run at the beginning of every page
 * request. It throws an exception if the installation should not proceed.
 *
296 297 298 299
 * @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.
300 301 302
 * @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.
303 304
 *
 * @see install_drupal()
305
 */
306
function install_begin_request($class_loader, &$install_state) {
307 308
  $request = Request::createFromGlobals();

309
  // Add any installation parameters passed in via the URL.
310
  if ($install_state['interactive']) {
311
    $install_state['parameters'] += $request->query->all();
312
  }
313 314 315 316 317

  // 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']);
  }
318 319
  if (!empty($install_state['parameters']['langcode'])) {
    $install_state['parameters']['langcode'] = preg_replace('/[^a-zA-Z_0-9\-]/', '', $install_state['parameters']['langcode']);
320 321
  }

322
  // Allow command line scripts to override server variables used by Drupal.
323
  require_once __DIR__ . '/bootstrap.inc';
324

325
  // If the hash salt leaks, it becomes possible to forge a valid testing user
326 327 328 329
  // 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.
330 331
  $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()) {
332
    header($request->server->get('SERVER_PROTOCOL') . ' 403 Forbidden');
333 334
    exit;
  }
335 336 337 338 339 340 341 342
  if ($install_state['interactive'] && drupal_valid_test_ua()) {
    // Set the default timezone. While this doesn't cause any tests to fail, PHP
    // complains if 'date.timezone' is not set in php.ini. The Australia/Sydney
    // timezone is chosen so all tests are run using an edge case scenario
    // (UTC+10  and DST). This choice is made to prevent timezone related
    // regressions and reduce the fragility of the testing system in general.
    date_default_timezone_set('Australia/Sydney');
  }
343

344
  $site_path = empty($install_state['site_path']) ? DrupalKernel::findSitePath($request, FALSE) : $install_state['site_path'];
345
  Settings::initialize(dirname(dirname(__DIR__)), $site_path, $class_loader);
346

347 348
  // Ensure that procedural dependencies are loaded as early as possible,
  // since the error/exception handlers depend on them.
349 350 351 352 353
  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';
354 355 356
  require_once __DIR__ . '/database.inc';
  require_once __DIR__ . '/form.inc';
  require_once __DIR__ . '/batch.inc';
357 358

  // Load module basics (needed for hook invokes).
359 360
  include_once __DIR__ . '/module.inc';
  require_once __DIR__ . '/entity.inc';
361

362 363 364 365 366 367 368 369
  // 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')
370
    ->addArgument('%language.default_values%');
371 372
  $container
    ->register('string_translation', 'Drupal\Core\StringTranslation\TranslationManager')
373
    ->addArgument(new Reference('language.default'));
374

375 376 377
  // Register the stream wrapper manager.
  $container
    ->register('stream_wrapper_manager', 'Drupal\Core\StreamWrapper\StreamWrapperManager')
378
    ->addMethodCall('setContainer', [new Reference('service_container')]);
379 380 381 382 383
  $container
    ->register('file_system', 'Drupal\Core\File\FileSystem')
    ->addArgument(new Reference('stream_wrapper_manager'))
    ->addArgument(Settings::getInstance())
    ->addArgument((new LoggerChannelFactory())->get('file'));
384

385
  \Drupal::setContainer($container);
386

387
  // Determine whether base system services are ready to operate.
388 389 390 391 392 393 394
  try {
    $sync_directory = config_get_config_directory(CONFIG_SYNC_DIRECTORY);
    $install_state['config_verified'] = file_exists($sync_directory);
  }
  catch (Exception $e) {
    $install_state['config_verified'] = FALSE;
  }
395
  $install_state['database_verified'] = install_verify_database_settings($site_path);
396 397 398
  // A valid settings.php has database settings and a hash_salt value. Other
  // settings like config_directories will be checked by system_requirements().
  $install_state['settings_verified'] = $install_state['database_verified'] && (bool) Settings::get('hash_salt', FALSE);
399

400 401 402 403 404 405 406
  // 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'));
  }

407
  if ($install_state['settings_verified']) {
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
    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.
    }
  }

423 424 425 426 427
  // 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';
428 429
  }
  else {
430
    $environment = 'prod';
431
    $GLOBALS['conf']['container_service_providers']['InstallerServiceProvider'] = 'Drupal\Core\Installer\NormalInstallerServiceProvider';
432
  }
433
  $GLOBALS['conf']['container_service_providers']['InstallerConfigOverride'] = 'Drupal\Core\Installer\ConfigOverride';
434

435 436 437 438 439
  // Only allow dumping the container once the hash salt has been created. Note,
  // InstallerKernel::createFromRequest() is not used because Settings is
  // already initialized.
  $kernel = new InstallerKernel($environment, $class_loader, (bool) Settings::get('hash_salt', FALSE));
  $kernel::bootEnvironment();
440
  $kernel->setSitePath($site_path);
441 442
  $kernel->boot();
  $container = $kernel->getContainer();
443 444
  // If Drupal is being installed behind a proxy, configure the request.
  ReverseProxyMiddleware::setSettingsOnRequest($request, Settings::getInstance());
445

446
  // Register the file translation service.
447 448
  if (isset($GLOBALS['config']['locale.settings']['translation']['path'])) {
    $directory = $GLOBALS['config']['locale.settings']['translation']['path'];
449
  }
450
  else {
451
    $directory = $site_path . '/files/translations';
452 453 454 455
  }
  $container->set('string_translator.file_translation', new FileTranslation($directory));
  $container->get('string_translation')
    ->addTranslator($container->get('string_translator.file_translation'));
456

457
  // Add list of all available profiles to the installation state.
458
  $listing = new ExtensionDiscovery($container->get('app.root'));
459
  $listing->setProfileDirectories([]);
460 461 462 463
  $install_state['profiles'] += $listing->scan('profile');

  // Prime drupal_get_filename()'s static cache.
  foreach ($install_state['profiles'] as $name => $profile) {
464
    drupal_get_filename('profile', $name, $profile->getPathname());
465 466 467
    // drupal_get_filename() is called both with 'module' and 'profile', see
    // \Drupal\Core\Config\ConfigInstaller::getProfileStorages for example.
    drupal_get_filename('module', $name, $profile->getPathname());
468
  }
469

470 471 472 473 474 475 476 477
  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'];
    }
  }

478 479 480 481 482 483
  // Before having installed the system module and being able to do a module
  // rebuild, prime the drupal_get_filename() static cache with the system
  // module's location.
  // @todo Remove as part of https://www.drupal.org/node/2186491
  drupal_get_filename('module', 'system', 'core/modules/system/system.info.yml');

484 485 486 487 488 489 490
  // Use the language from profile configuration if available.
  if (!empty($install_state['config_install_path']) && $install_state['config']['system.site']) {
    $install_state['parameters']['langcode'] = $install_state['config']['system.site']['default_langcode'];
  }
  elseif (isset($install_state['profile_info']['distribution']['langcode'])) {
    // Otherwise, Use the language from the profile configuration, if available,
    // to override the language previously set in the parameters.
491 492 493 494 495
    $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'])) {
496
    $default_language = new Language(['id' => $install_state['parameters']['langcode']]);
497 498 499 500
    $container->get('language.default')->set($default_language);
    \Drupal::translation()->setDefaultLangcode($install_state['parameters']['langcode']);
  }

501 502 503
  // Override the module list with a minimal set of modules.
  $module_handler = \Drupal::moduleHandler();
  if (!$module_handler->moduleExists('system')) {
504
    $module_handler->addModule('system', 'core/modules/system');
505 506
  }
  if ($profile && !$module_handler->moduleExists($profile)) {
507
    $module_handler->addProfile($profile, $install_state['profiles'][$profile]->getPath());
508 509
  }

510 511 512 513 514 515 516 517
  // 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>');
518

519 520 521 522 523 524
  // 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();
525

526
  if ($install_state['database_verified']) {
527 528 529 530 531 532
    // Verify the last completed task in the database, if there is one.
    $task = install_verify_completed_task();
  }
  else {
    $task = NULL;

533
    // Do not install over a configured settings.php.
534
    if (Database::getConnectionInfo()) {
535
      throw new AlreadyInstalledException($container->get('string_translation'));
536 537 538
    }
  }

539
  // Ensure that the active configuration is empty before installation starts.
540
  if ($install_state['config_verified'] && empty($task)) {
541
    if (count($kernel->getConfigStorage()->listAll())) {
542
      $task = NULL;
543
      throw new AlreadyInstalledException($container->get('string_translation'));
544 545 546
    }
  }

547 548 549 550 551
  // Modify the installation state as appropriate.
  $install_state['completed_task'] = $task;
}

/**
552
 * Runs all tasks for the current installation request.
553 554 555 556 557 558 559 560 561
 *
 * 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.
562 563 564
 * @param callable $callback
 *   (optional) A callback to allow command line processes to update a progress
 *   bar. The callback is passed the $install_state variable.
565
 *
566 567 568
 * @return
 *   HTML output from the last completed task.
 */
569
function install_run_tasks(&$install_state, callable $callback = NULL) {
570 571 572 573 574 575 576 577 578 579 580 581 582 583
  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);
584 585 586 587 588
    // 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();

589 590 591 592 593 594 595 596
    $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);
597
      if ($task['run'] == INSTALL_TASK_RUN_IF_NOT_COMPLETED || $install_state['installation_finished']) {
598
        \Drupal::state()->set('install_task', $install_state['installation_finished'] ? 'done' : $task_name);
599 600
      }
    }
601 602 603
    if ($callback) {
      $callback($install_state);
    }
604 605 606 607 608 609 610 611 612 613
    // 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;
}

/**
614
 * Runs an individual installation task.
615 616
 *
 * @param $task
617
 *   An array of information about the task to be run as returned by
618
 *   hook_install_tasks().
619 620 621
 * @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.
622
 *
623 624 625 626 627 628 629
 * @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') {
630
    return install_get_form($function, $install_state);
631 632 633 634
  }
  elseif ($task['type'] == 'batch') {
    // Start a new batch based on the task function, if one is not running
    // already.
635
    $current_batch = \Drupal::state()->get('install_current_batch');
636
    if (!$install_state['interactive'] || !$current_batch) {
637 638
      $batches = $function($install_state);
      if (empty($batches)) {
639 640 641 642
        // If the task did some processing and decided no batch was necessary,
        // there is nothing more to do here.
        return;
      }
643 644
      // Create a one item list of batches if only one batch was provided.
      if (isset($batches['operations'])) {
645
        $batches = [$batches];
646
      }
647 648 649 650 651 652 653 654 655 656 657 658
      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;
        }
659 660 661
      }
      // Process the batch. For progressive batches, this will redirect.
      // Otherwise, the batch will complete.
662 663
      // Disable the default script for the URL and clone the object, as
      // batch_process() will add additional options to the batch URL.
664
      $url = Url::fromUri('base:install.php', ['query' => $install_state['parameters'], 'script' => '']);
665
      $response = batch_process($url, clone $url);
666
      if ($response instanceof Response) {
667 668 669
        if ($session = \Drupal::request()->getSession()) {
          $session->save();
        }
670 671 672 673
        // Send the response.
        $response->send();
        exit;
      }
674 675 676 677
    }
    // 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) {
678
      $output = _batch_page(\Drupal::request());
679
      // Because Batch API now returns a JSON response for intermediary steps,
680 681 682 683
      // 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.
684 685
      if ($output instanceof Response) {
        $output->send();
686
        $output = NULL;
687
      }
688 689 690
      // 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.
691
      if ($output === FALSE) {
692
        // Return nothing so the next task will run in the same request.
693
        \Drupal::state()->delete('install_current_batch');
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
        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);
  }
}

/**
713
 * Returns a list of tasks to perform during the current installation request.
714 715 716 717 718 719 720
 *
 * 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.
721
 *
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
 * @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;
}

/**
744
 * Returns a list of all tasks the installer currently knows about.
745 746 747 748 749 750 751
 *
 * 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).
 *
752 753
 * You can override this using hook_install_tasks() or
 * hook_install_tasks_alter().
754
 *
755 756
 * @param $install_state
 *   An array of information about the current installation state.
757
 *
758
 * @return
759 760
 *   A list of tasks, with associated metadata as returned by
 *   hook_install_tasks().
761 762
 */
function install_tasks($install_state) {
763 764
  // Determine whether a translation file must be imported during the
  // 'install_import_translations' task. Import when a non-English language is
765 766 767
  // 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();
768 769 770 771
  // 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';
772

773
  // Start with the core installation tasks that run before handing control
774
  // to the installation profile.
775 776
  $tasks = [
    'install_select_language' => [
777
      'display_name' => t('Choose language'),
778
      'run' => INSTALL_TASK_RUN_IF_REACHED,
779 780
    ],
    'install_download_translation' => [
781
      'run' => $needs_download ? INSTALL_TASK_RUN_IF_REACHED : INSTALL_TASK_SKIP,
782 783
    ],
    'install_select_profile' => [
784
      'display_name' => t('Choose profile'),
785
      'display' => empty($install_state['profile_info']['distribution']['name']) && count($install_state['profiles']) != 1,
786
      'run' => INSTALL_TASK_RUN_IF_REACHED,
787 788
    ],
    'install_load_profile' => [
789
      'run' => INSTALL_TASK_RUN_IF_REACHED,
790 791
    ],
    'install_verify_requirements' => [
792
      'display_name' => t('Verify requirements'),
793 794
    ],
    'install_settings_form' => [
795
      'display_name' => t('Set up database'),
796
      'type' => 'form',
797 798 799
      // 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.
800
      'run' => $install_state['settings_verified'] ? INSTALL_TASK_SKIP : INSTALL_TASK_RUN_IF_NOT_COMPLETED,
801
      'function' => 'Drupal\Core\Installer\Form\SiteSettingsForm',
802
    ],
803
    'install_write_profile' => [],
804
    'install_verify_database_ready' => [
805
      'run' => $install_state['database_ready'] ? INSTALL_TASK_SKIP : INSTALL_TASK_RUN_IF_NOT_COMPLETED,
806 807
    ],
    'install_base_system' => [
808
      'run' => $install_state['base_system_verified'] ? INSTALL_TASK_SKIP : INSTALL_TASK_RUN_IF_NOT_COMPLETED,
809
    ],
810
    // All tasks below are executed in a regular, full Drupal environment.
811
    'install_bootstrap_full' => [
812
      'run' => INSTALL_TASK_RUN_IF_REACHED,
813 814
    ],
    'install_profile_modules' => [
815
      'display_name' => t('Install site'),
816
      'type' => 'batch',
817
    ],
818 819
    'install_profile_themes' => [],
    'install_install_profile' => [],
820
    'install_import_translations' => [
821
      'display_name' => t('Set up translations'),
822 823 824
      'display' => $needs_translations,
      'type' => 'batch',
      'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
825 826
    ],
    'install_configure_form' => [
827
      'display_name' => t('Configure site'),
828
      'type' => 'form',
829
      'function' => 'Drupal\Core\Installer\Form\SiteConfigureForm',
830 831
    ],
  ];
832

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
  if (!empty($install_state['config_install_path'])) {
    // The chosen profile indicates that rather than installing a new site, an
    // instance of the same site should be installed from the given
    // configuration.
    // That means we need to remove the steps installing the extensions and
    // replace them with a configuration synchronization step.
    unset($tasks['install_download_translation']);
    $key = array_search('install_profile_modules', array_keys($tasks), TRUE);
    unset($tasks['install_profile_modules']);
    unset($tasks['install_profile_themes']);
    unset($tasks['install_install_profile']);
    $config_tasks = [
      'install_config_import_batch' => [
        'display_name' => t('Install configuration'),
        'type' => 'batch',
      ],
      'install_config_download_translations' => [],
      'install_config_revert_install_changes' => [],
    ];
    $tasks = array_slice($tasks, 0, $key, TRUE) +
      $config_tasks +
      array_slice($tasks, $key, NULL, TRUE);
  }

857 858
  // Now add any tasks defined by the installation profile.
  if (!empty($install_state['parameters']['profile'])) {
859 860
    // Load the profile install file, because it is not always loaded when
    // hook_install_tasks() is invoked (e.g. batch processing).
861
    $profile = $install_state['parameters']['profile'];
862
    $profile_install_file = $install_state['profiles'][$profile]->getPath() . '/' . $profile . '.install';
863
    if (file_exists($profile_install_file)) {
864
      include_once \Drupal::root() . '/' . $profile_install_file;
865
    }
866 867 868 869 870 871 872 873 874 875
    $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.
876 877
  $tasks += [
    'install_finish_translations' => [
878
      'display_name' => t('Finish translations'),
879 880 881
      'display' => $needs_translations,
      'type' => 'batch',
      'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
882
    ],
883
    'install_finished' => [],
884
  ];
885 886 887

  // Allow the installation profile to modify the full list of tasks.
  if (!empty($install_state['parameters']['profile'])) {
888
    $profile = $install_state['parameters']['profile'];
889
    if ($install_state['profiles'][$profile]->load()) {
890 891 892 893 894 895 896 897 898
      $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) {
899
    $task += [
900 901 902 903 904
      'display_name' => NULL,
      'display' => !empty($task['display_name']),
      'type' => 'normal',
      'run' => INSTALL_TASK_RUN_IF_NOT_COMPLETED,
      'function' => $task_name,
905
    ];
906 907 908 909 910
  }
  return $tasks;
}

/**
911
 * Returns a list of tasks that should be displayed to the end user.
webchick's avatar