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

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

8
use Drupal\Component\Utility\OpCodeCache;
9
use Drupal\Component\Utility\Unicode;
10
use Drupal\Component\Utility\UrlHelper;
11
use Drupal\Core\Extension\Dependency;
12
use Drupal\Core\Extension\ExtensionDiscovery;
13
use Drupal\Core\Installer\InstallerKernel;
14
use Drupal\Core\Site\Settings;
15
use Symfony\Component\HttpFoundation\RedirectResponse;
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 = [];
101
  if (InstallerKernel::installationAttempted()) {
102
    global $install_state;
103 104 105
    if (isset($install_state['profile_info'])) {
      $info = $install_state['profile_info'];
    }
106 107 108
  }
  // At all other times, we load the profile via standard methods.
  else {
109
    $profile = \Drupal::installProfile();
110
    $info = \Drupal::service('extension.list.profile')->getExtensionInfo($profile);
111
  }
112
  return isset($info['distribution']['name']) ? $info['distribution']['name'] : 'Drupal';
113 114
}

115 116 117
/**
 * Loads the installation profile, extracting its defined version.
 *
118 119 120 121
 * @return string
 *   Distribution version defined in the profile's .info.yml file.
 *   Defaults to \Drupal::VERSION if no version is explicitly provided by the
 *   installation profile.
122 123 124 125 126 127
 *
 * @see install_profile_info()
 */
function drupal_install_profile_distribution_version() {
  // During installation, the profile information is stored in the global
  // installation state (it might not be saved anywhere yet).
128
  if (InstallerKernel::installationAttempted()) {
129 130 131 132 133
    global $install_state;
    return isset($install_state['profile_info']['version']) ? $install_state['profile_info']['version'] : \Drupal::VERSION;
  }
  // At all other times, we load the profile via standard methods.
  else {
134
    $profile = \Drupal::installProfile();
135
    $info = \Drupal::service('extension.list.profile')->getExtensionInfo($profile);
136 137 138 139
    return $info['version'];
  }
}

140
/**
141
 * Detects all supported databases that are compiled into PHP.
142 143
 *
 * @return
144
 *   An array of database types compiled into PHP.
145 146
 */
function drupal_detect_database_types() {
147 148 149 150 151 152 153 154 155 156
  $databases = drupal_get_database_types();

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

  return $databases;
}

/**
157
 * Returns all supported database driver installer objects.
158
 *
159 160
 * @return \Drupal\Core\Database\Install\Tasks[]
 *   An array of available database driver installer objects.
161 162
 */
function drupal_get_database_types() {
163 164
  $databases = [];
  $drivers = [];
165

166 167
  // The internal database driver name is any valid PHP identifier.
  $mask = '/^' . DRUPAL_PHP_FUNCTION_PATTERN . '$/';
168 169 170
  /** @var \Drupal\Core\File\FileSystemInterface $file_system */
  $file_system = \Drupal::service('file_system');
  $files = $file_system->scanDirectory(DRUPAL_ROOT . '/core/lib/Drupal/Core/Database/Driver', $mask, ['recurse' => FALSE]);
171
  if (is_dir(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database')) {
172
    $files += $file_system->scanDirectory(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database/', $mask, ['recurse' => FALSE]);
173 174
  }
  foreach ($files as $file) {
175
    if (file_exists($file->uri . '/Install/Tasks.php')) {
176 177
      $drivers[$file->filename] = $file->uri;
    }
178 179
  }
  foreach ($drivers as $driver => $file) {
180
    $installer = db_installer_object($driver);
181
    if ($installer->installable()) {
182
      $databases[$driver] = $installer;
183 184
    }
  }
185

186
  // Usability: unconditionally put the MySQL driver on top.
187 188 189
  if (isset($databases['mysql'])) {
    $mysql_database = $databases['mysql'];
    unset($databases['mysql']);
190
    $databases = ['mysql' => $mysql_database] + $databases;
191
  }
192

193 194 195
  return $databases;
}

196
/**
197
 * Replaces values in settings.php with values in the submitted array.
198
 *
199 200 201 202
 * 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.
 *
203
 * @param $settings
204 205 206 207
 *   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
208 209 210
 *   $settings['settings']['config_sync_directory'] = (object) array(
 *     'value' => 'config_hash/sync',
 *     'required' => TRUE,
211 212 213 214
 *   );
 *   @endcode
 *   gets dumped as:
 *   @code
215
 *   $settings['config_sync_directory'] = 'config_hash/sync'
216
 *   @endcode
217
 */
218
function drupal_rewrite_settings($settings = [], $settings_file = NULL) {
219
  if (!isset($settings_file)) {
220
    $settings_file = \Drupal::service('site.path') . '/settings.php';
221
  }
222
  // Build list of setting names and insert the values into the global namespace.
223 224
  $variable_names = [];
  $settings_settings = [];
225
  foreach ($settings as $setting => $data) {
226 227 228 229 230 231
    if ($setting != 'settings') {
      _drupal_rewrite_settings_global($GLOBALS[$setting], $data);
    }
    else {
      _drupal_rewrite_settings_global($settings_settings, $data);
    }
232
    $variable_names['$' . $setting] = $setting;
233
  }
234
  $contents = file_get_contents($settings_file);
235
  if ($contents !== FALSE) {
236 237 238 239
    // Initialize the contents for the settings.php file if it is empty.
    if (trim($contents) === '') {
      $contents = "<?php\n";
    }
240 241
    // Step through each token in settings.php and replace any variables that
    // are in the passed-in array.
242 243
    $buffer = '';
    $state = 'default';
244
    foreach (token_get_all($contents) as $token) {
245 246
      if (is_array($token)) {
        list($type, $value) = $token;
247
      }
248
      else {
249 250 251 252
        $type = -1;
        $value = $token;
      }
      // Do not operate on whitespace.
253
      if (!in_array($type, [T_WHITESPACE, T_COMMENT, T_DOC_COMMENT])) {
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 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
        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.
327
              throw new Exception('Unexpected token after replacing value.');
328 329
            }
            break;
330 331
        }
      }
332
      $buffer .= $value;
333
    }
334 335
    foreach ($settings as $name => $setting) {
      $buffer .= _drupal_rewrite_settings_dump($setting, '$' . $name);
336 337
    }

338
    // Write the new settings file.
339
    if (file_put_contents($settings_file, $buffer) === FALSE) {
340
      throw new Exception(t('Failed to modify %settings. Verify the file permissions.', ['%settings' => $settings_file]));
341
    }
342 343 344 345
    else {
      // In case any $settings variables were written, import them into the
      // Settings singleton.
      if (!empty($settings_settings)) {
346
        $old_settings = Settings::getAll();
347 348
        new Settings($settings_settings + $old_settings);
      }
349 350 351 352 353
      // 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);
354
    }
355 356
  }
  else {
357
    throw new Exception(t('Failed to open %settings. Verify the file permissions.', ['%settings' => $settings_file]));
358 359 360
  }
}

361 362 363 364 365 366
/**
 * Helper for drupal_rewrite_settings().
 *
 * Checks whether this token represents a scalar or NULL.
 *
 * @param int $type
367
 *   The token type.
368 369 370 371 372
 * @param string $value
 *   The value of the token.
 *
 * @return bool
 *   TRUE if this token represents a scalar or NULL.
373 374
 *
 * @see token_name()
375 376 377 378 379
 */
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;
380
  $is_boolean_or_null = $type == T_STRING && in_array(strtoupper($value), ['TRUE', 'FALSE', 'NULL']);
381 382 383 384 385 386 387
  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
388
 * string.
389 390
 *
 * @param int $type
391
 *   The token type.
392 393 394
 *
 * @return bool
 *   TRUE if this token represents a number or a string.
395 396
 *
 * @see token_name()
397 398 399 400 401 402 403 404 405 406 407 408 409
 */
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.
 *
410
 * @param array|null $ref
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 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
 *   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.
 *
459
 * @param object $variable
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
 *   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;
}

478
/**
479
 * Verifies that all dependencies are met for a given installation profile.
480
 *
481 482
 * @param $install_state
 *   An array of information about the current installation state.
483
 *
Steven Wittens's avatar
Steven Wittens committed
484 485
 * @return
 *   The list of modules to install.
486
 */
487
function drupal_verify_profile($install_state) {
488
  $profile = $install_state['parameters']['profile'];
489
  $info = $install_state['profile_info'];
490

491
  // Get the list of available modules for the selected installation profile.
492
  $listing = new ExtensionDiscovery(\Drupal::root());
493
  $present_modules = [];
494
  foreach ($listing->scan('module') as $present_module) {
495
    $present_modules[] = $present_module->getName();
496 497
  }

498 499
  // The installation profile is also a module, which needs to be installed
  // after all the other dependencies have been installed.
500
  $present_modules[] = $profile;
501

502
  // Verify that all of the profile's required modules are present.
503
  $missing_modules = array_diff($info['install'], $present_modules);
504

505
  $requirements = [];
506

507 508 509 510 511 512
  if ($missing_modules) {
    $build = [
      '#theme' => 'item_list',
      '#context' => ['list_style' => 'comma-list'],
    ];

513
    foreach ($missing_modules as $module) {
514
      $build['#items'][] = ['#markup' => '<span class="admin-missing">' . Unicode::ucfirst($module) . '</span>'];
Steven Wittens's avatar
Steven Wittens committed
515
    }
516 517

    $modules_list = \Drupal::service('renderer')->renderPlain($build);
518
    $requirements['required_modules'] = [
519 520 521
      'title' => t('Required modules'),
      'value' => t('Required modules not found.'),
      'severity' => REQUIREMENT_ERROR,
522 523
      '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', ['@modules' => $modules_list]),
    ];
Steven Wittens's avatar
Steven Wittens committed
524
  }
525
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
526
}
527

528
/**
529
 * Installs the system module.
530 531 532
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
533 534 535 536
 *
 * @param array $install_state
 *   An array of information about the current installation state. This is used
 *   to set the default language.
537
 */
538
function drupal_install_system($install_state) {
539
  // Remove the service provider of the early installer.
540
  unset($GLOBALS['conf']['container_service_providers']['InstallerServiceProvider']);
541 542
  // Add the normal installer service provider.
  $GLOBALS['conf']['container_service_providers']['InstallerServiceProvider'] = 'Drupal\Core\Installer\NormalInstallerServiceProvider';
543

544
  // Get the existing request.
545 546 547 548 549 550 551
  $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);
552 553 554 555 556 557 558
  // Reboot the kernel with new container.
  $kernel->boot();
  $kernel->preHandle($request);
  // Ensure our request includes the session if appropriate.
  if (PHP_SAPI !== 'cli') {
    $request->setSession($kernel->getContainer()->get('session'));
  }
559

560 561 562 563 564 565 566
  // Before having installed the system module and being able to do a module
  // rebuild, prime the \Drupal\Core\Extension\ModuleExtensionList static cache
  // with the module's location.
  // @todo Try to install system as any other module, see
  //   https://www.drupal.org/node/2719315.
  \Drupal::service('extension.list.module')->setPathname('system', 'core/modules/system/system.info.yml');

567 568
  // Install base system configuration.
  \Drupal::service('config.installer')->installDefaultConfig('core', 'core');
569

570 571 572 573 574 575
  // Store the installation profile in configuration to populate the
  // 'install_profile' container parameter.
  \Drupal::configFactory()->getEditable('core.extension')
    ->set('profile', $install_state['parameters']['profile'])
    ->save();

576
  // Install System module and rebuild the newly available routes.
577
  $kernel->getContainer()->get('module_installer')->install(['system'], FALSE);
578
  \Drupal::service('router.builder')->rebuild();
579

580 581
  // Ensure default language is saved.
  if (isset($install_state['parameters']['langcode'])) {
582
    \Drupal::configFactory()->getEditable('system.site')
583 584 585
      ->set('langcode', (string) $install_state['parameters']['langcode'])
      ->set('default_langcode', (string) $install_state['parameters']['langcode'])
      ->save(TRUE);
586
  }
587 588
}

589
/**
590
 * Verifies the state of the specified file.
591 592 593 594 595 596 597
 *
 * @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.
598 599 600
 * @param bool $autofix
 *   (optional) Determines whether to attempt fixing the permissions according
 *   to the provided $mask. Defaults to TRUE.
601
 *
602
 * @return
603
 *   TRUE on success or FALSE on failure. A message is set for the latter.
604
 */
605
function drupal_verify_install_file($file, $mask = NULL, $type = 'file', $autofix = TRUE) {
606 607 608 609 610 611 612
  $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)) {
613
    $check = 'is_' . $type;
614 615 616 617 618 619 620
    if (!function_exists($check) || !$check($file)) {
      $return = FALSE;
    }
  }

  // Verify file permissions.
  if (isset($mask)) {
621
    $masks = [FILE_EXIST, FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
622 623 624 625 626
    foreach ($masks as $current_mask) {
      if ($mask & $current_mask) {
        switch ($current_mask) {
          case FILE_EXIST:
            if (!file_exists($file)) {
627
              if ($type == 'dir' && $autofix) {
628 629 630 631 632 633 634 635
                drupal_install_mkdir($file, $mask);
              }
              if (!file_exists($file)) {
                $return = FALSE;
              }
            }
            break;
          case FILE_READABLE:
636
            if (!is_readable($file)) {
637 638 639 640
              $return = FALSE;
            }
            break;
          case FILE_WRITABLE:
641
            if (!is_writable($file)) {
642 643 644 645
              $return = FALSE;
            }
            break;
          case FILE_EXECUTABLE:
646
            if (!is_executable($file)) {
647 648 649 650
              $return = FALSE;
            }
            break;
          case FILE_NOT_READABLE:
651
            if (is_readable($file)) {
652 653 654 655
              $return = FALSE;
            }
            break;
          case FILE_NOT_WRITABLE:
656
            if (is_writable($file)) {
657 658 659 660
              $return = FALSE;
            }
            break;
          case FILE_NOT_EXECUTABLE:
661
            if (is_executable($file)) {
662 663 664 665 666 667 668
              $return = FALSE;
            }
            break;
        }
      }
    }
  }
669 670 671
  if (!$return && $autofix) {
    return drupal_install_fix_file($file, $mask);
  }
672 673 674 675
  return $return;
}

/**
676
 * Creates a directory with the specified permissions.
677
 *
678
 * @param $file
679
 *   The name of the directory to create;
680
 * @param $mask
681
 *   The permissions of the directory to create.
682
 * @param $message
683
 *   (optional) Whether to output messages. Defaults to TRUE.
684
 *
685
 * @return
686
 *   TRUE/FALSE whether or not the directory was successfully created.
687 688 689
 */
function drupal_install_mkdir($file, $mask, $message = TRUE) {
  $mod = 0;
690
  $masks = [FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
691 692 693 694
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
695
          $mod |= 0444;
696 697
          break;
        case FILE_WRITABLE:
698
          $mod |= 0222;
699 700
          break;
        case FILE_EXECUTABLE:
701
          $mod |= 0111;
702 703 704 705 706
          break;
      }
    }
  }

707
  if (@\Drupal::service('file_system')->mkdir($file, $mod)) {
708 709 710 711 712 713 714 715
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
716
 * Attempts to fix file permissions.
717
 *
718 719 720 721 722 723 724 725 726
 * 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.
 *
727
 * @param $file
728
 *   The name of the file with permissions to fix.
729
 * @param $mask
730
 *   The desired permissions for the file.
731
 * @param $message
732
 *   (optional) Whether to output messages. Defaults to TRUE.
733
 *
734
 * @return
735
 *   TRUE/FALSE whether or not we were able to fix the file's permissions.
736 737
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
738 739 740 741 742
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

743
  $mod = fileperms($file) & 0777;
744
  $masks = [FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
745 746 747 748 749

  // 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.
750 751 752 753 754
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
755
            $mod |= 0444;
756 757 758 759
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
760
            $mod |= 0222;
761 762 763 764
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
765
            $mod |= 0111;
766 767 768 769
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
770
            $mod &= ~0444;
771 772 773 774
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
775
            $mod &= ~0222;
776 777 778 779
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
780
            $mod &= ~0111;
781 782 783 784 785 786
          }
          break;
      }
    }
  }

787 788
  // chmod() will work if the web server is running as owner of the file.
  if (@chmod($file, $mod)) {
789 790 791 792 793 794 795
    return TRUE;
  }
  else {
    return FALSE;
  }
}

796
/**
797
 * Sends the user to a different installer page.
798 799
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
800 801 802 803 804
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
805
  global $base_url;
806
  $headers = [
807 808
    // Not a permanent redirect.
    'Cache-Control' => 'no-cache',
809
  ];
810 811
  $response = new RedirectResponse($base_url . '/' . $path, 302, $headers);
  $response->send();
812 813
}

814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
/**
 * 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
835 836
 *   through \Drupal\Component\Utility\UrlHelper::filterBadProtocol() if it will be
 *   used as an HTML attribute value.
837 838
 *
 * @see drupal_requirements_url()
839
 * @see Drupal\Component\Utility\UrlHelper::filterBadProtocol()
840
 */
841
function drupal_current_script_url($query = []) {
842
  $uri = $_SERVER['SCRIPT_NAME'];
843
  $query = array_merge(UrlHelper::filterQueryParameters(\Drupal::request()->query->all()), $query);
844
  if (!empty($query)) {
845
    $uri .= '?' . UrlHelper::buildQuery($query);
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
  }
  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
863 864 865
 *   not sanitized, so it still needs to be run through
 *   \Drupal\Component\Utility\UrlHelper::filterBadProtocol() if it will be used
 *   as an HTML attribute value.
866 867
 *
 * @see drupal_current_script_url()
868
 * @see \Drupal\Component\Utility\UrlHelper::filterBadProtocol()
869 870
 */
function drupal_requirements_url($severity) {
871
  $query = [];
872 873 874 875 876 877 878 879
  // 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);
}

880
/**
881
 * Checks an installation profile's requirements.
882
 *
883
 * @param string $profile
884
 *   Name of installation profile to check.
885 886
 *
 * @return array
887
 *   Array of the installation profile's requirements.
888
 */
889
function drupal_check_profile($profile) {
890
  $info = install_profile_info($profile);
891
  // Collect requirement testing results.
892
  $requirements = [];
893 894 895
  // Performs an ExtensionDiscovery scan as the system module is unavailable and
  // we don't yet know where all the modules are located.
  // @todo Remove as part of https://www.drupal.org/node/2186491
896 897 898
  $drupal_root = \Drupal::root();
  $module_list = (new ExtensionDiscovery($drupal_root))->scan('module');

899
  foreach ($info['install'] as $module) {
900 901 902 903 904 905 906 907 908 909 910 911
    // If the module is in the module list we know it exists and we can continue
    // including and registering it.
    // @see \Drupal\Core\Extension\ExtensionDiscovery::scanDirectory()
    if (isset($module_list[$module])) {
      $function = $module . '_requirements';
      $module_path = $module_list[$module]->getPath();
      $install_file = "$drupal_root/$module_path/$module.install";

      if (is_file($install_file)) {
        require_once $install_file;
      }

912
      \Drupal::service('class_loader')->addPsr4('Drupal\\' . $module . '\\', \Drupal::root() . "/$module_path/src");
913

914 915 916
      if (function_exists($function)) {
        $requirements = array_merge($requirements, $function('install'));
      }
917
    }
918
  }
919

920 921 922 923 924 925
  // Add the profile requirements.
  $function = $profile . '_requirements';
  if (function_exists($function)) {
    $requirements = array_merge($requirements, $function('install'));
  }

926 927 928 929
  return $requirements;
}

/**
930
 * Extracts the highest severity from the requirements array.
931 932
 *
 * @param $requirements
933
 *   An array of requirements, in the same format as is returned by
934
 *   hook_requirements().
935
 *
936