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

3 4
use Drupal\Component\Utility\Crypt;

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

14 15
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;
16
use Symfony\Component\HttpFoundation\Request;
17
use Symfony\Component\HttpFoundation\Response;
18

19 20
use Guzzle\Http\Exception\RequestException;

21 22 23 24 25 26
/**
 * @file
 * API functions for installing Drupal.
 */

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

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

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

/**
59
 * Installs Drupal either interactively or via an array of passed-in settings.
60 61 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
 *
 * 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;
    }
  }
105 106 107 108 109 110 111
  // 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'])) {
112
    unset($GLOBALS['install_state']);
113 114
  }

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

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

/**
242
 * Begins an installation request, modifying the installation state as needed.
243 244 245 246 247 248 249 250 251
 *
 * 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) {
252
  // Add any installation parameters passed in via the URL.
253 254 255
  if ($install_state['interactive']) {
    $install_state['parameters'] += $_GET;
  }
256 257 258 259 260

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

265
  // Allow command line scripts to override server variables used by Drupal.
266
  require_once __DIR__ . '/bootstrap.inc';
267

268 269 270 271
  if (!$install_state['interactive']) {
    drupal_override_server_variables($install_state['server']);
  }

272 273 274 275 276 277
  // 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);

278 279
  drupal_bootstrap(DRUPAL_BOOTSTRAP_CONFIGURATION);

280 281 282 283 284 285 286 287 288 289 290
  // 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;
  }

291 292 293
  // A request object from the HTTPFoundation to tell us about the request.
  $request = Request::createFromGlobals();

294 295 296
  // This must go after drupal_bootstrap(), which unsets globals!
  global $conf;

297 298 299 300 301 302 303 304
  // 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.
  if (!empty($install_state['parameters']['langcode']) && language_default()->langcode != $install_state['parameters']['langcode']) {
    $GLOBALS['conf']['language_default'] = array('langcode' => $install_state['parameters']['langcode']);
  }

305 306 307 308 309 310
  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');
311 312

  // Load module basics (needed for hook invokes).
313 314 315
  include_once __DIR__ . '/module.inc';
  include_once __DIR__ . '/session.inc';
  require_once __DIR__ . '/entity.inc';
316

317 318
  // 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);
319 320 321 322 323 324 325 326 327

  // 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);
  Drupal::setContainer($container);

328 329 330
  // Check existing settings.php.
  $install_state['database_verified'] = install_verify_database_settings();
  $install_state['settings_verified'] = $install_state['config_verified'] && $install_state['database_verified'];
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351

  // 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.
352 353
  // This override is reverted as soon as the config directory and the
  // database has been set up successfully.
354
  // @see drupal_install_config_directories()
355 356 357 358
  // @see install_settings_form_submit()
  if ($install_state['settings_verified']) {
    $kernel = new DrupalKernel('install', FALSE, drupal_classloader(), FALSE);
    $kernel->boot();
359 360 361 362
    $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'));
363 364
    // Set the request in the kernel to the new created Request above
    // so it is available to the rest of the installation process.
365
    $container->set('request', $request);
366 367
  }
  else {
368 369 370
    // @todo Move into a proper Drupal\Core\DependencyInjection\InstallContainerBuilder.
    $container = new ContainerBuilder();

371
    $container->register('event_dispatcher', 'Symfony\Component\EventDispatcher\EventDispatcher');
372 373

    $container->register('config.storage', 'Drupal\Core\Config\InstallStorage');
374 375 376 377 378 379 380
    $container->register('config.context.factory', 'Drupal\Core\Config\Context\ConfigContextFactory')
      ->addArgument(new Reference('event_dispatcher'));

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

381 382
    $container->register('config.factory', 'Drupal\Core\Config\ConfigFactory')
      ->addArgument(new Reference('config.storage'))
383
      ->addArgument(new Reference('config.context'));
384

385 386
    // Register the 'language_manager' service.
    $container->register('language_manager', 'Drupal\Core\Language\LanguageManager');
387 388

    // Register the translation services.
389
    install_register_translation_service($container);
390

391
    foreach (array('bootstrap', 'config', 'cache', 'menu', 'page', 'path') as $bin) {
392 393 394 395
      $container
        ->register("cache.$bin", 'Drupal\Core\Cache\MemoryBackend')
        ->addArgument($bin);
    }
396

397 398 399 400 401 402 403 404
    // 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');
405 406 407 408

    // Register a module handler for managing enabled modules.
    $container
      ->register('module_handler', 'Drupal\Core\Extension\ModuleHandler');
409 410 411 412 413 414 415 416 417 418 419

    // 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/)'));

420 421 422 423 424 425 426 427
    // Register the expirable key value store used by form cache.
    $container
      ->register('keyvalue.expirable', 'Drupal\Core\KeyValueStore\KeyValueExpirableFactory')
      ->addArgument(new Reference('service_container'));
    $container
      ->register('keyvalue.expirable.null', 'Drupal\Core\KeyValueStore\KeyValueNullExpirableFactory');
    $conf['keyvalue_expirable_default'] = 'keyvalue.expirable.null';

428 429 430
    // Register Twig template engine for use during install.
    CoreBundle::registerTwig($container);

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

433
    Drupal::setContainer($container);
434 435
  }

436
  // Set up $language, so t() caller functions will still work.
katbailey's avatar
katbailey committed
437
  drupal_language_initialize();
438 439 440 441
  // Add in installation language if present.
  if (isset($install_state['parameters']['langcode'])) {
    Drupal::translation()->setDefaultLangcode($install_state['parameters']['langcode']);
  }
442

443
  require_once __DIR__ . '/ajax.inc';
444

445
  $module_handler = Drupal::moduleHandler();
446 447 448 449 450
  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');
451

452
  require_once __DIR__ . '/cache.inc';
453

454 455 456 457 458 459
  // 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();
460

461
  if ($install_state['database_verified']) {
462 463
    // Initialize the database system. Note that the connection
    // won't be initialized until it is actually requested.
464
    require_once __DIR__ . '/database.inc';
465 466 467 468 469 470 471

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

472 473
    // Do not install over a configured settings.php.
    if (!empty($GLOBALS['databases'])) {
474 475 476 477
      throw new Exception(install_already_done_error());
    }
  }

478 479 480 481 482 483 484 485 486 487
  // 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());
    }
  }

488 489 490
  // Modify the installation state as appropriate.
  $install_state['completed_task'] = $task;
  $install_state['database_tables_exist'] = !empty($task);
491 492

  // Add the list of available profiles to the installation state.
493
  $install_state['profiles'] += drupal_system_listing('/^' . DRUPAL_PHP_FUNCTION_PATTERN . '\.profile$/', 'profiles');
494 495 496
}

/**
497
 * Runs all tasks for the current installation request.
498 499 500 501 502 503 504 505 506
 *
 * 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.
507
 *
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
 * @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'])) {
535
        variable_set('install_task', $install_state['installation_finished'] ? 'done' : $task_name);
536 537 538 539 540 541 542 543 544 545 546 547
      }
    }
    // 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;
}

/**
548
 * Runs an individual installation task.
549 550 551 552 553 554
 *
 * @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.
555
 *
556 557 558 559 560 561 562
 * @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') {
563
    require_once __DIR__ . '/form.inc';
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
    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.
590 591 592 593 594 595 596 597
      $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);
598 599 600 601 602 603 604 605 606 607
      $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.
608
    $current_batch = variable_get('install_current_batch');
609 610 611 612 613 614 615 616 617 618 619 620
    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']) {
621
        variable_set('install_current_batch', $function);
622 623 624 625 626 627 628
      }
      else {
        $batch =& batch_get();
        $batch['progressive'] = FALSE;
      }
      // Process the batch. For progressive batches, this will redirect.
      // Otherwise, the batch will complete.
629 630 631 632 633 634 635 636
      $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;
      }
637 638 639 640
    }
    // 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) {
641
      include_once __DIR__ . '/batch.inc';
642
      $output = _batch_page();
643
      // Because Batch API now returns a JSON response for intermediary steps,
644 645 646 647
      // 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.
648 649
      if ($output instanceof Response) {
        $output->send();
650
        $output = NULL;
651
      }
652 653 654
      // 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.
655
      if ($output === FALSE) {
656
        // Return nothing so the next task will run in the same request.
657
        variable_del('install_current_batch');
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
        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);
  }
}

/**
677
 * Returns a list of tasks to perform during the current installation request.
678 679 680 681 682 683 684
 *
 * 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.
685
 *
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
 * @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;
}

/**
708
 * Returns a list of all tasks the installer currently knows about.
709 710 711 712 713 714 715 716 717
 *
 * 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.
718
 *
719 720 721 722
 * @return
 *   A list of tasks, with associated metadata.
 */
function install_tasks($install_state) {
723 724 725
  // Determine whether a translation file must be imported during the
  // 'install_import_translations' task. Import when a non-English language is
  // available and selected.
726
  $needs_translations = count($install_state['translations']) > 1 && !empty($install_state['parameters']['langcode']) && $install_state['parameters']['langcode'] != 'en';
727 728 729 730
  // 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';
731

732
  // Start with the core installation tasks that run before handing control
733
  // to the installation profile.
734
  $tasks = array(
735
    'install_select_language' => array(
736
      'display_name' => t('Choose language'),
737 738
      'run' => INSTALL_TASK_RUN_IF_REACHED,
    ),
739 740 741
    'install_download_translation' => array(
      'run' => $needs_download ? INSTALL_TASK_RUN_IF_REACHED : INSTALL_TASK_SKIP,
    ),
742
    'install_select_profile' => array(
743
      'display_name' => t('Choose profile'),
744 745 746 747 748 749 750
      '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(
751
      'display_name' => t('Verify requirements'),
752 753
    ),
    'install_settings_form' => array(
754
      'display_name' => t('Set up database'),
755
      'type' => 'form',
756 757 758
      // 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.
759 760
      'run' => $install_state['settings_verified'] ? INSTALL_TASK_SKIP : INSTALL_TASK_RUN_IF_NOT_COMPLETED,
    ),
761
    'install_base_system' => array(
762 763 764 765 766
    ),
    'install_bootstrap_full' => array(
      'run' => INSTALL_TASK_RUN_IF_REACHED,
    ),
    'install_profile_modules' => array(
767
      'display_name' => count($install_state['profiles']) == 1 ? t('Install site') : t('Installation profile'),
768 769
      'type' => 'batch',
    ),
770
    'install_import_translations' => array(
771
      'display_name' => t('Set up translations'),
772 773 774 775 776
      'display' => $needs_translations,
      'type' => 'batch',
      'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
    ),
    'install_configure_form' => array(
777
      'display_name' => t('Configure site'),
778 779 780 781 782 783
      'type' => 'form',
    ),
  );

  // Now add any tasks defined by the installation profile.
  if (!empty($install_state['parameters']['profile'])) {
784 785
    // Load the profile install file, because it is not always loaded when
    // hook_install_tasks() is invoked (e.g. batch processing).
786 787
    $profile = $install_state['parameters']['profile'];
    $profile_install_file = dirname($install_state['profiles'][$profile]->uri) . '/' . $profile . '.install';
788 789 790
    if (file_exists($profile_install_file)) {
      include_once $profile_install_file;
    }
791 792 793 794 795 796 797 798 799 800 801
    $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(
802
    'install_import_translations_remaining' => array(
803
      'display_name' => t('Finish translations'),
804 805 806 807
      'display' => $needs_translations,
      'type' => 'batch',
      'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
    ),
808
    'install_update_configuration_translations' => array(
809
      'display_name' => t('Translate configuration'),
810 811 812 813
      'display' => $needs_translations,
      'type' => 'batch',
      'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP,
    ),
814
    'install_finished' => array(
815
      'display_name' => t('Finished'),
816 817 818 819 820
    ),
  );

  // Allow the installation profile to modify the full list of tasks.
  if (!empty($install_state['parameters']['profile'])) {
821 822
    $profile = $install_state['parameters']['profile'];
    $profile_file = $install_state['profiles'][$profile]->uri;
823
    if (file_exists($profile_file)) {
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
      include_once $profile_file;
      $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;
}

/**
846
 * Returns a list of tasks that should be displayed to the end user.
847 848 849 850 851 852
 *
 * 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.
853
 *
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
 * @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;
}

/**
871
 * Returns the URL that should be redirected to during an installation request.
872 873 874 875 876
 *
 * The output of this function is suitable for sending to install_goto().
 *
 * @param $install_state
 *   An array of information about the current installation state.
877
 *
878 879 880 881 882 883
 * @return
 *   The URL to redirect to.
 *
 * @see install_full_redirect_url()
 */
function install_redirect_url($install_state) {
884
  return 'core/install.php?' . drupal_http_build_query($install_state['parameters']);
885 886 887
}

/**
888
 * Returns the complete URL redirected to during an installation request.
889 890 891
 *
 * @param $install_state
 *   An array of information about the current installation state.
892
 *
893 894 895 896 897 898 899 900 901 902 903
 * @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);
}

/**
904
 * Displays themed installer output and ends the page request.
905 906 907 908 909 910 911 912 913 914 915 916
 *
 * 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();
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931

  // 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');

932 933 934 935 936 937 938 939 940
  // 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'];
    drupal_add_region_content('sidebar_first', theme('task_list', array('items' => install_tasks_to_display($install_state), 'active' => $active_task)));
  }
941
  print theme('install_page', array('content' => $output));
942 943 944 945
  exit;
}

/**
946
 * Verifies the requirements for installing Drupal.
947 948 949
 *
 * @param $install_state
 *   An array of information about the current installation state.
950
 *
951 952 953 954 955 956 957 958 959 960
 * @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);

961
  return install_display_requirements($install_state, $requirements);
962 963 964
}

/**
965
 * Installation task; install the base functionality Drupal needs to bootstrap.
966 967 968 969
 *
 * @param $install_state
 *   An array of information about the current installation state.
 */
970
function install_base_system(&$install_state) {
971 972
  // Install system.module.
  drupal_install_system();
973

974 975 976 977 978 979 980 981 982
  // 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();

983 984 985 986
  // Enable the user module so that sessions can be recorded during the
  // upcoming bootstrap step.
  module_enable(array('user'), FALSE);

987
  // Save the list of other modules to install for the upcoming tasks.
988
  // variable_set() can be used now that system.module is installed.
989 990
  $modules = $install_state['profile_info']['dependencies'];

991
  // The installation profile is also a module, which needs to be installed
992 993 994
  // after all the dependencies have been installed.
  $modules[] = drupal_get_profile();

995
  Drupal::state()->set('install_profile_modules', array_diff($modules, array('system')));
996 997 998 999
  $install_state['database_tables_exist'] = TRUE;
}

/**
1000
 * Verifies and returns the last installation task that was completed.
1001 1002 1003 1004 1005 1006
 *
 * @return
 *   The last completed task, if there is one. An exception is thrown if Drupal
 *   is already installed.
 */
function install_verify_completed_task() {
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
  try {
    if ($result = db_query("SELECT value FROM {variable} WHERE name = :name", array('name' => 'install_task'))) {
      $task = unserialize($result->fetchField());
    }
  }
  // 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)) {
1017 1018 1019 1020 1021 1022 1023 1024
    if ($task == 'done') {
      throw new Exception(install_already_done_error());
    }
    return $task;
  }
}

/**
1025
 * Verifies that settings.php specifies a valid database connection.
1026
 */
1027
function install_verify_database_settings() {
1028
  global $databases;
1029
  if (!empty($databases)) {
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
    $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;
}

/**
1042
 * Form constructor for a form to configure and rewrite settings.php.
1043 1044 1045
 *
 * @param $install_state
 *   An array of information about the current installation state.
1046
 *
1047 1048
 * @see install_settings_form_validate()
 * @see install_settings_form_submit()
1049
 * @ingroup forms
1050 1051
 */
function install_settings_form($form, &$form_state, &$install_state) {
1052
  global $databases;
1053 1054 1055 1056 1057 1058

  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();

1059
  drupal_set_title(t('Database configuration'));
1060

1061
  $drivers = drupal_get_database_types();
1062
  $drivers_keys = array_keys($drivers);
1063

1064 1065
  $form['driver'] = array(
    '#type' => 'radios',
1066
    '#title' => t('Database type'),
1067
    '#required' => TRUE,
1068
    '#default_value' => !empty($database['driver']) ? $database['driver'] : current($drivers_keys),
1069
    '#description' => t('The type of database your @drupal data will be stored in.', array('@drupal' => drupal_install_profile_distribution_name())),
1070 1071 1072
  );
  if (count($drivers) == 1) {
    $form['driver']['#disabled'] = TRUE;
1073
    $form['driver']['#description'] .= ' ' . t('Your PHP configuration only supports a single database type, so it has been automatically selected.');
1074 1075
  }

1076 1077 1078 1079 1080
  // Add driver specific configuration options.
  foreach ($drivers as $key => $driver) {
    $form['driver']['#options'][$key] = $driver->name();

    $form['settings'][$key] = $driver->getFormOptions($database);
1081
    $form['settings'][$key]['#prefix'] = '<h2 class="js-hide">' . t('@driver_name settings', array('@driver_name' => $driver->name())) . '</h2>';
1082 1083 1084 1085 1086 1087 1088 1089 1090
    $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),
      )
    );
  }
1091

1092
  $form['actions'] = array('#type' => 'actions');
1093 1094
  $form['actions']['save'] = array(
    '#type' => 'submit',
1095
    '#value' => t('Save and continue'),
1096 1097 1098 1099 1100
    '#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'),
1101 1102 1103 1104
  );

  $form['errors'] = array();
  $form['settings_file'] = array('#type' => 'value', '#value' => $settings_file);
1105 1106 1107 1108 1109

  return $form;
}

/**
1110 1111 1112
 * Form validation handler for install_settings_form().
 *
 * @see install_settings_form_submit()
1113 1114
 */
function install_settings_form_validate($form, &$form_state) {
1115 1116
  $driver = $form_state['values']['driver'];
  $database = $form_state['values'][$driver];
1117 1118 1119 1120 1121 1122
  // 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'];
  }
1123 1124 1125 1126 1127
  $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, '\\'));
1128 1129
  $database['driver'] = $driver;

1130 1131 1132 1133 1134
  // @todo PIFR uses 'db_prefix' instead of 'prefix'. Remove this when it gets
  //   fixed.
  if (!$test_prefix) {
    $database['prefix'] = $database['db_prefix'];
  }
1135
  unset($database['db_prefix']);
1136

1137 1138
  $form_state['storage']['database'] = $database;
  $errors = install_database_errors($database, $form_state['values']['settings_file']);
1139 1140 1141 1142 1143 1144
  foreach ($errors as $name => $message) {
    form_set_error($name, $message);
  }
}

/**
1145
 * Checks a database connection and returns any errors.
1146 1147 1148 1149 1150
 */
function install_database_errors($database, $settings_file) {
  global $databases;
  $errors = array();

1151
  // Check database type.
1152
  $database_types = drupal_get_database_types();
1153 1154
  $driver = $database['driver'];
  if (!isset($database_types[$driver])) {
1155
    $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));
1156 1157
  }
  else {
1158 1159 1160
    // Run driver specific validation
    $errors += $database_types[$driver]->validateDatabaseSettings($database);

1161
    // Run tasks associated with the database type. Any errors are caught in the
1162
    // calling function.
1163 1164
    $databases['default']['default'] = $database;
    // Just changing the global doesn't get the new information processed.
1165 1166 1167 1168 1169
    // We need to close any active connections and tell the Database class to
    // re-parse $databases.
    if (Database::isActiveConnection()) {
      Database::closeConnection();
    }
1170 1171 1172
    Database::parseConnectionInfo();

    try {