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

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

8
use 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\UrlHelper;
13
use Drupal\Core\Extension\ExtensionDiscovery;
14
use Drupal\Core\Site\Settings;
15

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

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

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

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

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

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

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

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

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

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

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

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

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

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

114 115 116
/**
 * Loads the installation profile, extracting its defined version.
 *
117 118 119 120
 * @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.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
 *
 * @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).
  if (drupal_installation_attempted()) {
    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 {
    $profile = drupal_get_profile();
    $info = system_get_info('module', $profile);
    return $info['version'];
  }
}

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

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

  return $databases;
}

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

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

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

190 191 192
  return $databases;
}

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

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

360 361 362 363 364 365
/**
 * Helper for drupal_rewrite_settings().
 *
 * Checks whether this token represents a scalar or NULL.
 *
 * @param int $type
366
 *   The token type.
367 368 369 370 371
 * @param string $value
 *   The value of the token.
 *
 * @return bool
 *   TRUE if this token represents a scalar or NULL.
372 373
 *
 * @see token_name()
374 375 376 377 378
 */
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;
379
  $is_boolean_or_null = $type == T_STRING && in_array(strtoupper($value), ['TRUE', 'FALSE', 'NULL']);
380 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 459
 *   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.
 *
460
 * @param object $variable
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
 *   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;
}

479 480 481 482 483 484
/**
 * Creates the config directory and ensures it is operational.
 *
 * @see install_settings_form_submit()
 * @see update_prepare_d8_bootstrap()
 */
485
function drupal_install_config_directories() {
486
  global $config_directories;
487 488 489

  // Add a randomized config directory name to settings.php, unless it was
  // manually defined in the existing already.
490
  if (empty($config_directories[CONFIG_SYNC_DIRECTORY])) {
491
    $config_directories[CONFIG_SYNC_DIRECTORY] = \Drupal::service('site.path') . '/files/config_' . Crypt::randomBytesBase64(55) . '/sync';
492
    $settings['config_directories'][CONFIG_SYNC_DIRECTORY] = (object) [
493
      'value' => $config_directories[CONFIG_SYNC_DIRECTORY],
494 495
      'required' => TRUE,
    ];
496 497 498 499
    // Rewrite settings.php, which also sets the value as global variable.
    drupal_rewrite_settings($settings);
  }

500 501 502 503 504 505
  // 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().
506 507
  if (!file_prepare_directory($config_directories[CONFIG_SYNC_DIRECTORY], FILE_CREATE_DIRECTORY)
    && !file_exists($config_directories[CONFIG_SYNC_DIRECTORY])) {
508
    throw new Exception(t('The directory %directory could not be created. To proceed with the installation, either create the directory or ensure that the installer has the permissions to create it automatically. For more information, see the <a href=":handbook_url">online handbook</a>.', [
509
      '%directory' => config_get_config_directory(CONFIG_SYNC_DIRECTORY),
510
      ':handbook_url' => 'https://www.drupal.org/server-permissions',
511
    ]));
512
  }
513 514 515 516 517 518 519 520
  elseif (is_writable($config_directories[CONFIG_SYNC_DIRECTORY])) {
    // Put a README.txt into the sync config directory. This is required so that
    // they can later be added to git. Since this directory is auto-created, we
    // have to write out the README rather than just adding it to the drupal core
    // repo.
    $text = 'This directory contains configuration to be imported into your Drupal site. To make this configuration active, visit admin/config/development/configuration/sync.' . ' For information about deploying configuration between servers, see https://www.drupal.org/documentation/administer/config';
    file_put_contents(config_get_config_directory(CONFIG_SYNC_DIRECTORY) . '/README.txt', $text);
  }
521 522 523 524
}

/**
 * Ensures that the config directory exists and is writable, or can be made so.
525 526
 *
 * @param string $type
527
 *   Type of config directory to return. Drupal core provides 'sync'.
528 529 530
 *
 * @return bool
 *   TRUE if the config directory exists and is writable.
531 532 533
 *
 * @deprecated in Drupal 8.1.x, will be removed before Drupal 9.0.x. Use
 *   config_get_config_directory() and file_prepare_directory() instead.
534 535
 *
 * @see https://www.drupal.org/node/2501187
536
 */
537
function install_ensure_config_directory($type) {
538
  @trigger_error('install_ensure_config_directory() is deprecated in Drupal 8.1.0 and will be removed before Drupal 9.0.0. Use config_get_config_directory() and file_prepare_directory() instead. See https://www.drupal.org/node/2501187.', E_USER_DEPRECATED);
539
  // The config directory must be defined in settings.php.
540 541
  global $config_directories;
  if (!isset($config_directories[$type])) {
542 543 544 545 546
    return FALSE;
  }
  // The logic here is similar to that used by system_requirements() for other
  // directories that the installer creates.
  else {
547
    $config_directory = config_get_config_directory($type);
548
    return file_prepare_directory($config_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
549 550 551
  }
}

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

565
  // Get the list of available modules for the selected installation profile.
566
  $listing = new ExtensionDiscovery(\Drupal::root());
567
  $present_modules = [];
568
  foreach ($listing->scan('module') as $present_module) {
569
    $present_modules[] = $present_module->getName();
570 571
  }

572 573
  // The installation profile is also a module, which needs to be installed
  // after all the other dependencies have been installed.
574
  $present_modules[] = $profile;
575

576
  // Verify that all of the profile's required modules are present.
577
  $missing_modules = array_diff($info['dependencies'], $present_modules);
578

579
  $requirements = [];
580

581 582 583 584 585 586
  if ($missing_modules) {
    $build = [
      '#theme' => 'item_list',
      '#context' => ['list_style' => 'comma-list'],
    ];

587
    foreach ($missing_modules as $module) {
588
      $build['#items'][] = ['#markup' => '<span class="admin-missing">' . Unicode::ucfirst($module) . '</span>'];
Steven Wittens's avatar
Steven Wittens committed
589
    }
590 591

    $modules_list = \Drupal::service('renderer')->renderPlain($build);
592
    $requirements['required_modules'] = [
593 594 595
      'title' => t('Required modules'),
      'value' => t('Required modules not found.'),
      'severity' => REQUIREMENT_ERROR,
596 597
      '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
598
  }
599
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
600
}
601

602
/**
603
 * Installs the system module.
604 605 606
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
607 608 609 610
 *
 * @param array $install_state
 *   An array of information about the current installation state. This is used
 *   to set the default language.
611
 */
612
function drupal_install_system($install_state) {
613
  // Remove the service provider of the early installer.
614
  unset($GLOBALS['conf']['container_service_providers']['InstallerServiceProvider']);
615

616 617 618 619 620 621 622 623
  $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);
624

625 626
  // Install base system configuration.
  \Drupal::service('config.installer')->installDefaultConfig('core', 'core');
627

628 629 630 631 632 633
  // 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();

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

638 639
  // Ensure default language is saved.
  if (isset($install_state['parameters']['langcode'])) {
640
    \Drupal::configFactory()->getEditable('system.site')
641 642 643
      ->set('langcode', (string) $install_state['parameters']['langcode'])
      ->set('default_langcode', (string) $install_state['parameters']['langcode'])
      ->save(TRUE);
644
  }
645 646
}

647
/**
648
 * Verifies the state of the specified file.
649 650 651 652 653 654 655
 *
 * @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.
656
 *
657
 * @return
658
 *   TRUE on success or FALSE on failure. A message is set for the latter.
659 660 661 662 663 664 665 666 667
 */
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)) {
668
    $check = 'is_' . $type;
669 670 671 672 673 674 675
    if (!function_exists($check) || !$check($file)) {
      $return = FALSE;
    }
  }

  // Verify file permissions.
  if (isset($mask)) {
676
    $masks = [FILE_EXIST, FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
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 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
    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;
}

/**
728
 * Creates a directory with the specified permissions.
729
 *
730
 * @param $file
731
 *   The name of the directory to create;
732
 * @param $mask
733
 *   The permissions of the directory to create.
734
 * @param $message
735
 *   (optional) Whether to output messages. Defaults to TRUE.
736
 *
737
 * @return
738
 *   TRUE/FALSE whether or not the directory was successfully created.
739 740 741
 */
function drupal_install_mkdir($file, $mask, $message = TRUE) {
  $mod = 0;
742
  $masks = [FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
743 744 745 746
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
747
          $mod |= 0444;
748 749
          break;
        case FILE_WRITABLE:
750
          $mod |= 0222;
751 752
          break;
        case FILE_EXECUTABLE:
753
          $mod |= 0111;
754 755 756 757 758
          break;
      }
    }
  }

759
  if (@drupal_mkdir($file, $mod)) {
760 761 762 763 764 765 766 767
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
768
 * Attempts to fix file permissions.
769
 *
770 771 772 773 774 775 776 777 778
 * 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.
 *
779
 * @param $file
780
 *   The name of the file with permissions to fix.
781
 * @param $mask
782
 *   The desired permissions for the file.
783
 * @param $message
784
 *   (optional) Whether to output messages. Defaults to TRUE.
785
 *
786
 * @return
787
 *   TRUE/FALSE whether or not we were able to fix the file's permissions.
788 789
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
790 791 792 793 794
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

795
  $mod = fileperms($file) & 0777;
796
  $masks = [FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
797 798 799 800 801

  // 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.
802 803 804 805 806
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
807
            $mod |= 0444;
808 809 810 811
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
812
            $mod |= 0222;
813 814 815 816
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
817
            $mod |= 0111;
818 819 820 821
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
822
            $mod &= ~0444;
823 824 825 826
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
827
            $mod &= ~0222;
828 829 830 831
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
832
            $mod &= ~0111;
833 834 835 836 837 838
          }
          break;
      }
    }
  }

839 840
  // chmod() will work if the web server is running as owner of the file.
  if (@chmod($file, $mod)) {
841 842 843 844 845 846 847
    return TRUE;
  }
  else {
    return FALSE;
  }
}

848
/**
849
 * Sends the user to a different installer page.
850 851
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
852 853 854 855 856
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
857
  global $base_url;
858
  $headers = [
859 860
    // Not a permanent redirect.
    'Cache-Control' => 'no-cache',
861
  ];
862 863
  $response = new RedirectResponse($base_url . '/' . $path, 302, $headers);
  $response->send();
864 865
}

866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
/**
 * 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
887 888
 *   through \Drupal\Component\Utility\UrlHelper::filterBadProtocol() if it will be
 *   used as an HTML attribute value.
889 890
 *
 * @see drupal_requirements_url()
891
 * @see Drupal\Component\Utility\UrlHelper::filterBadProtocol()
892
 */
893
function drupal_current_script_url($query = []) {
894
  $uri = $_SERVER['SCRIPT_NAME'];
895
  $query = array_merge(UrlHelper::filterQueryParameters(\Drupal::request()->query->all()), $query);
896
  if (!empty($query)) {
897
    $uri .= '?' . UrlHelper::buildQuery($query);
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
  }
  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
915 916 917
 *   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.
918 919
 *
 * @see drupal_current_script_url()
920
 * @see \Drupal\Component\Utility\UrlHelper::filterBadProtocol()
921 922
 */
function drupal_requirements_url($severity) {
923
  $query = [];
924 925 926 927 928 929 930 931
  // 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);
}

932
/**
933
 * Checks an installation profile's requirements.
934
 *
935
 * @param string $profile
936
 *   Name of installation profile to check.
937 938
 *
 * @return array
939
 *   Array of the installation profile's requirements.
940
 */
941
function drupal_check_profile($profile) {
942
  $info = install_profile_info($profile);
943
  // Collect requirement testing results.
944
  $requirements = [];
945 946 947
  // 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
948 949 950
  $drupal_root = \Drupal::root();
  $module_list = (new ExtensionDiscovery($drupal_root))->scan('module');

951
  foreach ($info['dependencies'] as $module) {
952 953 954 955 956 957 958 959 960 961 962 963 964
    // 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;
      }

      drupal_classloader_register($module, $module_path);
965

966 967