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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

116 117 118
/**
 * Loads the installation profile, extracting its defined version.
 *
119 120 121 122
 * @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.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
 *
 * @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'];
  }
}

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

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

  return $databases;
}

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

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

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

192 193 194
  return $databases;
}

195
/**
196
 * Replaces values in settings.php with values in the submitted array.
197
 *
198 199 200 201
 * 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.
 *
202
 * @param $settings
203 204 205 206
 *   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
207 208 209
 *   $settings['settings']['config_sync_directory'] = (object) array(
 *     'value' => 'config_hash/sync',
 *     'required' => TRUE,
210 211 212 213
 *   );
 *   @endcode
 *   gets dumped as:
 *   @code
214
 *   $settings['config_sync_directory'] = '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
  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
387
 * string.
388 389
 *
 * @param int $type
390
 *   The token type.
391 392 393
 *
 * @return bool
 *   TRUE if this token represents a number or a string.
394 395
 *
 * @see token_name()
396 397 398 399 400 401 402 403 404 405 406 407 408
 */
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.
 *
409
 * @param array|null $ref
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
 *   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.
 *
458
 * @param object $variable
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
 *   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;
}

477 478 479
/**
 * Creates the config directory and ensures it is operational.
 *
480 481 482 483
 * @deprecated in drupal:8.8.0 and is removed from drupal:9.0.0. There is no
 *   replacement.
 *
 * @see https://www.drupal.org/node/3018145
484
 */
485
function drupal_install_config_directories() {
486
  @trigger_error('drupal_install_config_directories() is deprecated in drupal:8.8.0 and is removed from drupal:9.0.0. There is no replacement. See https://www.drupal.org/node/3018145.', E_USER_DEPRECATED);
487
  global $config_directories, $install_state;
488

489 490
  // If settings.php does not contain a config sync directory name we need to
  // configure one.
491
  if (empty($config_directories[CONFIG_SYNC_DIRECTORY])) {
492 493 494 495 496 497 498 499 500
    if (empty($install_state['config_install_path'])) {
      // Add a randomized config directory name to settings.php
      $config_directories[CONFIG_SYNC_DIRECTORY] = \Drupal::service('site.path') . '/files/config_' . Crypt::randomBytesBase64(55) . '/sync';
    }
    else {
      // Install profiles can contain a config sync directory. If they do,
      // 'config_install_path' is a path to the directory.
      $config_directories[CONFIG_SYNC_DIRECTORY] = $install_state['config_install_path'];
    }
501
    $settings['config_directories'][CONFIG_SYNC_DIRECTORY] = (object) [
502
      'value' => $config_directories[CONFIG_SYNC_DIRECTORY],
503 504
      'required' => TRUE,
    ];
505 506 507 508
    // Rewrite settings.php, which also sets the value as global variable.
    drupal_rewrite_settings($settings);
  }

509 510 511 512 513 514
  // 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().
515
  if (!\Drupal::service('file_system')->prepareDirectory($config_directories[CONFIG_SYNC_DIRECTORY], FileSystemInterface::CREATE_DIRECTORY)
516
    && !file_exists($config_directories[CONFIG_SYNC_DIRECTORY])) {
517
    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>.', [
518
      '%directory' => config_get_config_directory(CONFIG_SYNC_DIRECTORY),
519
      ':handbook_url' => 'https://www.drupal.org/server-permissions',
520
    ]));
521
  }
522 523 524 525 526 527
  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';
528
    file_put_contents(config_get_config_directory(CONFIG_SYNC_DIRECTORY) . '/README.txt', "$text\n");
529
  }
530 531 532 533
}

/**
 * Ensures that the config directory exists and is writable, or can be made so.
534 535
 *
 * @param string $type
536
 *   Type of config directory to return. Drupal core provides 'sync'.
537 538 539
 *
 * @return bool
 *   TRUE if the config directory exists and is writable.
540 541
 *
 * @deprecated in Drupal 8.1.x, will be removed before Drupal 9.0.x. Use
542 543
 *   config_get_config_directory() and
 *  \Drupal\Core\File\FileSystemInterface::prepareDirectory() instead.
544 545
 *
 * @see https://www.drupal.org/node/2501187
546
 */
547
function install_ensure_config_directory($type) {
548
  @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 \Drupal\Core\File\FileSystemInterface::prepareDirectory() instead. See https://www.drupal.org/node/2501187.', E_USER_DEPRECATED);
549
  // The config directory must be defined in settings.php.
550 551
  global $config_directories;
  if (!isset($config_directories[$type])) {
552 553 554 555 556
    return FALSE;
  }
  // The logic here is similar to that used by system_requirements() for other
  // directories that the installer creates.
  else {
557
    $config_directory = config_get_config_directory($type);
558
    return \Drupal::service('file_system')->prepareDirectory($config_directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
559 560 561
  }
}

562
/**
563
 * Verifies that all dependencies are met for a given installation profile.
564
 *
565 566
 * @param $install_state
 *   An array of information about the current installation state.
567
 *
Steven Wittens's avatar
Steven Wittens committed
568 569
 * @return
 *   The list of modules to install.
570
 */
571
function drupal_verify_profile($install_state) {
572
  $profile = $install_state['parameters']['profile'];
573
  $info = $install_state['profile_info'];
574

575
  // Get the list of available modules for the selected installation profile.
576
  $listing = new ExtensionDiscovery(\Drupal::root());
577
  $present_modules = [];
578
  foreach ($listing->scan('module') as $present_module) {
579
    $present_modules[] = $present_module->getName();
580 581
  }

582 583
  // The installation profile is also a module, which needs to be installed
  // after all the other dependencies have been installed.
584
  $present_modules[] = $profile;
585

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

589
  $requirements = [];
590

591 592 593 594 595 596
  if ($missing_modules) {
    $build = [
      '#theme' => 'item_list',
      '#context' => ['list_style' => 'comma-list'],
    ];

597
    foreach ($missing_modules as $module) {
598
      $build['#items'][] = ['#markup' => '<span class="admin-missing">' . Unicode::ucfirst($module) . '</span>'];
Steven Wittens's avatar
Steven Wittens committed
599
    }
600 601

    $modules_list = \Drupal::service('renderer')->renderPlain($build);
602
    $requirements['required_modules'] = [
603 604 605
      'title' => t('Required modules'),
      'value' => t('Required modules not found.'),
      'severity' => REQUIREMENT_ERROR,
606 607
      '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
608
  }
609
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
610
}
611

612
/**
613
 * Installs the system module.
614 615 616
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
617 618 619 620
 *
 * @param array $install_state
 *   An array of information about the current installation state. This is used
 *   to set the default language.
621
 */
622
function drupal_install_system($install_state) {
623
  // Remove the service provider of the early installer.
624
  unset($GLOBALS['conf']['container_service_providers']['InstallerServiceProvider']);
625 626
  // Add the normal installer service provider.
  $GLOBALS['conf']['container_service_providers']['InstallerServiceProvider'] = 'Drupal\Core\Installer\NormalInstallerServiceProvider';
627

628 629 630 631 632 633 634 635
  $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);
636

637 638 639 640 641 642 643
  // 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');

644 645
  // Install base system configuration.
  \Drupal::service('config.installer')->installDefaultConfig('core', 'core');
646

647 648 649 650 651 652
  // 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();

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

657 658
  // Ensure default language is saved.
  if (isset($install_state['parameters']['langcode'])) {
659
    \Drupal::configFactory()->getEditable('system.site')
660 661 662
      ->set('langcode', (string) $install_state['parameters']['langcode'])
      ->set('default_langcode', (string) $install_state['parameters']['langcode'])
      ->save(TRUE);
663
  }
664 665
}

666
/**
667
 * Verifies the state of the specified file.
668 669 670 671 672 673 674
 *
 * @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.
675 676 677
 * @param bool $autofix
 *   (optional) Determines whether to attempt fixing the permissions according
 *   to the provided $mask. Defaults to TRUE.
678
 *
679
 * @return
680
 *   TRUE on success or FALSE on failure. A message is set for the latter.
681
 */
682
function drupal_verify_install_file($file, $mask = NULL, $type = 'file', $autofix = TRUE) {
683 684 685 686 687 688 689
  $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)) {
690
    $check = 'is_' . $type;
691 692 693 694 695 696 697
    if (!function_exists($check) || !$check($file)) {
      $return = FALSE;
    }
  }

  // Verify file permissions.
  if (isset($mask)) {
698
    $masks = [FILE_EXIST, FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
699 700 701 702 703
    foreach ($masks as $current_mask) {
      if ($mask & $current_mask) {
        switch ($current_mask) {
          case FILE_EXIST:
            if (!file_exists($file)) {
704
              if ($type == 'dir' && $autofix) {
705 706 707 708 709 710 711 712
                drupal_install_mkdir($file, $mask);
              }
              if (!file_exists($file)) {
                $return = FALSE;
              }
            }
            break;
          case FILE_READABLE:
713
            if (!is_readable($file)) {
714 715 716 717
              $return = FALSE;
            }
            break;
          case FILE_WRITABLE:
718
            if (!is_writable($file)) {
719 720 721 722
              $return = FALSE;
            }
            break;
          case FILE_EXECUTABLE:
723
            if (!is_executable($file)) {
724 725 726 727
              $return = FALSE;
            }
            break;
          case FILE_NOT_READABLE:
728
            if (is_readable($file)) {
729 730 731 732
              $return = FALSE;
            }
            break;
          case FILE_NOT_WRITABLE:
733
            if (is_writable($file)) {
734 735 736 737
              $return = FALSE;
            }
            break;
          case FILE_NOT_EXECUTABLE:
738
            if (is_executable($file)) {
739 740 741 742 743 744 745
              $return = FALSE;
            }
            break;
        }
      }
    }
  }
746 747 748
  if (!$return && $autofix) {
    return drupal_install_fix_file($file, $mask);
  }
749 750 751 752
  return $return;
}

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

784
  if (@\Drupal::service('file_system')->mkdir($file, $mod)) {
785 786 787 788 789 790 791 792
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
793
 * Attempts to fix file permissions.
794
 *
795 796 797 798 799 800 801 802 803
 * 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.
 *
804
 * @param $file
805
 *   The name of the file with permissions to fix.
806
 * @param $mask
807
 *   The desired permissions for the file.
808
 * @param $message
809
 *   (optional) Whether to output messages. Defaults to TRUE.
810
 *
811
 * @return
812
 *   TRUE/FALSE whether or not we were able to fix the file's permissions.
813 814
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
815 816 817 818 819
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

820
  $mod = fileperms($file) & 0777;
821
  $masks = [FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
822 823 824 825 826

  // 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.
827 828 829 830 831
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
832
            $mod |= 0444;
833 834 835 836
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
837
            $mod |= 0222;
838 839 840 841
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
842
            $mod |= 0111;
843 844 845 846
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
847
            $mod &= ~0444;
848 849 850 851
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
852
            $mod &= ~0222;
853 854 855 856
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
857
            $mod &= ~0111;
858 859 860 861 862 863
          }
          break;
      }
    }
  }

864 865
  // chmod() will work if the web server is running as owner of the file.
  if (@chmod($file, $mod)) {
866 867 868 869 870 871 872
    return TRUE;
  }
  else {
    return FALSE;
  }
}

873
/**
874
 * Sends the user to a different installer page.
875 876
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
877 878 879 880 881
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
882
  global $base_url;
883
  $headers = [
884 885
    // Not a permanent redirect.
    'Cache-Control' => 'no-cache',
886
  ];
887 888
  $response = new RedirectResponse($base_url . '/' . $path, 302, $headers);
  $response->send();
889 890
}

891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
/**
 * 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
912 913
 *   through \Drupal\Component\Utility\UrlHelper::filterBadProtocol() if it will be
 *   used as an HTML attribute value.
914 915
 *
 * @see drupal_requirements_url()
916
 * @see Drupal\Component\Utility\UrlHelper::filterBadProtocol()
917
 */
918
function drupal_current_script_url($query = []) {
919
  $uri = $_SERVER['SCRIPT_NAME'];
920
  $query = array_merge(UrlHelper::filterQueryParameters(\Drupal::request()->query->all()), $query);
921
  if (!empty($query)) {
922
    $uri .= '?' . UrlHelper::buildQuery($query);
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
  }
  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
940