install.inc 36.5 KB
Newer Older
1 2
<?php

3 4 5 6 7
 /**
 * @file
 * API functions for installing modules and themes.
 */

8
use Symfony\Component\HttpFoundation\RedirectResponse;
9
use Drupal\Component\Utility\Crypt;
10
use Drupal\Component\Utility\OpCodeCache;
11
use Drupal\Component\Utility\Settings;
12
use Drupal\Core\Database\Database;
13
use Drupal\Core\DrupalKernel;
14
use Drupal\Core\Extension\ExtensionDiscovery;
15

16 17 18
/**
 * Requirement severity -- Informational message only.
 */
19
const REQUIREMENT_INFO = -1;
20 21 22 23

/**
 * Requirement severity -- Requirement successfully met.
 */
24
const REQUIREMENT_OK = 0;
25 26 27 28

/**
 * Requirement severity -- Warning condition; proceed but flag warning.
 */
29
const REQUIREMENT_WARNING = 1;
30 31 32 33

/**
 * Requirement severity -- Error condition; abort installation.
 */
34
const REQUIREMENT_ERROR = 2;
35

36 37 38
/**
 * File permission check -- File exists.
 */
39
const FILE_EXIST = 1;
40 41 42 43

/**
 * File permission check -- File is readable.
 */
44
const FILE_READABLE = 2;
45 46 47 48

/**
 * File permission check -- File is writable.
 */
49
const FILE_WRITABLE = 4;
50 51 52 53

/**
 * File permission check -- File is executable.
 */
54
const FILE_EXECUTABLE = 8;
55 56 57 58

/**
 * File permission check -- File does not exist.
 */
59
const FILE_NOT_EXIST = 16;
60 61 62 63

/**
 * File permission check -- File is not readable.
 */
64
const FILE_NOT_READABLE = 32;
65 66 67 68

/**
 * File permission check -- File is not writable.
 */
69
const FILE_NOT_WRITABLE = 64;
70 71 72 73

/**
 * File permission check -- File is not executable.
 */
74
const FILE_NOT_EXECUTABLE = 128;
75

76
/**
77
 * Loads .install files for installed modules to initialize the update system.
78 79
 */
function drupal_load_updates() {
80 81 82 83
  foreach (drupal_get_installed_schema_version(NULL, FALSE, TRUE) as $module => $schema_version) {
    if ($schema_version > -1) {
      module_load_install($module);
    }
84 85 86
  }
}

87
/**
88
 * Loads the installation profile, extracting its defined distribution name.
89 90
 *
 * @return
91
 *   The distribution name defined in the profile's .info.yml file. Defaults to
92
 *   "Drupal" if none is explicitly provided by the installation profile.
93 94
 *
 * @see install_profile_info()
95
 */
96
function drupal_install_profile_distribution_name() {
97 98
  // During installation, the profile information is stored in the global
  // installation state (it might not be saved anywhere yet).
99
  $info = array();
100 101
  if (drupal_installation_attempted()) {
    global $install_state;
102 103 104
    if (isset($install_state['profile_info'])) {
      $info = $install_state['profile_info'];
    }
105 106 107 108
  }
  // At all other times, we load the profile via standard methods.
  else {
    $profile = drupal_get_profile();
109
    $info = system_get_info('module', $profile);
110
  }
111
  return isset($info['distribution']['name']) ? $info['distribution']['name'] : 'Drupal';
112 113 114
}

/**
115
 * Detects all supported databases that are compiled into PHP.
116 117 118 119 120
 *
 * @return
 *  An array of database types compiled into PHP.
 */
function drupal_detect_database_types() {
121 122 123 124 125 126 127 128 129 130
  $databases = drupal_get_database_types();

  foreach ($databases as $driver => $installer) {
    $databases[$driver] = $installer->name();
  }

  return $databases;
}

/**
131
 * Returns all supported database driver installer objects.
132
 *
133 134
 * @return \Drupal\Core\Database\Install\Tasks[]
 *   An array of available database driver installer objects.
135 136
 */
function drupal_get_database_types() {
137
  $databases = array();
138
  $drivers = array();
139

140 141
  // The internal database driver name is any valid PHP identifier.
  $mask = '/^' . DRUPAL_PHP_FUNCTION_PATTERN . '$/';
142 143 144 145 146
  $files = file_scan_directory(DRUPAL_ROOT . '/core/lib/Drupal/Core/Database/Driver', $mask, array('recurse' => FALSE));
  if (is_dir(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database')) {
    $files += file_scan_directory(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database/', $mask, array('recurse' => FALSE));
  }
  foreach ($files as $file) {
147
    if (file_exists($file->uri . '/Install/Tasks.php')) {
148 149
      $drivers[$file->filename] = $file->uri;
    }
150 151
  }
  foreach ($drivers as $driver => $file) {
152
    $installer = db_installer_object($driver);
153
    if ($installer->installable()) {
154
      $databases[$driver] = $installer;
155 156
    }
  }
157

158
  // Usability: unconditionally put the MySQL driver on top.
159 160 161 162 163
  if (isset($databases['mysql'])) {
    $mysql_database = $databases['mysql'];
    unset($databases['mysql']);
    $databases = array('mysql' => $mysql_database) + $databases;
  }
164

165 166 167
  return $databases;
}

168
/**
169
 * Replaces values in settings.php with values in the submitted array.
170
 *
171 172 173 174
 * This function replaces values in place if possible, even for
 * multidimensional arrays. This way the old settings do not linger,
 * overridden and also the doxygen on a value remains where it should be.
 *
175
 * @param $settings
176 177 178 179 180
 *   An array of settings that need to be updated. Multidimensional arrays
 *   are dumped up to a stdClass object. The object can have value, required
 *   and comment properties.
 *   @code
 *   $settings['config_directories'] = array(
181 182 183
 *     CONFIG_ACTIVE_DIRECTORY => (object) array(
 *       'value' => 'config_hash/active'
 *       'required' => TRUE,
184
 *     ),
185 186 187
 *     CONFIG_STAGING_DIRECTORY => (object) array(
 *       'value' => 'config_hash/staging',
 *       'required' => TRUE,
188 189 190 191 192
 *     ),
 *   );
 *   @endcode
 *   gets dumped as:
 *   @code
193 194
 *   $config_directories['active'] = 'config_hash/active';
 *   $config_directories['staging'] = 'config_hash/staging'
195
 *   @endcode
196
 */
197 198 199 200
function drupal_rewrite_settings($settings = array(), $settings_file = NULL) {
  if (!isset($settings_file)) {
    $settings_file = conf_path(FALSE) . '/settings.php';
  }
201
  // Build list of setting names and insert the values into the global namespace.
202
  $variable_names = array();
203
  $settings_settings = array();
204
  foreach ($settings as $setting => $data) {
205 206 207 208 209 210
    if ($setting != 'settings') {
      _drupal_rewrite_settings_global($GLOBALS[$setting], $data);
    }
    else {
      _drupal_rewrite_settings_global($settings_settings, $data);
    }
211
    $variable_names['$'. $setting] = $setting;
212
  }
213 214
  $contents = file_get_contents(DRUPAL_ROOT . '/' . $settings_file);
  if ($contents !== FALSE) {
215 216 217 218
    // Initialize the contents for the settings.php file if it is empty.
    if (trim($contents) === '') {
      $contents = "<?php\n";
    }
219 220
    // Step through each token in settings.php and replace any variables that
    // are in the passed-in array.
221 222
    $buffer = '';
    $state = 'default';
223
    foreach (token_get_all($contents) as $token) {
224 225
      if (is_array($token)) {
        list($type, $value) = $token;
226
      }
227
      else {
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
        $type = -1;
        $value = $token;
      }
      // Do not operate on whitespace.
      if (!in_array($type, array(T_WHITESPACE, T_COMMENT, T_DOC_COMMENT))) {
        switch ($state) {
          case 'default':
            if ($type === T_VARIABLE && isset($variable_names[$value])) {
              // This will be necessary to unset the dumped variable.
              $parent = &$settings;
              // This is the current index in parent.
              $index = $variable_names[$value];
              // This will be necessary for descending into the array.
              $current = &$parent[$index];
              $state = 'candidate_left';
            }
            break;
          case 'candidate_left':
            if ($value == '[') {
              $state = 'array_index';
            }
            if ($value == '=') {
              $state = 'candidate_right';
            }
            break;
          case 'array_index':
            if (_drupal_rewrite_settings_is_array_index($type, $value)) {
              $index = trim($value, '\'"');
              $state = 'right_bracket';
            }
            else {
              // $a[foo()] or $a[$bar] or something like that.
              throw new Exception('invalid array index');
            }
            break;
          case 'right_bracket':
            if ($value == ']') {
              if (isset($current[$index])) {
                // If the new settings has this index, descend into it.
                $parent = &$current;
                $current = &$parent[$index];
                $state = 'candidate_left';
              }
              else {
                // Otherwise, jump back to the default state.
                $state = 'wait_for_semicolon';
              }
            }
            else {
              // $a[1 + 2].
              throw new Exception('] expected');
            }
            break;
          case 'candidate_right':
            if (_drupal_rewrite_settings_is_simple($type, $value)) {
              $value = _drupal_rewrite_settings_dump_one($current);
              // Unsetting $current would not affect $settings at all.
              unset($parent[$index]);
              // Skip the semicolon because _drupal_rewrite_settings_dump_one() added one.
              $state = 'semicolon_skip';
            }
            else {
              $state = 'wait_for_semicolon';
            }
            break;
          case 'wait_for_semicolon':
            if ($value == ';') {
              $state = 'default';
            }
            break;
          case 'semicolon_skip':
            if ($value == ';') {
              $value = '';
              $state = 'default';
            }
            else {
              // If the expression was $a = 1 + 2; then we replaced 1 and
              // the + is unexpected.
306
              throw new Exception('Unexpected token after replacing value.');
307 308
            }
            break;
309 310
        }
      }
311
      $buffer .= $value;
312
    }
313 314
    foreach ($settings as $name => $setting) {
      $buffer .= _drupal_rewrite_settings_dump($setting, '$' . $name);
315 316
    }

317 318
    // Write the new settings file.
    if (file_put_contents(DRUPAL_ROOT . '/' . $settings_file, $buffer) === FALSE) {
319
      throw new Exception(t('Failed to modify %settings. Verify the file permissions.', array('%settings' => $settings_file)));
320
    }
321 322 323 324
    else {
      // In case any $settings variables were written, import them into the
      // Settings singleton.
      if (!empty($settings_settings)) {
325
        $old_settings = Settings::getAll();
326 327
        new Settings($settings_settings + $old_settings);
      }
328 329 330 331 332
      // The existing settings.php file might have been included already. In
      // case an opcode cache is enabled, the rewritten contents of the file
      // will not be reflected in this process. Ensure to invalidate the file
      // in case an opcode cache is enabled.
      OpCodeCache::invalidate(DRUPAL_ROOT . '/' . $settings_file);
333
    }
334 335
  }
  else {
336
    throw new Exception(t('Failed to open %settings. Verify the file permissions.', array('%settings' => $settings_file)));
337 338 339
  }
}

340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
/**
 * Helper for drupal_rewrite_settings().
 *
 * Checks whether this token represents a scalar or NULL.
 *
 * @param int $type
 *   The token type
 *   @see token_name().
 * @param string $value
 *   The value of the token.
 *
 * @return bool
 *   TRUE if this token represents a scalar or NULL.
 */
function _drupal_rewrite_settings_is_simple($type, $value) {
  $is_integer = $type == T_LNUMBER;
  $is_float = $type == T_DNUMBER;
  $is_string = $type == T_CONSTANT_ENCAPSED_STRING;
  $is_boolean_or_null = $type == T_STRING && in_array(strtoupper($value), array('TRUE', 'FALSE', 'NULL'));
  return $is_integer || $is_float || $is_string || $is_boolean_or_null;
}


/**
 * Helper for drupal_rewrite_settings().
 *
 * Checks whether this token represents a valid array index: a number or a
 * stirng.
 *
 * @param int $type
 *   The token type
 *   @see token_name().
 *
 * @return bool
 *   TRUE if this token represents a number or a string.
 */
function _drupal_rewrite_settings_is_array_index($type) {
  $is_integer = $type == T_LNUMBER;
  $is_float = $type == T_DNUMBER;
  $is_string = $type == T_CONSTANT_ENCAPSED_STRING;
  return $is_integer || $is_float || $is_string;
}

/**
 * Helper for drupal_rewrite_settings().
 *
 * Makes the new settings global.
 *
388
 * @param array|null $ref
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
 *   A reference to a nested index in $GLOBALS.
 * @param array|object $variable
 *   The nested value of the setting being copied.
 */
function _drupal_rewrite_settings_global(&$ref, $variable) {
  if (is_object($variable)) {
    $ref = $variable->value;
  }
  else {
    foreach ($variable as $k => $v) {
      _drupal_rewrite_settings_global($ref[$k], $v);
    }
  }
}

/**
 * Helper for drupal_rewrite_settings().
 *
 * Dump the relevant value properties.
 *
 * @param array|object $variable
 *   The container for variable values.
 * @param string $variable_name
 *   Name of variable.
 * @return string
 *   A string containing valid PHP code of the variable suitable for placing
 *   into settings.php.
 */
function _drupal_rewrite_settings_dump($variable, $variable_name) {
  $return = '';
  if (is_object($variable)) {
    if (!empty($variable->required)) {
      $return .= _drupal_rewrite_settings_dump_one($variable, "$variable_name = ", "\n");
    }
  }
  else {
    foreach ($variable as $k => $v) {
      $return .= _drupal_rewrite_settings_dump($v, $variable_name . "['" . $k . "']");
    }
  }
  return $return;
}


/**
 * Helper for drupal_rewrite_settings().
 *
 * Dump the value of a value property and adds the comment if it exists.
 *
438
 * @param object $variable
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
 *   A stdClass object with at least a value property.
 * @param string $prefix
 *   A string to prepend to the variable's value.
 * @param string $suffix
 *   A string to append to the variable's value.
 * @return string
 *   A string containing valid PHP code of the variable suitable for placing
 *   into settings.php.
 */
function _drupal_rewrite_settings_dump_one(\stdClass $variable, $prefix = '', $suffix = '') {
  $return = $prefix . var_export($variable->value, TRUE) . ';';
  if (!empty($variable->comment)) {
    $return .= ' // ' . $variable->comment;
  }
  $return .= $suffix;
  return $return;
}

457 458 459 460 461 462
/**
 * Creates the config directory and ensures it is operational.
 *
 * @see install_settings_form_submit()
 * @see update_prepare_d8_bootstrap()
 */
463
function drupal_install_config_directories() {
464
  global $config_directories;
465 466 467

  // Add a randomized config directory name to settings.php, unless it was
  // manually defined in the existing already.
468
  if (empty($config_directories)) {
469
    $config_directories_hash = Crypt::randomBytesBase64(55);
470
    $settings['config_directories'] = array(
471 472 473
      CONFIG_ACTIVE_DIRECTORY => (object) array(
        'value' => conf_path() . '/files/config_' . $config_directories_hash . '/active',
        'required' => TRUE,
474
      ),
475 476 477
      CONFIG_STAGING_DIRECTORY => (object) array(
        'value' => conf_path() . '/files/config_' . $config_directories_hash . '/staging',
        'required' => TRUE,
478
      ),
479 480 481 482 483
    );
    // Rewrite settings.php, which also sets the value as global variable.
    drupal_rewrite_settings($settings);
  }

484
  // Ensure the config directories exist or can be created, and are writable.
485
  foreach (array(CONFIG_ACTIVE_DIRECTORY, CONFIG_STAGING_DIRECTORY) as $config_type) {
486 487 488 489 490 491
    // This should never fail, since if the config directory was specified in
    // settings.php it will have already been created and verified earlier, and
    // if it wasn't specified in settings.php, it is created here inside the
    // public files directory, which has already been verified to be writable
    // itself. But if it somehow fails anyway, the installation cannot proceed.
    // Bail out using a similar error message as in system_requirements().
492
    if (!install_ensure_config_directory($config_type)) {
493
      throw new Exception(t('The directory %directory could not be created or could not be made writable. To proceed with the installation, either create the directory and modify its permissions manually or ensure that the installer has the permissions to create it automatically. For more information, see the <a href="@handbook_url">online handbook</a>.', array(
494 495 496 497
        '%directory' => config_get_config_directory($config_type),
        '@handbook_url' => 'http://drupal.org/server-permissions',
      )));
    }
498 499 500 501 502 503 504

    // Put a README.txt into each config directory. This is required so that
    // they can later be added to git. Since these directories are auto-
    // created, we have to write out the README rather than just adding it
    // to the drupal core repo.
    switch ($config_type) {
      case CONFIG_ACTIVE_DIRECTORY:
505
        $text = 'This directory contains the active configuration for your Drupal site. To move this configuration between environments, contents from this directory should be placed in the staging directory on the target server. To make this configuration active, see admin/config/development/configuration/sync on the target server.';
506 507
        break;
      case CONFIG_STAGING_DIRECTORY:
508
        $text = 'This directory contains configuration to be imported into your Drupal site. To make this configuration active, see admin/config/development/configuration/sync.';
509 510 511 512
        break;
    }
    $text .=  ' For information about deploying configuration between servers, see http://drupal.org/documentation/administer/config';
    file_put_contents(config_get_config_directory($config_type) . '/README.txt', $text);
513 514 515
  }
}

516
/**
517
 * Checks whether a config directory exists and is writable.
518
 *
519
 * This partially duplicates install_ensure_config_directory(), but is required
520 521
 * since the installer would create the config directory too early in the
 * installation process otherwise (e.g., when only visiting install.php when
522 523
 * there is a settings.php already, but not actually executing the
 * installation).
524 525 526 527 528 529 530 531 532 533 534 535 536
 *
 * @param string $type
 *   Type of config directory to return. Drupal core provides 'active' and
 *   'staging'.
 *
 * @return bool
 *   TRUE if the config directory exists and is writable.
 */
function install_verify_config_directory($type) {
  global $config_directories;
  if (!isset($config_directories[$type])) {
    return FALSE;
  }
537 538 539 540 541 542 543 544 545 546
  // config_get_config_directory() throws an exception when the passed $type
  // does not exist in $config_directories. This can happen if there is a
  // prepared settings.php that defines $config_directories already.
  try {
    $config_directory = config_get_config_directory($type);
    if (is_dir($config_directory) && is_writable($config_directory)) {
      return TRUE;
    }
  }
  catch (\Exception $e) {
547 548 549 550
  }
  return FALSE;
}

551 552
/**
 * Ensures that the config directory exists and is writable, or can be made so.
553 554 555 556 557 558 559
 *
 * @param string $type
 *   Type of config directory to return. Drupal core provides 'active' and
 *   'staging'.
 *
 * @return bool
 *   TRUE if the config directory exists and is writable.
560
 */
561
function install_ensure_config_directory($type) {
562
  // The config directory must be defined in settings.php.
563 564
  global $config_directories;
  if (!isset($config_directories[$type])) {
565 566 567 568 569
    return FALSE;
  }
  // The logic here is similar to that used by system_requirements() for other
  // directories that the installer creates.
  else {
570
    $config_directory = config_get_config_directory($type);
571
    return file_prepare_directory($config_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
572 573 574
  }
}

575
/**
576
 * Verifies that all dependencies are met for a given installation profile.
577
 *
578 579
 * @param $install_state
 *   An array of information about the current installation state.
580
 *
Steven Wittens's avatar
Steven Wittens committed
581 582
 * @return
 *   The list of modules to install.
583
 */
584
function drupal_verify_profile($install_state) {
585 586
  include_once __DIR__ . '/file.inc';
  include_once __DIR__ . '/common.inc';
587

588
  $profile = $install_state['parameters']['profile'];
589
  if (!isset($profile) || !isset($install_state['profiles'][$profile])) {
590
    throw new Exception(install_no_profile_error());
591
  }
592
  $info = $install_state['profile_info'];
593

594 595
  // Get the list of available modules for the selected installation profile.
  $listing = new ExtensionDiscovery();
596
  $present_modules = array();
597
  foreach ($listing->scan('module') as $present_module) {
598
    $present_modules[] = $present_module->getName();
599 600
  }

601 602
  // The installation profile is also a module, which needs to be installed
  // after all the other dependencies have been installed.
603
  $present_modules[] = $profile;
604

605
  // Verify that all of the profile's required modules are present.
606
  $missing_modules = array_diff($info['dependencies'], $present_modules);
607 608

  $requirements = array();
609

610
  if (count($missing_modules)) {
611
    $modules = array();
612
    foreach ($missing_modules as $module) {
613
      $modules[] = '<span class="admin-missing">' . drupal_ucfirst($module) . '</span>';
Steven Wittens's avatar
Steven Wittens committed
614
    }
615
    $requirements['required_modules'] = array(
616 617
      'title'       => t('Required modules'),
      'value'       => t('Required modules not found.'),
618
      'severity'    => REQUIREMENT_ERROR,
619
      'description' => t('The following modules are required but were not found. Move them into the appropriate modules subdirectory, such as <em>/modules</em>. Missing modules: !modules', array('!modules' => implode(', ', $modules))),
620
    );
Steven Wittens's avatar
Steven Wittens committed
621
  }
622
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
623
}
624

625
/**
626
 * Installs the system module.
627 628 629
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
630 631 632 633
 *
 * @param array $install_state
 *   An array of information about the current installation state. This is used
 *   to set the default language.
634
 */
635
function drupal_install_system($install_state) {
636
  // Boot a new kernel into a regular production environment.
637 638 639 640 641
  $request = \Drupal::hasRequest() ? \Drupal::request() : FALSE;

  unset($GLOBALS['conf']['container_service_providers']['InstallerServiceProvider']);
  $kernel = new DrupalKernel('prod', drupal_classloader(), FALSE);
  $kernel->boot();
642

643 644 645
  if ($request) {
    $kernel->getContainer()->enterScope('request');
    $kernel->getContainer()->set('request', $request, 'request');
646
    $kernel->getContainer()->get('request_stack')->push($request);
647
  }
648

649 650
  // Install base system configuration.
  \Drupal::service('config.installer')->installDefaultConfig('core', 'core');
651

652 653
  // Install System module.
  \Drupal::moduleHandler()->install(array('system'), FALSE);
654

655 656 657 658 659 660
  // Ensure default language is saved.
  if (isset($install_state['parameters']['langcode'])) {
    \Drupal::config('system.site')
      ->set('langcode', $install_state['parameters']['langcode'])
      ->save();
  }
661 662
}

663
/**
664
 * Verifies the state of the specified file.
665 666 667 668 669 670 671
 *
 * @param $file
 *   The file to check for.
 * @param $mask
 *   An optional bitmask created from various FILE_* constants.
 * @param $type
 *   The type of file. Can be file (default), dir, or link.
672
 *
673
 * @return
674
 *   TRUE on success or FALSE on failure. A message is set for the latter.
675 676 677 678 679 680 681 682 683
 */
function drupal_verify_install_file($file, $mask = NULL, $type = 'file') {
  $return = TRUE;
  // Check for files that shouldn't be there.
  if (isset($mask) && ($mask & FILE_NOT_EXIST) && file_exists($file)) {
    return FALSE;
  }
  // Verify that the file is the type of file it is supposed to be.
  if (isset($type) && file_exists($file)) {
684
    $check = 'is_' . $type;
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
    if (!function_exists($check) || !$check($file)) {
      $return = FALSE;
    }
  }

  // Verify file permissions.
  if (isset($mask)) {
    $masks = array(FILE_EXIST, FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
    foreach ($masks as $current_mask) {
      if ($mask & $current_mask) {
        switch ($current_mask) {
          case FILE_EXIST:
            if (!file_exists($file)) {
              if ($type == 'dir') {
                drupal_install_mkdir($file, $mask);
              }
              if (!file_exists($file)) {
                $return = FALSE;
              }
            }
            break;
          case FILE_READABLE:
            if (!is_readable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
          case FILE_WRITABLE:
            if (!is_writable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
          case FILE_EXECUTABLE:
            if (!is_executable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
          case FILE_NOT_READABLE:
            if (is_readable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
          case FILE_NOT_WRITABLE:
            if (is_writable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
          case FILE_NOT_EXECUTABLE:
            if (is_executable($file) && !drupal_install_fix_file($file, $mask)) {
              $return = FALSE;
            }
            break;
        }
      }
    }
  }
  return $return;
}

/**
744
 * Creates a directory with the specified permissions.
745
 *
746
 * @param $file
747
 *  The name of the directory to create;
748
 * @param $mask
749 750 751
 *  The permissions of the directory to create.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
752
 *
753 754 755 756 757 758 759 760 761 762
 * @return
 *  TRUE/FALSE whether or not the directory was successfully created.
 */
function drupal_install_mkdir($file, $mask, $message = TRUE) {
  $mod = 0;
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
763
          $mod |= 0444;
764 765
          break;
        case FILE_WRITABLE:
766
          $mod |= 0222;
767 768
          break;
        case FILE_EXECUTABLE:
769
          $mod |= 0111;
770 771 772 773 774
          break;
      }
    }
  }

775
  if (@drupal_mkdir($file, $mod)) {
776 777 778 779 780 781 782 783
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
784
 * Attempts to fix file permissions.
785
 *
786 787 788 789 790 791 792 793 794
 * The general approach here is that, because we do not know the security
 * setup of the webserver, we apply our permission changes to all three
 * digits of the file permission (i.e. user, group and all).
 *
 * To ensure that the values behave as expected (and numbers don't carry
 * from one digit to the next) we do the calculation on the octal value
 * using bitwise operations. This lets us remove, for example, 0222 from
 * 0700 and get the correct value of 0500.
 *
795 796 797 798 799 800
 * @param $file
 *  The name of the file with permissions to fix.
 * @param $mask
 *  The desired permissions for the file.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
801
 *
802 803 804 805
 * @return
 *  TRUE/FALSE whether or not we were able to fix the file's permissions.
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
806 807 808 809 810
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

811
  $mod = fileperms($file) & 0777;
812
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
813 814 815 816 817

  // FILE_READABLE, FILE_WRITABLE, and FILE_EXECUTABLE permission strings
  // can theoretically be 0400, 0200, and 0100 respectively, but to be safe
  // we set all three access types in case the administrator intends to
  // change the owner of settings.php after installation.
818 819 820 821 822
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
823
            $mod |= 0444;
824 825 826 827
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
828
            $mod |= 0222;
829 830 831 832
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
833
            $mod |= 0111;
834 835 836 837
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
838
            $mod &= ~0444;
839 840 841 842
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
843
            $mod &= ~0222;
844 845 846 847
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
848
            $mod &= ~0111;
849 850 851 852 853 854
          }
          break;
      }
    }
  }

855 856
  // chmod() will work if the web server is running as owner of the file.
  if (@chmod($file, $mod)) {
857 858 859 860 861 862 863
    return TRUE;
  }
  else {
    return FALSE;
  }
}

864
/**
865
 * Sends the user to a different installer page.
866 867
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
868 869 870 871 872
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
873
  global $base_url;
874 875 876 877 878 879
  $headers = array(
    // Not a permanent redirect.
    'Cache-Control' => 'no-cache',
  );
  $response = new RedirectResponse($base_url . '/' . $path, 302, $headers);
  $response->send();
880 881
}

882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
/**
 * Returns the URL of the current script, with modified query parameters.
 *
 * This function can be called by low-level scripts (such as install.php and
 * update.php) and returns the URL of the current script. Existing query
 * parameters are preserved by default, but new ones can optionally be merged
 * in.
 *
 * This function is used when the script must maintain certain query parameters
 * over multiple page requests in order to work correctly. In such cases (for
 * example, update.php, which requires the 'continue=1' parameter to remain in
 * the URL throughout the update process if there are any requirement warnings
 * that need to be bypassed), using this function to generate the URL for links
 * to the next steps of the script ensures that the links will work correctly.
 *
 * @param $query
 *   (optional) An array of query parameters to merge in to the existing ones.
 *
 * @return
 *   The URL of the current script, with query parameters modified by the
 *   passed-in $query. The URL is not sanitized, so it still needs to be run
 *   through check_url() if it will be used as an HTML attribute value.
 *
 * @see drupal_requirements_url()
 */
function drupal_current_script_url($query = array()) {
  $uri = $_SERVER['SCRIPT_NAME'];
  $query = array_merge(drupal_get_query_parameters(), $query);
  if (!empty($query)) {
    $uri .= '?' . drupal_http_build_query($query);
  }
  return $uri;
}

/**
 * Returns a URL for proceeding to the next page after a requirements problem.
 *
 * This function can be called by low-level scripts (such as install.php and
 * update.php) and returns a URL that can be used to attempt to proceed to the
 * next step of the script.
 *
 * @param $severity
 *   The severity of the requirements problem, as returned by
 *   drupal_requirements_severity().
 *
 * @return
 *   A URL for attempting to proceed to the next step of the script. The URL is
 *   not sanitized, so it still needs to be run through check_url() if it will
 *   be used as an HTML attribute value.
 *
 * @see drupal_current_script_url()
 */
function drupal_requirements_url($severity) {
  $query = array();
  // If there are no errors, only warnings, append 'continue=1' to the URL so
  // the user can bypass this screen on the next page load.
  if ($severity == REQUIREMENT_WARNING) {
    $query['continue'] = 1;
  }
  return drupal_current_script_url($query);
}

944
/**
945
 * Checks an installation profile's requirements.
946
 *
947
 * @param string $profile
948
 *   Name of installation profile to check.
949 950 951 952
 * @param array $install_state
 *   The current state in the install process.
 *
 * @return array
953
 *   Array of the installation profile's requirements.
954
 */
955
function drupal_check_profile($profile, array $install_state) {
956
  include_once __DIR__ . '/file.inc';
957

958
  if (!isset($profile) || !isset($install_state['profiles'][$profile])) {
959
    throw new Exception(install_no_profile_error());
960 961
  }

962
  $info = install_profile_info($profile);
963

964
  // Collect requirement testing results.
965
  $requirements = array();
966 967 968
  foreach ($info['dependencies'] as $module) {
    module_load_install($module);
    $function = $module . '_requirements';
969 970
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
971
    }
972 973 974 975 976
  }
  return $requirements;
}

/**
977
 * Extracts the highest severity from the requirements array.
978 979
 *
 * @param $requirements
980
 *   An array of requirements, in the same format as is returned by
981
 *   hook_requirements().
982
 *
983 984
 * @return
 *   The highest severity in the array.
985 986 987 988 989 990 991 992 993 994 995 996
 */
function drupal_requirements_severity(&$requirements) {
  $severity = REQUIREMENT_OK;
  foreach ($requirements as $requirement) {
    if (isset($requirement['severity'])) {
      $severity = max($severity, $requirement['severity']);
    }
  }
  return $severity;
}

/**
997
 * Checks a module's requirements.
998 999 1000
 *
 * @param $module
 *   Machine name of module to check.
1001
 *
1002
 * @return
1003
 *   TRUE or FALSE, depending on whether the requirements are met.
1004 1005
 */
function drupal_check_module($module) {
1006
  module_load_install($module);
1007
  // Check requirements
1008
  $requirements = \Drupal::moduleHandler()->invoke($module, 'requirements', array('install'));
1009 1010 1011 1012 1013 1014 1015
  if (is_array($requirements) && drupal_requirements_severity($requirements) == REQUIREMENT_ERROR) {
    // Print any error messages
    foreach ($requirements as $requirement) {
      if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_ERROR) {
        $message = $requirement['description'];
        if (isset($requirement['value']) && $requirement['value']) {
          $message .= ' (' . t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) . ')';
1016
        }
1017
        drupal_set_message($message, 'error');
1018 1019
      }
    }
1020
    return FALSE;
1021 1022 1023
  }
  return TRUE;
}
1024 1025

/**
1026
 * Retrieves information about an installation profile from its .info.yml file.
1027
 *
1028 1029
 * The information stored in a profile .info.yml file is similar to that stored
 * in a normal Drupal module .info.yml file. For example:
1030
 * - name: The real name of the installation profile for display purposes.
1031
 * - descri