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

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

8
use Drupal\Component\Utility\Unicode;
9
use Symfony\Component\HttpFoundation\RedirectResponse;
10
use Drupal\Component\Utility\Crypt;
11
use Drupal\Component\Utility\OpCodeCache;
12
use Drupal\Component\Utility\SafeMarkup;
13
use Drupal\Component\Utility\UrlHelper;
14
use Drupal\Core\Extension\ExtensionDiscovery;
15
use Drupal\Core\Site\Settings;
16

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $databases;
}

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

141 142
  // The internal database driver name is any valid PHP identifier.
  $mask = '/^' . DRUPAL_PHP_FUNCTION_PATTERN . '$/';
143 144 145 146 147
  $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) {
148
    if (file_exists($file->uri . '/Install/Tasks.php')) {
149 150
      $drivers[$file->filename] = $file->uri;
    }
151 152
  }
  foreach ($drivers as $driver => $file) {
153
    $installer = db_installer_object($driver);
154
    if ($installer->installable()) {
155
      $databases[$driver] = $installer;
156 157
    }
  }
158

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

166 167 168
  return $databases;
}

169
/**
170
 * Replaces values in settings.php with values in the submitted array.
171
 *
172 173 174 175
 * 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.
 *
176
 * @param $settings
177 178 179 180 181
 *   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(
182 183 184
 *     CONFIG_ACTIVE_DIRECTORY => (object) array(
 *       'value' => 'config_hash/active'
 *       'required' => TRUE,
185
 *     ),
186 187 188
 *     CONFIG_STAGING_DIRECTORY => (object) array(
 *       'value' => 'config_hash/staging',
 *       'required' => TRUE,
189 190 191 192 193
 *     ),
 *   );
 *   @endcode
 *   gets dumped as:
 *   @code
194 195
 *   $config_directories['active'] = 'config_hash/active';
 *   $config_directories['staging'] = 'config_hash/staging'
196
 *   @endcode
197
 */
198 199 200 201
function drupal_rewrite_settings($settings = array(), $settings_file = NULL) {
  if (!isset($settings_file)) {
    $settings_file = conf_path(FALSE) . '/settings.php';
  }
202
  // Build list of setting names and insert the values into the global namespace.
203
  $variable_names = array();
204
  $settings_settings = array();
205
  foreach ($settings as $setting => $data) {
206 207 208 209 210 211
    if ($setting != 'settings') {
      _drupal_rewrite_settings_global($GLOBALS[$setting], $data);
    }
    else {
      _drupal_rewrite_settings_global($settings_settings, $data);
    }
212
    $variable_names['$'. $setting] = $setting;
213
  }
214 215
  $contents = file_get_contents(DRUPAL_ROOT . '/' . $settings_file);
  if ($contents !== FALSE) {
216 217 218 219
    // Initialize the contents for the settings.php file if it is empty.
    if (trim($contents) === '') {
      $contents = "<?php\n";
    }
220 221
    // Step through each token in settings.php and replace any variables that
    // are in the passed-in array.
222 223
    $buffer = '';
    $state = 'default';
224
    foreach (token_get_all($contents) as $token) {
225 226
      if (is_array($token)) {
        list($type, $value) = $token;
227
      }
228
      else {
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 306
        $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.
307
              throw new Exception('Unexpected token after replacing value.');
308 309
            }
            break;
310 311
        }
      }
312
      $buffer .= $value;
313
    }
314 315
    foreach ($settings as $name => $setting) {
      $buffer .= _drupal_rewrite_settings_dump($setting, '$' . $name);
316 317
    }

318 319
    // Write the new settings file.
    if (file_put_contents(DRUPAL_ROOT . '/' . $settings_file, $buffer) === FALSE) {
320
      throw new Exception(t('Failed to modify %settings. Verify the file permissions.', array('%settings' => $settings_file)));
321
    }
322 323 324 325
    else {
      // In case any $settings variables were written, import them into the
      // Settings singleton.
      if (!empty($settings_settings)) {
326
        $old_settings = Settings::getAll();
327 328
        new Settings($settings_settings + $old_settings);
      }
329 330 331 332 333
      // 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);
334
    }
335 336
  }
  else {
337
    throw new Exception(t('Failed to open %settings. Verify the file permissions.', array('%settings' => $settings_file)));
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
/**
 * 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
368
 * string.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
 *
 * @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.
 *
389
 * @param array|null $ref
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 438
 *   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.
 *
439
 * @param object $variable
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
 *   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;
}

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

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

  if (!empty($settings)) {
485 486 487 488
    // Rewrite settings.php, which also sets the value as global variable.
    drupal_rewrite_settings($settings);
  }

489
  // Ensure the config directories exist or can be created, and are writable.
490
  foreach (array(CONFIG_ACTIVE_DIRECTORY, CONFIG_STAGING_DIRECTORY) as $config_type) {
491 492 493 494 495 496
    // 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().
497
    if (!install_ensure_config_directory($config_type)) {
498
      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(
499 500 501 502
        '%directory' => config_get_config_directory($config_type),
        '@handbook_url' => 'http://drupal.org/server-permissions',
      )));
    }
503 504 505 506 507 508 509

    // 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:
510
        $text = 'If you change the configuration system to use file storage instead of the database for the active Drupal site configuration, this directory will contain the active configuration. By default, this directory will be empty. If you are using files to store the active configuration, and you want to move it between environments, files from this directory should be placed in the staging directory on the target server. To make this configuration active, visit admin/config/development/configuration/sync on the target server.';
511 512
        break;
      case CONFIG_STAGING_DIRECTORY:
513
        $text = 'This directory contains configuration to be imported into your Drupal site. To make this configuration active, visit admin/config/development/configuration/sync.';
514 515 516 517
        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);
518 519 520 521 522
  }
}

/**
 * Ensures that the config directory exists and is writable, or can be made so.
523 524 525 526 527 528 529
 *
 * @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.
530
 */
531
function install_ensure_config_directory($type) {
532
  // The config directory must be defined in settings.php.
533 534
  global $config_directories;
  if (!isset($config_directories[$type])) {
535 536 537 538 539
    return FALSE;
  }
  // The logic here is similar to that used by system_requirements() for other
  // directories that the installer creates.
  else {
540
    $config_directory = config_get_config_directory($type);
541
    return file_prepare_directory($config_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
542 543 544
  }
}

545
/**
546
 * Verifies that all dependencies are met for a given installation profile.
547
 *
548 549
 * @param $install_state
 *   An array of information about the current installation state.
550
 *
Steven Wittens's avatar
Steven Wittens committed
551 552
 * @return
 *   The list of modules to install.
553
 */
554
function drupal_verify_profile($install_state) {
555
  $profile = $install_state['parameters']['profile'];
556
  $info = $install_state['profile_info'];
557

558
  // Get the list of available modules for the selected installation profile.
559
  $listing = new ExtensionDiscovery(DRUPAL_ROOT);
560
  $present_modules = array();
561
  foreach ($listing->scan('module') as $present_module) {
562
    $present_modules[] = $present_module->getName();
563 564
  }

565 566
  // The installation profile is also a module, which needs to be installed
  // after all the other dependencies have been installed.
567
  $present_modules[] = $profile;
568

569
  // Verify that all of the profile's required modules are present.
570
  $missing_modules = array_diff($info['dependencies'], $present_modules);
571 572

  $requirements = array();
573

574
  if (count($missing_modules)) {
575
    $modules = array();
576
    foreach ($missing_modules as $module) {
577
      $modules[] = '<span class="admin-missing">' . Unicode::ucfirst($module) . '</span>';
Steven Wittens's avatar
Steven Wittens committed
578
    }
579
    $requirements['required_modules'] = array(
580 581
      'title'       => t('Required modules'),
      'value'       => t('Required modules not found.'),
582
      'severity'    => REQUIREMENT_ERROR,
583
      '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))),
584
    );
Steven Wittens's avatar
Steven Wittens committed
585
  }
586
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
587
}
588

589
/**
590
 * Installs the system module.
591 592 593
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
594 595 596 597
 *
 * @param array $install_state
 *   An array of information about the current installation state. This is used
 *   to set the default language.
598
 */
599
function drupal_install_system($install_state) {
600
  // Remove the service provider of the early installer.
601
  unset($GLOBALS['conf']['container_service_providers']['InstallerServiceProvider']);
602

603 604 605 606 607 608 609 610
  $request = \Drupal::request();
  // Reboot into a full production environment to continue the installation.
  /** @var \Drupal\Core\Installer\InstallerKernel $kernel */
  $kernel = \Drupal::service('kernel');
  $kernel->shutdown();
  // Have installer rebuild from the disk, rather then building from scratch.
  $kernel->rebuildContainer(FALSE);
  $kernel->prepareLegacyRequest($request);
611

612 613
  // Install base system configuration.
  \Drupal::service('config.installer')->installDefaultConfig('core', 'core');
614

615
  // Install System module and rebuild the newly available routes.
616
  $kernel->getContainer()->get('module_installer')->install(array('system'), FALSE);
617
  \Drupal::service('router.builder')->rebuild();
618

619 620
  // Ensure default language is saved.
  if (isset($install_state['parameters']['langcode'])) {
621
    \Drupal::configFactory()->getEditable('system.site')
622
      ->set('langcode', $install_state['parameters']['langcode'])
623
      ->set('default_langcode', $install_state['parameters']['langcode'])
624 625
      ->save();
  }
626 627
}

628
/**
629
 * Verifies the state of the specified file.
630 631 632 633 634 635 636
 *
 * @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.
637
 *
638
 * @return
639
 *   TRUE on success or FALSE on failure. A message is set for the latter.
640 641 642 643 644 645 646 647 648
 */
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)) {
649
    $check = 'is_' . $type;
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
    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;
}

/**
709
 * Creates a directory with the specified permissions.
710
 *
711
 * @param $file
712
 *  The name of the directory to create;
713
 * @param $mask
714 715 716
 *  The permissions of the directory to create.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
717
 *
718 719 720 721 722 723 724 725 726 727
 * @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:
728
          $mod |= 0444;
729 730
          break;
        case FILE_WRITABLE:
731
          $mod |= 0222;
732 733
          break;
        case FILE_EXECUTABLE:
734
          $mod |= 0111;
735 736 737 738 739
          break;
      }
    }
  }

740
  if (@drupal_mkdir($file, $mod)) {
741 742 743 744 745 746 747 748
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
749
 * Attempts to fix file permissions.
750
 *
751 752 753 754 755 756 757 758 759
 * 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.
 *
760 761 762 763 764 765
 * @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.
766
 *
767 768 769 770
 * @return
 *  TRUE/FALSE whether or not we were able to fix the file's permissions.
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
771 772 773 774 775
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

776
  $mod = fileperms($file) & 0777;
777
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
778 779 780 781 782

  // 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.
783 784 785 786 787
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
788
            $mod |= 0444;
789 790 791 792
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
793
            $mod |= 0222;
794 795 796 797
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
798
            $mod |= 0111;
799 800 801 802
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
803
            $mod &= ~0444;
804 805 806 807
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
808
            $mod &= ~0222;
809 810 811 812
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
813
            $mod &= ~0111;
814 815 816 817 818 819
          }
          break;
      }
    }
  }

820 821
  // chmod() will work if the web server is running as owner of the file.
  if (@chmod($file, $mod)) {
822 823 824 825 826 827 828
    return TRUE;
  }
  else {
    return FALSE;
  }
}

829
/**
830
 * Sends the user to a different installer page.
831 832
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
833 834 835 836 837
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
838
  global $base_url;
839 840 841 842 843 844
  $headers = array(
    // Not a permanent redirect.
    'Cache-Control' => 'no-cache',
  );
  $response = new RedirectResponse($base_url . '/' . $path, 302, $headers);
  $response->send();
845 846
}

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
/**
 * 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'];
874
  $query = array_merge(UrlHelper::filterQueryParameters(\Drupal::request()->query->all()), $query);
875
  if (!empty($query)) {
876
    $uri .= '?' . UrlHelper::buildQuery($query);
877 878 879 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
  }
  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);
}

909
/**
910
 * Checks an installation profile's requirements.
911
 *
912
 * @param string $profile
913
 *   Name of installation profile to check.
914 915 916 917
 * @param array $install_state
 *   The current state in the install process.
 *
 * @return array
918
 *   Array of the installation profile's requirements.
919
 */
920
function drupal_check_profile($profile, array $install_state) {
921
  $info = install_profile_info($profile);
922

923
  // Collect requirement testing results.
924
  $requirements = array();
925 926 927
  foreach ($info['dependencies'] as $module) {
    module_load_install($module);
    $function = $module . '_requirements';
928 929
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
930
    }
931 932 933 934 935
  }
  return $requirements;
}

/**
936
 * Extracts the highest severity from the requirements array.
937 938
 *
 * @param $requirements
939
 *   An array of requirements, in the same format as is returned by
940
 *   hook_requirements().
941
 *
942 943
 * @return
 *   The highest severity in the array.
944 945 946 947 948 949 950 951 952 953 954 955
 */
function drupal_requirements_severity(&$requirements) {
  $severity = REQUIREMENT_OK;
  foreach ($requirements as $requirement) {
    if (isset($requirement['severity'])) {
      $severity = max($severity, $requirement['severity']);
    }
  }
  return $severity;
}

/**
956
 * Checks a module's requirements.
957 958 959
 *
 * @param $module
 *   Machine name of module to check.
960
 *
961
 * @return
962
 *   TRUE or FALSE, depending on whether the requirements are met.
963 964
 */
function drupal_check_module($module) {
965
  module_load_install($module);
966
  // Check requirements
967
  $requirements = \Drupal::moduleHandler()->invoke($module, 'requirements', array('install'));
968 969 970 971
  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) {
972
        $message = SafeMarkup::escape($requirement['description']);
973 974
        if (isset($requirement['value']) && $requirement['value']) {
          $message .= ' (' . t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) . ')';
975
        }
976 977 978 979
        // The string was previously checked as safe or escaped properly with
        // SafeMarkup::escape() method and the concatinated message string is
        // designated safe by running through the t() function.
        drupal_set_message(SafeMarkup::set($message), 'error');
980 981
      }
    }
982
    return FALSE;
983 984 985
  }
  return TRUE;
}
986 987

/**
988
 * Retrieves information about an installation profile from its .info.yml file.
989
 *
990 991
 * The information stored in a profile .info.yml file is similar to that stored
 * in a normal Drupal module .info.yml file. For example:
992
 * - name: The real name of the installation profile for display purposes.
993
 * - description: A brief description of the profile.
994 995
 * - dependencies: An array of shortnames of other modules that this install
 *   profile requires.
996
 *
997 998 999
 * Additional, less commonly-used information that can appear in a
 * profile.info.yml file but not in a normal Drupal module .info.yml file
 * includes:
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
 *
 * - distribution: Existence of this key denotes that the installation profile
 *   is intended to be the only eligible choice in a distribution and will be
 *   auto-selected during installation, whereas the installation profile
 *   selection screen will be skipped. If more than one distribution profile is
 *   found then the first one discovered will be selected.
 *   The following subproperties may be set:
 *   - name: The name of the distribution that is being installed, to be shown
 *     throughout the installation process. If omitted,
 *     drupal_install_profile_distribution_name() defaults to 'Drupal'.
 *   - install: Optional parameters to override the installer:
 *     - theme: The machine name of a theme to use in the installer instead of
 *       Drupal's default installer theme.
1013
 *
1014 1015 1016 1017
 * Note that this function does an expensive file system scan to get info file
 * information for dependencies. If you only need information from the info
 * file itself, use system_get_info().
 *
1018
 * Example of .info.yml file:
1019
 * @code
1020 1021
 *    name = Minimal
 *    description = Start fresh, with only a few modules enabled.
1022 1023
 *    dependencies[] = block
 *    dependencies[] = dblog
1024
 * @endcode
1025
 *