install.inc 37.5 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
  /** @var \Drupal\Core\Extension\ModuleExtensionList $extension_list_module */
  $extension_list_module = \Drupal::service('extension.list.module');
83
  foreach (drupal_get_installed_schema_version(NULL, FALSE, TRUE) as $module => $schema_version) {
84 85 86 87
    if ($extension_list_module->exists($module) && !$extension_list_module->checkIncompatibility($module)) {
      if ($schema_version > -1) {
        module_load_install($module);
      }
88
    }
89 90 91
  }
}

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

119 120 121
/**
 * Loads the installation profile, extracting its defined version.
 *
122 123 124 125
 * @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.
126 127 128 129 130 131
 *
 * @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).
132
  if (InstallerKernel::installationAttempted()) {
133 134 135 136 137
    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 {
138
    $profile = \Drupal::installProfile();
139
    $info = \Drupal::service('extension.list.profile')->getExtensionInfo($profile);
140 141 142 143
    return $info['version'];
  }
}

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

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

  return $databases;
}

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

170
  // The internal database driver name is any valid PHP identifier.
171
  $mask = ExtensionDiscovery::PHP_FUNCTION_PATTERN;
172 173

  // Find drivers in the Drupal\Core and Drupal\Driver namespaces.
174 175 176
  /** @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]);
177
  if (is_dir(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database')) {
178
    $files += $file_system->scanDirectory(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database/', $mask, ['recurse' => FALSE]);
179 180
  }
  foreach ($files as $file) {
181
    if (file_exists($file->uri . '/Install/Tasks.php')) {
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
      // The namespace doesn't need to be added here, because
      // db_installer_object() will find it.
      $drivers[$file->filename] = NULL;
    }
  }

  // Find drivers in Drupal module namespaces.
  /** @var \Composer\Autoload\ClassLoader $class_loader */
  $class_loader = \Drupal::service('class_loader');
  // We cannot use the file cache because it does not always exist.
  $extension_discovery = new ExtensionDiscovery(DRUPAL_ROOT, FALSE, []);
  $modules = $extension_discovery->scan('module');
  foreach ($modules as $module) {
    $module_driver_path = DRUPAL_ROOT . '/' . $module->getPath() . '/src/Driver/Database';
    if (is_dir($module_driver_path)) {
      $driver_files = $file_system->scanDirectory($module_driver_path, $mask, ['recurse' => FALSE]);
      foreach ($driver_files as $driver_file) {
        $tasks_file = $module_driver_path . '/' . $driver_file->filename . '/Install/Tasks.php';
        if (file_exists($tasks_file)) {
          $namespace = 'Drupal\\' . $module->getName() . '\\Driver\\Database\\' . $driver_file->filename;

          // The namespace needs to be added for db_installer_object() to find
          // it.
          $drivers[$driver_file->filename] = $namespace;

          // The directory needs to be added to the autoloader, because this is
          // early in the installation process: the module hasn't been enabled
          // yet and the database connection info array (including its 'autoload'
          // key) hasn't been created yet.
          $class_loader->addPsr4($namespace . '\\', $module->getPath() . '/src/Driver/Database/' . $driver_file->filename);
        }
      }
214
    }
215
  }
216 217 218

  foreach ($drivers as $driver => $namespace) {
    $installer = db_installer_object($driver, $namespace);
219
    if ($installer->installable()) {
220
      $databases[$driver] = $installer;
221 222
    }
  }
223

224
  // Usability: unconditionally put the MySQL driver on top.
225 226 227
  if (isset($databases['mysql'])) {
    $mysql_database = $databases['mysql'];
    unset($databases['mysql']);
228
    $databases = ['mysql' => $mysql_database] + $databases;
229
  }
230

231 232 233
  return $databases;
}

234
/**
235
 * Replaces values in settings.php with values in the submitted array.
236
 *
237 238 239 240
 * 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.
 *
241
 * @param $settings
242 243 244 245
 *   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
246 247 248
 *   $settings['settings']['config_sync_directory'] = (object) array(
 *     'value' => 'config_hash/sync',
 *     'required' => TRUE,
249 250 251 252
 *   );
 *   @endcode
 *   gets dumped as:
 *   @code
253
 *   $settings['config_sync_directory'] = 'config_hash/sync'
254
 *   @endcode
255
 */
256
function drupal_rewrite_settings($settings = [], $settings_file = NULL) {
257
  if (!isset($settings_file)) {
258
    $settings_file = \Drupal::getContainer()->getParameter('site.path') . '/settings.php';
259
  }
260
  // Build list of setting names and insert the values into the global namespace.
261 262
  $variable_names = [];
  $settings_settings = [];
263
  foreach ($settings as $setting => $data) {
264 265 266 267 268 269
    if ($setting != 'settings') {
      _drupal_rewrite_settings_global($GLOBALS[$setting], $data);
    }
    else {
      _drupal_rewrite_settings_global($settings_settings, $data);
    }
270
    $variable_names['$' . $setting] = $setting;
271
  }
272
  $contents = file_get_contents($settings_file);
273
  if ($contents !== FALSE) {
274 275 276 277
    // Initialize the contents for the settings.php file if it is empty.
    if (trim($contents) === '') {
      $contents = "<?php\n";
    }
278 279
    // Step through each token in settings.php and replace any variables that
    // are in the passed-in array.
280 281
    $buffer = '';
    $state = 'default';
282
    foreach (token_get_all($contents) as $token) {
283 284
      if (is_array($token)) {
        list($type, $value) = $token;
285
      }
286
      else {
287 288 289 290
        $type = -1;
        $value = $token;
      }
      // Do not operate on whitespace.
291
      if (!in_array($type, [T_WHITESPACE, T_COMMENT, T_DOC_COMMENT])) {
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 327 328 329 330 331 332 333 334 335 336 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
        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.
365
              throw new Exception('Unexpected token after replacing value.');
366 367
            }
            break;
368 369
        }
      }
370
      $buffer .= $value;
371
    }
372 373
    foreach ($settings as $name => $setting) {
      $buffer .= _drupal_rewrite_settings_dump($setting, '$' . $name);
374 375
    }

376
    // Write the new settings file.
377
    if (file_put_contents($settings_file, $buffer) === FALSE) {
378
      throw new Exception("Failed to modify '$settings_file'. Verify the file permissions.");
379
    }
380 381 382 383
    else {
      // In case any $settings variables were written, import them into the
      // Settings singleton.
      if (!empty($settings_settings)) {
384
        $old_settings = Settings::getAll();
385 386
        new Settings($settings_settings + $old_settings);
      }
387 388 389 390 391
      // 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);
392
    }
393 394
  }
  else {
395
    throw new Exception("Failed to open '$settings_file'. Verify the file permissions.");
396 397 398
  }
}

399 400 401 402 403 404
/**
 * Helper for drupal_rewrite_settings().
 *
 * Checks whether this token represents a scalar or NULL.
 *
 * @param int $type
405
 *   The token type.
406 407 408 409 410
 * @param string $value
 *   The value of the token.
 *
 * @return bool
 *   TRUE if this token represents a scalar or NULL.
411 412
 *
 * @see token_name()
413 414 415 416 417
 */
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;
418
  $is_boolean_or_null = $type == T_STRING && in_array(strtoupper($value), ['TRUE', 'FALSE', 'NULL']);
419 420 421 422 423 424 425
  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
426
 * string.
427 428
 *
 * @param int $type
429
 *   The token type.
430 431 432
 *
 * @return bool
 *   TRUE if this token represents a number or a string.
433 434
 *
 * @see token_name()
435 436 437 438 439 440 441 442 443 444 445 446 447
 */
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.
 *
448
 * @param array|null $ref
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
 *   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.
 *
497
 * @param object $variable
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
 *   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;
}

516
/**
517
 * Verifies that all dependencies are met for a given installation profile.
518
 *
519 520
 * @param $install_state
 *   An array of information about the current installation state.
521
 *
Steven Wittens's avatar
Steven Wittens committed
522 523
 * @return
 *   The list of modules to install.
524
 */
525
function drupal_verify_profile($install_state) {
526
  $profile = $install_state['parameters']['profile'];
527
  $info = $install_state['profile_info'];
528

529
  // Get the list of available modules for the selected installation profile.
530
  $listing = new ExtensionDiscovery(\Drupal::root());
531
  $present_modules = [];
532
  foreach ($listing->scan('module') as $present_module) {
533
    $present_modules[] = $present_module->getName();
534 535
  }

536 537
  // The installation profile is also a module, which needs to be installed
  // after all the other dependencies have been installed.
538
  $present_modules[] = $profile;
539

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

543
  $requirements = [];
544

545 546 547 548 549 550
  if ($missing_modules) {
    $build = [
      '#theme' => 'item_list',
      '#context' => ['list_style' => 'comma-list'],
    ];

551
    foreach ($missing_modules as $module) {
552
      $build['#items'][] = ['#markup' => '<span class="admin-missing">' . Unicode::ucfirst($module) . '</span>'];
Steven Wittens's avatar
Steven Wittens committed
553
    }
554 555

    $modules_list = \Drupal::service('renderer')->renderPlain($build);
556
    $requirements['required_modules'] = [
557 558 559
      'title' => t('Required modules'),
      'value' => t('Required modules not found.'),
      'severity' => REQUIREMENT_ERROR,
560 561
      '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
562
  }
563
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
564
}
565

566
/**
567
 * Installs the system module.
568 569 570
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
571 572 573 574
 *
 * @param array $install_state
 *   An array of information about the current installation state. This is used
 *   to set the default language.
575
 */
576
function drupal_install_system($install_state) {
577
  // Remove the service provider of the early installer.
578
  unset($GLOBALS['conf']['container_service_providers']['InstallerServiceProvider']);
579 580
  // Add the normal installer service provider.
  $GLOBALS['conf']['container_service_providers']['InstallerServiceProvider'] = 'Drupal\Core\Installer\NormalInstallerServiceProvider';
581

582
  // Get the existing request.
583 584 585 586 587 588 589
  $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);
590 591 592 593 594 595 596
  // 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'));
  }
597

598 599 600 601 602 603 604
  // 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');

605 606
  // Install base system configuration.
  \Drupal::service('config.installer')->installDefaultConfig('core', 'core');
607

608 609 610 611 612 613
  // 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();

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

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

627
/**
628
 * Verifies the state of the specified file.
629 630 631 632 633 634 635
 *
 * @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.
636 637 638
 * @param bool $autofix
 *   (optional) Determines whether to attempt fixing the permissions according
 *   to the provided $mask. Defaults to TRUE.
639
 *
640
 * @return
641
 *   TRUE on success or FALSE on failure. A message is set for the latter.
642
 */
643
function drupal_verify_install_file($file, $mask = NULL, $type = 'file', $autofix = TRUE) {
644 645 646 647 648 649 650
  $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)) {
651
    $check = 'is_' . $type;
652 653 654 655 656 657 658
    if (!function_exists($check) || !$check($file)) {
      $return = FALSE;
    }
  }

  // Verify file permissions.
  if (isset($mask)) {
659
    $masks = [FILE_EXIST, FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
660 661 662 663 664
    foreach ($masks as $current_mask) {
      if ($mask & $current_mask) {
        switch ($current_mask) {
          case FILE_EXIST:
            if (!file_exists($file)) {
665
              if ($type == 'dir' && $autofix) {
666 667 668 669 670 671 672 673
                drupal_install_mkdir($file, $mask);
              }
              if (!file_exists($file)) {
                $return = FALSE;
              }
            }
            break;
          case FILE_READABLE:
674
            if (!is_readable($file)) {
675 676 677 678
              $return = FALSE;
            }
            break;
          case FILE_WRITABLE:
679
            if (!is_writable($file)) {
680 681 682 683
              $return = FALSE;
            }
            break;
          case FILE_EXECUTABLE:
684
            if (!is_executable($file)) {
685 686 687 688
              $return = FALSE;
            }
            break;
          case FILE_NOT_READABLE:
689
            if (is_readable($file)) {
690 691 692 693
              $return = FALSE;
            }
            break;
          case FILE_NOT_WRITABLE:
694
            if (is_writable($file)) {
695 696 697 698
              $return = FALSE;
            }
            break;
          case FILE_NOT_EXECUTABLE:
699
            if (is_executable($file)) {
700 701 702 703 704 705 706
              $return = FALSE;
            }
            break;
        }
      }
    }
  }
707 708 709
  if (!$return && $autofix) {
    return drupal_install_fix_file($file, $mask);
  }
710 711 712 713
  return $return;
}

/**
714
 * Creates a directory with the specified permissions.
715
 *
716
 * @param $file
717
 *   The name of the directory to create;
718
 * @param $mask
719
 *   The permissions of the directory to create.
720
 * @param $message
721
 *   (optional) Whether to output messages. Defaults to TRUE.
722
 *
723
 * @return
724
 *   TRUE/FALSE whether or not the directory was successfully created.
725 726 727
 */
function drupal_install_mkdir($file, $mask, $message = TRUE) {
  $mod = 0;
728
  $masks = [FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
729 730 731 732
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
733
          $mod |= 0444;
734 735
          break;
        case FILE_WRITABLE:
736
          $mod |= 0222;
737 738
          break;
        case FILE_EXECUTABLE:
739
          $mod |= 0111;
740 741 742 743 744
          break;
      }
    }
  }

745
  if (@\Drupal::service('file_system')->mkdir($file, $mod)) {
746 747 748 749 750 751 752 753
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
754
 * Attempts to fix file permissions.
755
 *
756 757 758 759 760 761 762 763 764
 * 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.
 *
765
 * @param $file
766
 *   The name of the file with permissions to fix.
767
 * @param $mask
768
 *   The desired permissions for the file.
769
 * @param $message
770
 *   (optional) Whether to output messages. Defaults to TRUE.
771
 *
772
 * @return
773
 *   TRUE/FALSE whether or not we were able to fix the file's permissions.
774 775
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
776 777 778 779 780
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

781
  $mod = fileperms($file) & 0777;
782
  $masks = [FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
783 784 785 786 787

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

825 826
  // chmod() will work if the web server is running as owner of the file.
  if (@chmod($file, $mod)) {
827 828 829 830 831 832 833
    return TRUE;
  }
  else {
    return FALSE;
  }
}

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

852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
/**
 * 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
873 874
 *   through \Drupal\Component\Utility\UrlHelper::filterBadProtocol() if it will be
 *   used as an HTML attribute value.
875 876
 *
 * @see drupal_requirements_url()
877
 * @see Drupal\Component\Utility\UrlHelper::filterBadProtocol()
878
 */
879
function drupal_current_script_url($query = []) {
880
  $uri = $_SERVER['SCRIPT_NAME'];
881
  $query = array_merge(UrlHelper::filterQueryParameters(\Drupal::request()->query->all()), $query);
882
  if (!empty($query)) {
883
    $uri .= '?' . UrlHelper::buildQuery($query);
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
  }
  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
901 902 903
 *   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.
904 905
 *
 * @see drupal_current_script_url()
906
 * @see \Drupal\Component\Utility\UrlHelper::filterBadProtocol()
907 908
 */
function drupal_requirements_url($severity) {
909
  $query = [];
910 911 912 913 914 915 916 917
  // 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);
}

918
/**
919
 * Checks an installation profile's requirements.
920
 *
921
 * @param string $profile
922
 *   Name of installation profile to check.
923 924
 *
 * @return array
925
 *   Array of the installation profile's requirements.
926
 */
927
function drupal_check_profile($profile) {
928
  $info = install_profile_info($profile);
929
  // Collect requirement testing results.
930
  $requirements = [];
931 932 933
  // 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
934 935 936
  $drupal_root = \Drupal::root();
  $module_list = (new ExtensionDiscovery($drupal_root))->scan('module');

937
  foreach ($info['install'] as $module) {
938 939 940 941 942 943 944 945 946 947 948 949
    // 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;
      }

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

952 953 954
      if (function_exists($function)) {
        $requirements = array_merge($requirements, $function('install'));
      }
955
    }
956
  }
957

958 959 960 961 962 963
  // Add the profile requirements.
  $function = $profile . '_requirements';
  if (function_exists($function)) {
    $requirements = array_merge($requirements, $function('install'));
  }

964 965 966 967
  return $requirements;
}

/**
968
 * Extracts the highest severity from the requirements array.
969 970
 *
 * @param $requirements
971
 *   An array of requirements, in the same format as is returned by
972
 *   hook_requirements().
973
 *
974 975
 * @return
 *   The highest severity in the array.
976 977 978 979 980 981 982 983 984 985 986 987
 */
function drupal_requirements_severity(&$requirements) {
  $severity = REQUIREMENT_OK;
  foreach ($requirements as $requirement) {
    if (isset($requirement['severity'])) {
      $severity = max($severity, $requirement['severity']);
    }
  }
  return $severity;
}

/**
988
 * Checks a module's requirements.
989 990 991
 *
 * @param $module
 *   Machine name of module to check.