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

3 4
use Drupal\Component\Utility\Crypt;

5
use Drupal\Component\Utility\Settings;
6
use Drupal\Core\Config\FileStorage;
katbailey's avatar
katbailey committed
7
use Drupal\Core\DrupalKernel;
8
use Drupal\Core\CoreServiceProvider;
9 10
use Drupal\Core\Database\Database;
use Drupal\Core\Database\Install\TaskException;
11
use Drupal\Core\Language\Language;
12
use Drupal\Core\Language\LanguageManager;
13
use Drupal\Core\StringTranslation\Translator\FileTranslation;
14

15
use Drupal\Core\DependencyInjection\ContainerBuilder;
16
use Symfony\Component\DependencyInjection\ContainerInterface;
17
use Symfony\Component\DependencyInjection\Reference;
18
use Symfony\Component\HttpFoundation\Request;
19
use Symfony\Component\HttpFoundation\Response;
20

21 22
use Guzzle\Http\Exception\RequestException;

23 24 25 26 27 28
/**
 * @file
 * API functions for installing Drupal.
 */

/**
29
 * Do not run the task during the current installation request.
30 31 32 33 34 35 36 37 38
 *
 * 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.
 */
39
const INSTALL_TASK_SKIP = 1;
40 41

/**
42
 * Run the task on each installation request that reaches it.
43 44 45
 *
 * This is primarily used by the Drupal installer for bootstrap-related tasks.
 */
46
const INSTALL_TASK_RUN_IF_REACHED = 2;
47 48

/**
49
 * Run the task on each installation request until the database is set up.
50 51 52 53 54 55 56 57
 *
 * 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.
 */
58
const INSTALL_TASK_RUN_IF_NOT_COMPLETED = 3;
59 60

/**
61
 * Installs Drupal either interactively or via an array of passed-in settings.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
 *
 * 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).
 *
 * @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()
 */
function install_drupal($settings = array()) {
  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();
  try {
    // Begin the page request. This adds information about the current state of
    // the Drupal installation to the passed-in array.
    install_begin_request($install_state);
    // Based on the installation state, run the remaining tasks for this page
    // request, and collect any output.
    $output = install_run_tasks($install_state);
  }
  catch (Exception $e) {
    // When an installation error occurs, either send the error to the web
    // browser or pass on the exception so the calling script can use it.
    if ($install_state['interactive']) {
      install_display_output($e->getMessage(), $install_state);
    }
    else {
      throw $e;
    }
  }
107 108 109 110 111 112 113
  // 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'])) {
114
    unset($GLOBALS['install_state']);
115 116
  }

117 118 119
  // 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.
120 121
  if ($state['interactive']) {
    if ($state['parameters_changed']) {
122
      // Redirect to the correct page if the URL parameters have changed.
123
      install_goto(install_redirect_url($state));
124 125 126 127 128
    }
    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.
129
      install_display_output($output, $state);
130 131 132 133 134
    }
  }
}

/**
135
 * Returns an array of default settings for the global installation state.
136 137 138 139 140 141 142 143
 *
 * 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
144
 * 'langcode' that are normally passed in via the URL) and 'forms' (which can
145 146 147 148 149 150 151 152 153 154 155 156 157 158
 * be used to programmatically submit forms 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 used as the $form_state['values']
 * array that is passed on to the form submission via drupal_form_submit()).
 *
 * @see drupal_form_submit()
 */
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,
159 160 161
    // This becomes TRUE only when a valid config directory is created or
    // detected.
    'config_verified' => FALSE,
162 163
    // This becomes TRUE only when Drupal's system module is installed.
    'database_tables_exist' => FALSE,
164 165 166
    // This becomes TRUE only when a valid database connection can be
    // established.
    'database_verified' => FALSE,
167 168 169
    // Whether a translation file for the selected language will be downloaded
    // from the translation server.
    'download_translation' => FALSE,
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
    // 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
    // used as the $form_state['values'] array that is passed on to the form
    // submission via drupal_form_submit().
    '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,
186 187
    // The mode for directories that are created during install.
    'mode' => NULL,
188 189 190
    // 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)
191
    // and 'langcode' (the code of the chosen installation language), since
192 193 194 195 196 197 198 199
    // 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
200
    // be filled in based on the profile's .info.yml file.
201 202 203 204 205 206 207
    'profile_info' => array(),
    // An array of available installation profiles.
    'profiles' => array(),
    // An array of server variables that will be substituted into the global
    // $_SERVER array via drupal_override_server_variables(). Used by
    // non-interactive installations only.
    'server' => array(),
208 209 210 211
    // 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',
212 213 214
    // This becomes TRUE only when a valid settings.php file is written
    // (containing both valid database connection information and a valid
    // config directory).
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
    'settings_verified' => FALSE,
    // 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(),
238 239 240
    // An array of translation files URIs available for the installation. Keyed
    // by the translation language code.
    'translations' => array(),
241 242 243 244 245
  );
  return $defaults;
}

/**
246
 * Begins an installation request, modifying the installation state as needed.
247 248 249 250 251 252 253 254 255
 *
 * This function performs commands that must run at the beginning of every page
 * request. It throws an exception if the installation should not proceed.
 *
 * @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.
 */
function install_begin_request(&$install_state) {
256
  // Add any installation parameters passed in via the URL.
257 258 259
  if ($install_state['interactive']) {
    $install_state['parameters'] += $_GET;
  }
260 261 262 263 264

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

269
  // Allow command line scripts to override server variables used by Drupal.
270
  require_once __DIR__ . '/bootstrap.inc';
271

272 273 274 275
  if (!$install_state['interactive']) {
    drupal_override_server_variables($install_state['server']);
  }

276 277 278 279 280 281
  // Initialize conf_path().
  // This primes the site path to be used during installation. By not requiring
  // settings.php, a bare site folder can be prepared in the /sites directory,
  // which will be used for installing Drupal.
  conf_path(FALSE);

282 283
  drupal_bootstrap(DRUPAL_BOOTSTRAP_CONFIGURATION);

284 285 286 287 288 289 290 291 292 293 294
  // If the hash salt leaks, it becomes possible to forge a valid testing user
  // agent, install a new copy of Drupal, and take over the original site. To
  // avoid this yet allow for automated testing of the installer, make sure
  // there is also a special test-specific settings.php overriding conf_path().
  // _drupal_load_test_overrides() sets the simpletest_conf_path in-memory
  // setting in this case.
  if ($install_state['interactive'] && drupal_valid_test_ua() && !settings()->get('simpletest_conf_path')) {
    header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');
    exit;
  }

295 296 297
  // A request object from the HTTPFoundation to tell us about the request.
  $request = Request::createFromGlobals();

298 299 300 301
  // If we have a language selected and it is not yet saved in the system
  // (eg. pre-database data screens we are unable to persistently store
  // the default language), we should set language_default so the proper
  // language is used to display installer pages as early as possible.
302 303 304 305 306 307 308 309
  // The language list is stored in configuration and cannot be saved either
  // until later in the process. Language negotiation bootstrapping needs
  // the new default language to be in the list though, so inject it in.
  if (!empty($install_state['parameters']['langcode']) && language_default()->id != $install_state['parameters']['langcode']) {
    $GLOBALS['conf']['language_default'] = array('id' => $install_state['parameters']['langcode']);

    $languages = &drupal_static('language_list');
    $languages[$install_state['parameters']['langcode']] = new Language($GLOBALS['conf']['language_default']);
310 311
  }

312 313 314 315 316 317
  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';
  require_once __DIR__ . '/../../' . settings()->get('path_inc', 'core/includes/path.inc');
318 319

  // Load module basics (needed for hook invokes).
320 321 322
  include_once __DIR__ . '/module.inc';
  include_once __DIR__ . '/session.inc';
  require_once __DIR__ . '/entity.inc';
323

324 325
  // Determine whether the configuration system is ready to operate.
  $install_state['config_verified'] = install_verify_config_directory(CONFIG_ACTIVE_DIRECTORY) && install_verify_config_directory(CONFIG_STAGING_DIRECTORY);
326 327 328 329 330 331 332

  // Create a minimal container for t() to work.
  // This container will be overriden but it needed for the very early
  // installation process when database tasks run.
  $container = new ContainerBuilder();
  // Register the translation services.
  install_register_translation_service($container);
333
  \Drupal::setContainer($container);
334

335 336 337
  // Check existing settings.php.
  $install_state['database_verified'] = install_verify_database_settings();
  $install_state['settings_verified'] = $install_state['config_verified'] && $install_state['database_verified'];
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358

  // If it is not, replace the configuration storage with the InstallStorage
  // implementation, for the following reasons:
  // - The first call into drupal_container() will try to set up the regular
  //   runtime configuration storage, using the CachedStorage by default. It
  //   calls config_get_config_directory() to retrieve the config directory to
  //   use, but that throws an exception, since $config_directories is not
  //   defined since there is no settings.php yet. If there is a prepared
  //   settings.php already, then the returned directory still cannot be used,
  //   because it does not necessarily exist. The installer ensures that it
  //   exists and is writeable in a later step.
  // - The installer outputs maintenance theme pages and performs many other
  //   operations, which try to load configuration. Since there is no active
  //   configuration yet, and because the configuration system does not have a
  //   notion of default values at runtime, data is missing in many places. The
  //   lack of data does not trigger errors, but results in a broken user
  //   interface (e.g., missing page title, etc).
  // - The actual configuration data to read during installation is essentially
  //   the default configuration provided by the installation profile and
  //   modules (most notably System module). The InstallStorage therefore reads
  //   from the default configuration directories of extensions.
359 360
  // This override is reverted as soon as the config directory and the
  // database has been set up successfully.
361
  // @see drupal_install_config_directories()
362 363
  // @see install_settings_form_submit()
  if ($install_state['settings_verified']) {
364
    $kernel = new DrupalKernel('install', drupal_classloader(), FALSE);
365
    $kernel->boot();
366 367 368 369
    $container = $kernel->getContainer();
    // Add the file translation service to the container.
    $container->set('string_translator.file_translation', install_file_translation_service());
    $container->get('string_translation')->addTranslator($container->get('string_translator.file_translation'));
370 371
  }
  else {
372 373 374
    // @todo Move into a proper Drupal\Core\DependencyInjection\InstallContainerBuilder.
    $container = new ContainerBuilder();

375
    $container->register('event_dispatcher', 'Symfony\Component\EventDispatcher\EventDispatcher');
376 377

    $container->register('config.storage', 'Drupal\Core\Config\InstallStorage');
378
    $container->register('config.context.factory', 'Drupal\Core\Config\Context\ConfigContextFactory')
379 380
      ->addArgument(new Reference('event_dispatcher'))
      ->addArgument(new Reference('uuid'));
381 382 383 384 385

    $container->register('config.context', 'Drupal\Core\Config\Context\ContextInterface')
      ->setFactoryService(new Reference('config.context.factory'))
      ->setFactoryMethod('get');

386 387
    $container->register('config.factory', 'Drupal\Core\Config\ConfigFactory')
      ->addArgument(new Reference('config.storage'))
388
      ->addArgument(new Reference('config.context'));
389

390
    // Register the 'language_manager' service.
391 392 393
    $container
      ->register('language_manager', 'Drupal\Core\Language\LanguageManager')
      ->addArgument(NULL);
394 395

    // Register the translation services.
396
    install_register_translation_service($container);
397

398
    foreach (array('bootstrap', 'config', 'cache', 'menu', 'page', 'path') as $bin) {
399 400 401 402
      $container
        ->register("cache.$bin", 'Drupal\Core\Cache\MemoryBackend')
        ->addArgument($bin);
    }
403

404 405 406 407 408 409 410 411
    // The install process cannot use the database lock backend since the database
    // is not fully up, so we use a null backend implementation during the
    // installation process. This will also speed up the installation process.
    // The site being installed will use the real lock backend when doing AJAX
    // requests but, except for a WSOD, there is no chance for a a lock to stall
    // (as opposed to the cache backend) so we can afford having a null
    // implementation here.
    $container->register('lock', 'Drupal\Core\Lock\NullLockBackend');
412 413 414 415

    // Register a module handler for managing enabled modules.
    $container
      ->register('module_handler', 'Drupal\Core\Extension\ModuleHandler');
416 417 418 419 420 421 422 423 424 425 426

    // Register the Guzzle HTTP client for fetching translation files from a
    // remote translation server such as localization.drupal.org.
    $container->register('http_default_client', 'Guzzle\Http\Client')
      ->addArgument(NULL)
      ->addArgument(array(
        'curl.CURLOPT_TIMEOUT' => 30.0,
        'curl.CURLOPT_MAXREDIRS' => 3,
      ))
      ->addMethodCall('setUserAgent', array('Drupal (+http://drupal.org/)'));

427 428 429
    $container->register('settings', 'Drupal\Component\Utility\Settings')
      ->setFactoryClass('Drupal\Component\Utility\Settings')
      ->setFactoryMethod('getSingleton');
430
    $container->register('keyvalue', 'Drupal\Core\KeyValueStore\KeyValueFactory')
431 432
      ->addArgument(new Reference('service_container'))
      ->addArgument(new Reference('settings'));
433 434 435
    // Register the expirable key value store used by form cache.
    $container
      ->register('keyvalue.expirable', 'Drupal\Core\KeyValueStore\KeyValueExpirableFactory')
436 437 438
      ->addArgument(new Reference('service_container'))
      ->addArgument(new Reference('settings'));
    $container->register('keyvalue.memory', 'Drupal\Core\KeyValueStore\KeyValueMemoryFactory');
439 440
    $container
      ->register('keyvalue.expirable.null', 'Drupal\Core\KeyValueStore\KeyValueNullExpirableFactory');
441 442 443 444 445 446 447
    $settings = Settings::getSingleton()->getAll();
    $settings['settings_old'] = $settings;
    $settings['keyvalue_expirable_default'] = 'keyvalue.expirable.null';
    // Override the default keyvalue storage to use memory as the database is
    // not available.
    $settings['keyvalue_default'] = 'keyvalue.memory';
    new Settings($settings);
448

449 450 451 452 453
    $container->register('state', 'Drupal\Core\KeyValueStore\KeyValueStoreInterface')
      ->setFactoryService(new Reference('keyvalue'))
      ->setFactoryMethod('get')
      ->addArgument('state');

454
    // Register Twig template engine for use during install.
455
    CoreServiceProvider::registerTwig($container);
456

457 458
    $container->register('url_generator', 'Drupal\Core\Routing\NullGenerator');

459 460 461 462 463 464 465 466 467 468
    $container->register('form_builder', 'Drupal\Core\Form\FormBuilder')
      ->addArgument(new Reference('module_handler'))
      ->addArgument(new Reference('keyvalue.expirable'))
      ->addArgument(new Reference('event_dispatcher'))
      ->addArgument(new Reference('url_generator'))
      ->addArgument(new Reference('string_translation'))
      ->addArgument(new Reference('csrf_token', ContainerInterface::IGNORE_ON_INVALID_REFERENCE))
      ->addArgument(new Reference('http_kernel', ContainerInterface::IGNORE_ON_INVALID_REFERENCE))
      ->addMethodCall('setRequest', array(new Reference('request')));

469 470 471
    // Register UUID.
    CoreServiceProvider::registerUuid($container);

472
    // Register the CSS and JavaScript asset collection renderers.
473 474 475 476
    $container->register('asset.css.collection_renderer', 'Drupal\Core\Asset\CssCollectionRenderer')
      ->addArgument(new Reference('state'));
    $container->register('asset.js.collection_renderer', 'Drupal\Core\Asset\JsCollectionRenderer')
      ->addArgument(new Reference('state'));
477

478 479
    // Register the info parser.
    $container->register('info_parser', 'Drupal\Core\Extension\InfoParser');
480
  }
481 482 483 484
  // Set the request in the kernel to the new created Request above
  // so it is available to the rest of the installation process.
  $container->set('request', $request);

485
  \Drupal::setContainer($container);
486

487
  // Set up $language, so t() caller functions will still work.
katbailey's avatar
katbailey committed
488
  drupal_language_initialize();
489 490
  // Add in installation language if present.
  if (isset($install_state['parameters']['langcode'])) {
491
    \Drupal::translation()->setDefaultLangcode($install_state['parameters']['langcode']);
492
  }
493

494
  require_once __DIR__ . '/ajax.inc';
495

496
  $module_handler = \Drupal::moduleHandler();
497 498 499 500 501
  if (!$module_handler->moduleExists('system')) {
    // Override the module list with a minimal set of modules.
    $module_handler->setModuleList(array('system' => 'core/modules/system/system.module'));
  }
  $module_handler->load('system');
502

503
  require_once __DIR__ . '/cache.inc';
504

505 506 507 508 509 510
  // 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();
511

512
  if ($install_state['database_verified']) {
513 514
    // Initialize the database system. Note that the connection
    // won't be initialized until it is actually requested.
515
    require_once __DIR__ . '/database.inc';
516 517 518 519 520 521 522

    // Verify the last completed task in the database, if there is one.
    $task = install_verify_completed_task();
  }
  else {
    $task = NULL;

523 524
    // Do not install over a configured settings.php.
    if (!empty($GLOBALS['databases'])) {
525 526 527 528
      throw new Exception(install_already_done_error());
    }
  }

529 530 531 532 533 534 535 536 537 538
  // Ensure that the active configuration directory is empty before installation
  // starts.
  if ($install_state['config_verified'] && empty($task)) {
    $config = glob(config_get_config_directory(CONFIG_ACTIVE_DIRECTORY) . '/*.' . FileStorage::getFileExtension());
    if (!empty($config)) {
      $task = NULL;
      throw new Exception(install_already_done_error());
    }
  }

539 540 541
  // Modify the installation state as appropriate.
  $install_state['completed_task'] = $task;
  $install_state['database_tables_exist'] = !empty($task);
542 543

  // Add the list of available profiles to the installation state.
544
  $install_state['profiles'] += drupal_system_listing('/^' . DRUPAL_PHP_FUNCTION_PATTERN . '\.profile$/', 'profiles');
545 546 547
}

/**
548
 * Runs all tasks for the current installation request.
549 550 551 552 553 554 555 556 557
 *
 * 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.
558
 *
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
 * @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);
    $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);
      if ($install_state['database_tables_exist'] && ($task['run'] == INSTALL_TASK_RUN_IF_NOT_COMPLETED || $install_state['installation_finished'])) {
586
        \Drupal::state()->set('install_task', $install_state['installation_finished'] ? 'done' : $task_name);
587 588 589 590 591 592 593 594 595 596 597 598
      }
    }
    // 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;
}

/**
599
 * Runs an individual installation task.
600 601 602 603 604 605
 *
 * @param $task
 *   An array of information about the task to be run.
 * @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.
606
 *
607 608 609 610 611 612 613
 * @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') {
614
    require_once __DIR__ . '/form.inc';
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
    if ($install_state['interactive']) {
      // For interactive forms, build the form and ensure that it will not
      // redirect, since the installer handles its own redirection only after
      // marking the form submission task complete.
      $form_state = array(
        // We need to pass $install_state by reference in order for forms to
        // modify it, since the form API will use it in call_user_func_array(),
        // which requires that referenced variables be passed explicitly.
        'build_info' => array('args' => array(&$install_state)),
        'no_redirect' => TRUE,
      );
      $form = drupal_build_form($function, $form_state);
      // If a successful form submission did not occur, the form needs to be
      // rendered, which means the task is not complete yet.
      if (empty($form_state['executed'])) {
        $install_state['task_not_complete'] = TRUE;
        return drupal_render($form);
      }
      // Otherwise, return nothing so the next task will run in the same
      // request.
      return;
    }
    else {
      // For non-interactive forms, submit the form programmatically with the
      // values taken from the installation state. Throw an exception if any
      // errors were encountered.
641 642 643 644 645 646 647 648
      $form_state = array(
        'values' => !empty($install_state['forms'][$function]) ? $install_state['forms'][$function] : array(),
        // We need to pass $install_state by reference in order for forms to
        // modify it, since the form API will use it in call_user_func_array(),
        // which requires that referenced variables be passed explicitly.
        'build_info' => array('args' => array(&$install_state)),
      );
      drupal_form_submit($function, $form_state);
649 650 651 652 653 654 655 656 657 658
      $errors = form_get_errors();
      if (!empty($errors)) {
        throw new Exception(implode("\n", $errors));
      }
    }
  }

  elseif ($task['type'] == 'batch') {
    // Start a new batch based on the task function, if one is not running
    // already.
659
    $current_batch = \Drupal::state()->get('install_current_batch');
660 661 662 663 664 665 666 667 668 669 670 671
    if (!$install_state['interactive'] || !$current_batch) {
      $batch = $function($install_state);
      if (empty($batch)) {
        // If the task did some processing and decided no batch was necessary,
        // there is nothing more to do here.
        return;
      }
      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']) {
672
        \Drupal::state()->set('install_current_batch', $function);
673 674 675 676 677 678 679
      }
      else {
        $batch =& batch_get();
        $batch['progressive'] = FALSE;
      }
      // Process the batch. For progressive batches, this will redirect.
      // Otherwise, the batch will complete.
680 681 682 683 684 685 686 687
      $response = batch_process(install_redirect_url($install_state), install_full_redirect_url($install_state));
      if ($response instanceof Response) {
        // Save $_SESSION data from batch.
        drupal_session_commit();
        // Send the response.
        $response->send();
        exit;
      }
688 689 690 691
    }
    // 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) {
692
      include_once __DIR__ . '/batch.inc';
693
      $output = _batch_page(\Drupal::request());
694
      // Because Batch API now returns a JSON response for intermediary steps,
695 696 697 698
      // 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.
699 700
      if ($output instanceof Response) {
        $output->send();
701
        $output = NULL;
702
      }
703 704 705
      // 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.
706
      if ($output === FALSE) {
707
        // Return nothing so the next task will run in the same request.
708
        \Drupal::state()->delete('install_current_batch');
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
        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);
  }
}

/**
728
 * Returns a list of tasks to perform during the current installation request.
729 730 731 732 733 734 735
 *
 * 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.
736
 *
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
 * @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;
}

/**
759
 * Returns a list of all tasks the installer currently knows about.
760 761 762 763 764 765 766 767 768
 *
 * 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).
 *
 * @param $install_state
 *   An array of information about the current installation state.
769
 *
770 771 772 773
 * @return
 *   A list of tasks, with associated metadata.
 */
function install_tasks($install_state) {
774 775 776
  // Determine whether a translation file must be imported during the
  // 'install_import_translations' task. Import when a non-English language is
  // available and selected.
777
  $needs_translations = count($install_state['translations']) > 1 && !empty($install_state['parameters']['langcode']) && $install_state['parameters']['langcode'] != 'en';
778 779 780 781
  // 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';
782

783
  // Start with the core installation tasks that run before handing control
784
  // to the installation profile.
785
  $tasks = array(
786
    'install_select_language' => array(
787
      'display_name' => t('Choose language'),
788 789
      'run' => INSTALL_TASK_RUN_IF_REACHED,
    ),
790 791 792
    'install_download_translation' => array(
      'run' => $needs_download ? INSTALL_TASK_RUN_IF_REACHED : INSTALL_TASK_SKIP,
    ),
793
    'install_select_profile' => array(
794
      'display_name' => t('Choose profile'),
795 796 797 798 799 800 801
      'display' => count($install_state['profiles']) != 1,
      'run' => INSTALL_TASK_RUN_IF_REACHED,
    ),
    'install_load_profile' => array(
      'run' => INSTALL_TASK_RUN_IF_REACHED,
    ),
    'install_verify_requirements' => array(
802
      'display_name' => t('Verify requirements'),
803 804
    ),
    'install_settings_form' => array(
805
      'display_name' => t('Set up database'),
806
      'type' => 'form',
807 808 809
      // 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.
810 811
      'run' => $install_state['settings_verified'] ? INSTALL_TASK_SKIP : INSTALL_TASK_RUN_IF_NOT_COMPLETED,
    ),
812
    'install_base_system' => array(
813 814 815 816 817
    ),
    'install_bootstrap_full' => array(
      'run' => INSTALL_TASK_RUN_IF_REACHED,
    ),
    'install_profile_modules' => array(
818
      'display_name' => count($install_state['profiles']) == 1 ? t('Install site') : t('Installation profile'),
819 820
      'type' => 'batch',
    ),
821
    'install_import_translations' => array(
822
      'display_name' => t('Set up translations'),
823 824 825 826 827
      'display' => $needs_translations,
      'type' => 'batch',
      'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
    ),
    'install_configure_form' => array(
828
      'display_name' => t('Configure site'),
829 830 831 832 833 834
      'type' => 'form',
    ),
  );

  // Now add any tasks defined by the installation profile.
  if (!empty($install_state['parameters']['profile'])) {
835 836
    // Load the profile install file, because it is not always loaded when
    // hook_install_tasks() is invoked (e.g. batch processing).
837 838
    $profile = $install_state['parameters']['profile'];
    $profile_install_file = dirname($install_state['profiles'][$profile]->uri) . '/' . $profile . '.install';
839
    if (file_exists($profile_install_file)) {
840
      include_once DRUPAL_ROOT . '/' . $profile_install_file;
841
    }
842 843 844 845 846 847 848 849 850 851 852
    $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(
853
    'install_import_translations_remaining' => array(
854
      'display_name' => t('Finish translations'),
855 856 857 858
      'display' => $needs_translations,
      'type' => 'batch',
      'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
    ),
859
    'install_update_configuration_translations' => array(
860
      'display_name' => t('Translate configuration'),
861 862 863 864
      'display' => $needs_translations,
      'type' => 'batch',
      'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
    ),
865
    'install_finished' => array(
866
      'display_name' => t('Finished'),
867 868 869 870 871
    ),
  );

  // Allow the installation profile to modify the full list of tasks.
  if (!empty($install_state['parameters']['profile'])) {
872 873
    $profile = $install_state['parameters']['profile'];
    $profile_file = $install_state['profiles'][$profile]->uri;
874
    if (file_exists($profile_file)) {
875
      include_once DRUPAL_ROOT . '/' .  $profile_file;
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
      $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;
}

/**
897
 * Returns a list of tasks that should be displayed to the end user.
898 899 900 901 902 903
 *
 * The output of this function is a list suitable for sending to
 * theme_task_list().
 *
 * @param $install_state
 *   An array of information about the current installation state.
904
 *
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921
 * @return
 *   A list of tasks, with keys equal to the machine-readable task name and
 *   values equal to the name that should be displayed.
 *
 * @see theme_task_list()
 */
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;
}

/**
922
 * Returns the URL that should be redirected to during an installation request.
923 924 925 926 927
 *
 * The output of this function is suitable for sending to install_goto().
 *
 * @param $install_state
 *   An array of information about the current installation state.
928
 *
929 930 931 932 933 934
 * @return
 *   The URL to redirect to.
 *
 * @see install_full_redirect_url()
 */
function install_redirect_url($install_state) {
935
  return 'core/install.php?' . drupal_http_build_query($install_state['parameters']);
936 937 938
}

/**
939
 * Returns the complete URL redirected to during an installation request.
940 941 942
 *
 * @param $install_state
 *   An array of information about the current installation state.
943
 *
944 945 946 947 948 949 950 951 952 953 954
 * @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);
}

/**
955
 * Displays themed installer output and ends the page request.
956 957 958 959 960 961 962 963 964 965 966 967
 *
 * Installation tasks should use drupal_set_title() to set the desired page
 * 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) {
  drupal_page_header();
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982

  // 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',
    ),
  );
  drupal_add_html_head($noindex_meta_tag, 'install_meta_robots');

983 984 985 986 987 988 989
  // 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.
  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'];
990
    drupal_add_region_content('sidebar_first', theme('task_list', array('items' => install_tasks_to_display($install_state), 'active' => $active_task, 'variant' => 'install')));
991
  }
992
  print theme('install_page', array('content' => $output));
993 994 995 996
  exit;
}

/**
997
 * Verifies the requirements for installing Drupal.
998 999 1000
 *
 * @param $install_state
 *   An array of information about the current installation state.
1001
 *
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
 * @return
 *   A themed status report, or an exception if there are requirement errors.
 */
function install_verify_requirements(&$install_state) {
  // Check the installation requirements for Drupal and this profile.
  $requirements = install_check_requirements($install_state);

  // Verify existence of all required modules.
  $requirements += drupal_verify_profile($install_state);

1012
  return install_display_requirements($install_state, $requirements);
1013 1014 1015
}

/**
1016
 * Installation task; install the base functionality Drupal needs to bootstrap.
1017 1018 1019 1020
 *
 * @param $install_state
 *   An array of information about the current installation state.
 */
1021
function install_base_system(&$install_state) {
1022 1023
  // Install system.module.
  drupal_install_system();
1024

1025 1026 1027 1028 1029 1030 1031 1032 1033
  // Call file_ensure_htaccess() to ensure that all of Drupal's standard
  // directories (e.g., the public files directory and config directory) have
  // appropriate .htaccess files. These directories will have already been
  // created by this point in the installer, since Drupal creates them during
  // the install_verify_requirements() task. Note that we cannot call
  // file_ensure_access() any earlier than this, since it relies on
  // system.module in order to work.
  file_ensure_htaccess();

1034 1035
  // Enable the user module so that sessions can be recorded during the
  // upcoming bootstrap step.
1036
  \Drupal::moduleHandler()->install(array('user'), FALSE);
1037

1038
  // Save the list of other modules to install for the upcoming tasks.
1039
  // State can be set to the database now that system.module is installed.
1040 1041
  $modules = $install_state['profile_info']['dependencies'];

1042
  // The installation profile is also a module, which needs to be installed
1043 1044 1045
  // after all the dependencies have been installed.
  $modules[] = drupal_get_profile();

1046
  \Drupal::state()->set('install_profile_modules', array_diff($modules, array('system')));
1047 1048 1049 1050
  $install_state['database_tables_exist'] = TRUE;
}

/**
1051
 * Verifies and returns the last installation task that was completed.
1052 1053 1054 1055 1056 1057
 *
 * @return
 *   The last completed task, if there is one. An exception is thrown if Drupal
 *   is already installed.
 */
function install_verify_completed_task() {
1058
  try {
1059
    $task = \Drupal::state()->get('install_task');
1060 1061 1062 1063 1064 1065
  }
  // Do not trigger an error if the database query fails, since the database
  // might not be set up yet.
  catch (Exception $e) {
  }
  if (isset($task)) {
1066 1067 1068 1069 1070 1071 1072 1073
    if ($task == 'done') {
      throw new Exception(install_already_done_error());
    }
    return $task;
  }
}

/**
1074
 * Verifies that settings.php specifies a valid database connection.
1075
 */
1076
function install_verify_database_settings() {
1077
  global $databases;
1078
  if (!empty($databases)) {
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
    $database = $databases['default']['default'];
    drupal_static_reset('conf_path');
    $settings_file = './' . conf_path(FALSE) . '/settings.php';
    $errors = install_database_errors($database, $settings_file);
    if (empty($errors)) {
      return TRUE;
    }
  }
  return FALSE;
}

/**
1091
 * Form constructor for a form to configure and rewrite settings.php.
1092 1093 1094
 *
 * @param $install_state
 *   An array of information about the current installation state.
1095
 *
1096 1097
 * @see install_settings_form_validate()
 * @see install_settings_form_submit()
1098
 * @ingroup forms
1099 1100
 */
function install_settings_form($form, &$form_state, &$install_state) {
1101
  global $databases;
1102 1103 1104 1105 1106 1107

  drupal_static_reset('conf_path');
  $conf_path = './' . conf_path(FALSE);
  $settings_file = $conf_path . '/settings.php';
  $database = isset($databases['default']['default']) ? $databases['default']['default'] : array();

1108
  drupal_set_title(t('Database configuration'));
1109

1110
  $drivers = drupal_get_database_types();
1111
  $drivers_keys = array_keys($drivers);
1112

1113 1114
  $form['driver'] = array(
    '#type' => 'radios',
1115
    '#title' => t('Database type'),
1116
    '#required' => TRUE,
1117
    '#default_value' => !empty($database['driver']) ? $database['driver'] : current($drivers_keys),
1118
    '#description' => t('The type of database your @drupal data will be stored in.', array('@drupal' => drupal_install_profile_distribution_name())),
1119 1120 1121
  );
  if (count($drivers) == 1) {
    $form['driver']['#disabled'] = TRUE;
1122
    $form['driver']['#description'] .= ' ' . t('Your PHP configuration only supports a single database type, so it has been automatically selected.');
1123 1124
  }

1125 1126 1127 1128 1129
  // Add driver specific configuration options.
  foreach ($drivers as $key => $driver) {
    $form['driver']['#options'][$key] = $driver->name();

    $form['settings'][$key] = $driver->getFormOptions($database);
1130
    $form['settings'][$key]['#prefix'] = '<h2 class="js-hide">' . t('@driver_name settings', array('@driver_name' => $driver->name())) . '</h2>';
1131 1132 1133 1134 1135 1136 1137 1138 1139
    $form['settings'][$key]['#type'] = 'container';
    $form['settings'][$key]['#tree'] = TRUE;
    $form['settings'][$key]['advanced_options']['#parents'] = array($key);
    $form['settings'][$key]['#states'] = array(
      'visible' => array(
        ':input[name=driver]' => array('value' => $key),
      )
    );
  }
1140

1141
  $form['actions'] = array('#type' => 'actions');
1142 1143
  $form['actions']['save'] = array(
    '#type' => 'submit',
1144
    '#value' => t('Save and continue'),
1145
    '#button_type' => 'primary',
1146 1147 1148 1149 1150
    '#limit_validation_errors' => array(
      array('driver'),
      array(isset($form_state['input']['driver']) ? $form_state['input']['driver'] : current($drivers_keys)),
    ),
    '#submit' => array('install_settings_form_submit'),
1151 1152 1153 1154
  );

  $form['errors'] = array();
  $form['settings_file'] = array('#type' => 'value', '#value' => $settings_file);
1155 1156 1157 1158 1159

  return $form;
}

/**
1160 1161 1162
 * Form validation handler for install_settings_form().
 *
 * @see install_settings_form_submit()
1163 1164
 */
function install_settings_form_validate($form, &$form_state) {
1165 1166
  $driver = $form_state['values']['driver'];
  $database = $form_state['values'][$driver];
1167 1168 1169 1170 1171 1172
  // When testing the interactive installer, copy the database password and
  // the test prefix.
  if ($test_prefix = drupal_valid_test_ua()) {
    $database['prefix'] = $test_prefix;
    $database['password'] = $GLOBALS['databases']['default']['default']['password'];
  }
1173 1174 1175 1176 1177
  $drivers = drupal_get_database_types();
  $reflection = new \ReflectionClass($drivers[$driver]);
  $install_namespace = $reflection->getNamespaceName();
  // Cut the trailing \Install from namespace.
  $database['namespace'] = substr($install_namespace, 0, strrpos($install_namespace, '\\'));
1178 1179
  $database['driver'] = $driver;

1180 1181 1182 1183 1184
  // @todo PIFR uses 'db_prefix' instead of 'prefix'. Remove this when it gets
  //   fixed.
  if (!$test_prefix) {
    $database['prefix'] = $database['db_prefix'];
  }
1185
  unset($database['db_prefix']);
1186

1187 1188
  $form_state['storage']['database'] = $database;
  $errors = install_database_errors($database, $form_state['values']['settings_file']);
1189 1190 1191 1192 1193 1194
  foreach ($errors as $name => $message) {
    form_set_error($name, $message);
  }
}

/**
1195
 * Checks a database connection and returns any errors.
1196 1197 1198 1199 1200
 */
function install_database_errors($database, $settings_file) {
  global $databases;
  $errors = array();

1201
  // Check database type.
1202
  $database_types = drupal_get_database_types();
1203 1204
  $driver = $database['driver'];
  if (!isset($database_types[$driver])) {
1205
    $errors['driver'] = t("In your %settings_file file you have configured @drupal to use a %driver server, however your PHP installation currently does not support this database type.", array('%settings_file' => $settings_file, '@drupal' => drupal_install_profile_distribution_name(), '%driver' => $driver));
1206 1207
  }
  else {
1208 1209 1210
    // Run driver specific validation
    $errors += $database_types[$driver]->validateDatabaseSettings($database);

1211
    // Run tasks associated with the database type. Any errors are caught in the
1212
    // calling function.
1213 1214
    $databases['default']['default'] = $database;
    // Just changing the global doesn't get the new information processed.
1215 1216 1217 1218 1219
    // We need to close any active connections and tell the Database class to
    // re-parse $databases.
    if (Database::isActiveConnection()) {
      Database::closeConnection();
    }
1220 1221 1222
    Database::parseConnectionInfo();

    try {
1223
      db_run_tasks($driver);
1224
    }
1225
    catch (TaskException $e) {
1226 1227 1228
      // These are generic errors, so we do not have any specific key of the
      // database connection array to attach them to; therefore, we just put
      // them in the error array with standard numeric keys.
1229
      $errors[$driver . '][0'] = $e->getMessage();
1230 1231 1232 1233 1234 1235
    }
  }
  return $errors;
}

/**
1236 1237 1238
 * Form submission handler for install_settings_form().
 *
 * @see install_settings_form_validate()
1239 1240
 */
function install_settings_form_submit($form, &$form_state) {
1241
  global $install_state, $conf;
1242

1243
  // Update global settings array and save.
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
  $settings = array();
  $database = $form_state['storage']['database'];
  // Ideally, there is no difference between the code executed by the
  // automated test browser and an ordinary browser. However, the database
  // settings need a different format and also need to skip the password
  // when testing. The hash salt also needs to be skipped because the original
  // salt is used to verify the validity of the automated test browser.
  // Because of these, there's a little difference in the code following but
  // it is small and self-contained.
  if ($test_prefix = drupal_valid_test_ua()) {
    foreach ($form_state['storage']['database'] as $k => $v) {
      if ($k != 'password') {
        $settings['databases']['default']['default'][$k] = (object) array(
          'value'    => $v,
          'required' => TRUE,
        );
      }
    }
  }
  else {
    $settings['databases']['default']['default'] = (object) array(
      'value'    => $database,
      'required' => TRUE,
    );
    $settings['drupal_hash_salt'] = (object) array(
      'value'    => Crypt::randomStringHashed(55),
      'required' => TRUE,
    );
  }
1273

1274 1275 1276 1277 1278 1279 1280 1281
  // Remember the profile which was used.
  $settings['settings'] = array(
    'install_profile' => (object) array(
      'value' => $install_state['parameters']['profile'],
      'required' => TRUE,
    ),
  );

1282
  drupal_rewrite_settings($settings);
gdd's avatar
gdd committed
1283

1284
  // Add the config directories to settings.php.
1285
  drupal_install_config_directories($install_state['mode']);
gdd's avatar
gdd committed
1286

1287 1288
  // The container is about to be rebuilt so we need to unset the keyvalue
  // storage override that the installer is using.
1289 1290
  $settings = Settings::getSingleton()->getAll();
  new Settings($settings['settings_old']);
1291

1292 1293 1294 1295 1296
  // Indicate that the settings file has been verified, and check the database
  // for the last completed task, now that we have a valid connection. This
  // last step is important since we want to trigger an error if the new
  // database already has Drupal installed.
  $install_state['settings_verified'] = TRUE;
1297 1298
  $install_state['config_verified'] = TRUE;
  $install_state['database_verified'] = TRUE;
1299 1300 1301 1302
  $install_state['completed_task'] = install_verify_completed_task();
}

/**
1303
 * Selects which profile to install.
1304 1305 1306 1307 1308
 *
 * @param $install_state
 *   An array of information about the current installation state. The chosen
 *   profile will be added here, if it was not already selected previously, as
 *   will a list of all available profiles.
1309
 *
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
 * @return
 *   For interactive installations, a form allowing the profile to be selected,
 *   if the user has a choice that needs to be made. Otherwise, an exception is
 *   thrown if a profile cannot be chosen automatically.
 */
function install_select_profile(&$install_state) {
  if (empty($install_state['parameters']['profile'])) {
    // Try to find a profile.
    $profile = _install_select_profile($install_state['profiles']);
    if (empty($profile)) {
      // We still don't have a profile, so display a form for selecting one.
      // Only do this in the case of interactive installations, since this is
      // not a real form with submit handlers (the database isn't even set up
      // yet), rather just a convenience method for setting parameters in the
      // URL.
      if ($install_state['interactive']) {
1326
        include_once __DIR__ . '/form.inc';
1327
        drupal_set_title(t('Select an installation profile'));