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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

79
/**
80
 * Loads .install files for installed modules to initialize the update system.
81 82
 */
function drupal_load_updates() {
83 84
  /** @var \Drupal\Core\Extension\ModuleExtensionList $extension_list_module */
  $extension_list_module = \Drupal::service('extension.list.module');
85
  foreach (drupal_get_installed_schema_version(NULL, FALSE, TRUE) as $module => $schema_version) {
86 87 88 89
    if ($extension_list_module->exists($module) && !$extension_list_module->checkIncompatibility($module)) {
      if ($schema_version > -1) {
        module_load_install($module);
      }
90
    }
91 92 93
  }
}

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

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

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

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

  return $databases;
}

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

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

  // Find drivers in the Drupal\Core and Drupal\Driver namespaces.
176 177 178
  /** @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]);
179
  if (is_dir(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database')) {
180
    $files += $file_system->scanDirectory(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database/', $mask, ['recurse' => FALSE]);
181 182
  }
  foreach ($files as $file) {
183
    if (file_exists($file->uri . '/Install/Tasks.php')) {
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 214 215
      // 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);
        }
      }
216
    }
217
  }
218 219 220

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

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

233 234 235
  return $databases;
}

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

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

401 402 403 404 405 406
/**
 * Helper for drupal_rewrite_settings().
 *
 * Checks whether this token represents a scalar or NULL.
 *
 * @param int $type
407
 *   The token type.
408 409 410 411 412
 * @param string $value
 *   The value of the token.
 *
 * @return bool
 *   TRUE if this token represents a scalar or NULL.
413 414
 *
 * @see token_name()
415 416 417 418 419
 */
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;
420
  $is_boolean_or_null = $type == T_STRING && in_array(strtoupper($value), ['TRUE', 'FALSE', 'NULL']);
421 422 423 424 425 426 427
  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
428
 * string.
429 430
 *
 * @param int $type
431
 *   The token type.
432 433 434
 *
 * @return bool
 *   TRUE if this token represents a number or a string.
435 436
 *
 * @see token_name()
437 438 439 440 441 442 443 444 445 446 447 448 449
 */
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.
 *
450
 * @param array|null $ref
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 497 498
 *   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.
 *
499
 * @param object $variable
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
 *   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;
}

518 519 520
/**
 * Creates the config directory and ensures it is operational.
 *
521 522 523 524
 * @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
525
 */
526
function drupal_install_config_directories() {
527
  @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);
528
  global $config_directories, $install_state;
529

530 531
  // If settings.php does not contain a config sync directory name we need to
  // configure one.
532
  if (empty($config_directories[CONFIG_SYNC_DIRECTORY])) {
533 534 535 536 537 538 539 540 541
    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'];
    }
542
    $settings['config_directories'][CONFIG_SYNC_DIRECTORY] = (object) [
543
      'value' => $config_directories[CONFIG_SYNC_DIRECTORY],
544 545
      'required' => TRUE,
    ];
546 547 548 549
    // Rewrite settings.php, which also sets the value as global variable.
    drupal_rewrite_settings($settings);
  }

550 551 552 553 554 555
  // 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().
556
  if (!\Drupal::service('file_system')->prepareDirectory($config_directories[CONFIG_SYNC_DIRECTORY], FileSystemInterface::CREATE_DIRECTORY)
557
    && !file_exists($config_directories[CONFIG_SYNC_DIRECTORY])) {
558
    throw new Exception("The directory '" . config_get_config_directory(CONFIG_SYNC_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='https://www.drupal.org/server-permissions'>online handbook</a>.");
559
  }
560 561 562 563 564 565
  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';
566
    file_put_contents(config_get_config_directory(CONFIG_SYNC_DIRECTORY) . '/README.txt', "$text\n");
567
  }
568 569 570 571
}

/**
 * Ensures that the config directory exists and is writable, or can be made so.
572 573
 *
 * @param string $type
574
 *   Type of config directory to return. Drupal core provides 'sync'.
575 576 577
 *
 * @return bool
 *   TRUE if the config directory exists and is writable.
578
 *
579
 * @deprecated in drupal:8.1.0 and is removed from drupal:9.0.0. Use
580 581
 *   config_get_config_directory() and
 *  \Drupal\Core\File\FileSystemInterface::prepareDirectory() instead.
582 583
 *
 * @see https://www.drupal.org/node/2501187
584
 */
585
function install_ensure_config_directory($type) {
586
  @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);
587
  // The config directory must be defined in settings.php.
588 589
  global $config_directories;
  if (!isset($config_directories[$type])) {
590 591 592 593 594
    return FALSE;
  }
  // The logic here is similar to that used by system_requirements() for other
  // directories that the installer creates.
  else {
595
    $config_directory = config_get_config_directory($type);
596
    return \Drupal::service('file_system')->prepareDirectory($config_directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
597 598 599
  }
}

600
/**
601
 * Verifies that all dependencies are met for a given installation profile.
602
 *
603 604
 * @param $install_state
 *   An array of information about the current installation state.
605
 *
Steven Wittens's avatar
Steven Wittens committed
606 607
 * @return
 *   The list of modules to install.
608
 */
609
function drupal_verify_profile($install_state) {
610
  $profile = $install_state['parameters']['profile'];
611
  $info = $install_state['profile_info'];
612

613
  // Get the list of available modules for the selected installation profile.
614
  $listing = new ExtensionDiscovery(\Drupal::root());
615
  $present_modules = [];
616
  foreach ($listing->scan('module') as $present_module) {
617
    $present_modules[] = $present_module->getName();
618 619
  }

620 621
  // The installation profile is also a module, which needs to be installed
  // after all the other dependencies have been installed.
622
  $present_modules[] = $profile;
623

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

627
  $requirements = [];
628

629 630 631 632 633 634
  if ($missing_modules) {
    $build = [
      '#theme' => 'item_list',
      '#context' => ['list_style' => 'comma-list'],
    ];

635
    foreach ($missing_modules as $module) {
636
      $build['#items'][] = ['#markup' => '<span class="admin-missing">' . Unicode::ucfirst($module) . '</span>'];
Steven Wittens's avatar
Steven Wittens committed
637
    }
638 639

    $modules_list = \Drupal::service('renderer')->renderPlain($build);
640
    $requirements['required_modules'] = [
641 642 643
      'title' => t('Required modules'),
      'value' => t('Required modules not found.'),
      'severity' => REQUIREMENT_ERROR,
644 645
      '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
646
  }
647
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
648
}
649

650
/**
651
 * Installs the system module.
652 653 654
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
655 656 657 658
 *
 * @param array $install_state
 *   An array of information about the current installation state. This is used
 *   to set the default language.
659
 */
660
function drupal_install_system($install_state) {
661
  // Remove the service provider of the early installer.
662
  unset($GLOBALS['conf']['container_service_providers']['InstallerServiceProvider']);
663 664
  // Add the normal installer service provider.
  $GLOBALS['conf']['container_service_providers']['InstallerServiceProvider'] = 'Drupal\Core\Installer\NormalInstallerServiceProvider';
665

666
  // Get the existing request.
667 668 669 670 671 672 673
  $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);
674 675 676 677 678 679 680
  // 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'));
  }
681

682 683 684 685 686 687 688
  // 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');

689 690
  // Install base system configuration.
  \Drupal::service('config.installer')->installDefaultConfig('core', 'core');
691

692 693 694 695 696 697
  // 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();

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

702 703
  // Ensure default language is saved.
  if (isset($install_state['parameters']['langcode'])) {
704
    \Drupal::configFactory()->getEditable('system.site')
705 706 707
      ->set('langcode', (string) $install_state['parameters']['langcode'])
      ->set('default_langcode', (string) $install_state['parameters']['langcode'])
      ->save(TRUE);
708
  }
709 710
}

711
/**
712
 * Verifies the state of the specified file.
713 714 715 716 717 718 719
 *
 * @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.
720 721 722
 * @param bool $autofix
 *   (optional) Determines whether to attempt fixing the permissions according
 *   to the provided $mask. Defaults to TRUE.
723
 *
724
 * @return
725
 *   TRUE on success or FALSE on failure. A message is set for the latter.
726
 */
727
function drupal_verify_install_file($file, $mask = NULL, $type = 'file', $autofix = TRUE) {
728 729 730 731 732 733 734
  $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)) {
735
    $check = 'is_' . $type;
736 737 738 739 740 741 742
    if (!function_exists($check) || !$check($file)) {
      $return = FALSE;
    }
  }

  // Verify file permissions.
  if (isset($mask)) {
743
    $masks = [FILE_EXIST, FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
744 745 746 747 748
    foreach ($masks as $current_mask) {
      if ($mask & $current_mask) {
        switch ($current_mask) {
          case FILE_EXIST:
            if (!file_exists($file)) {
749
              if ($type == 'dir' && $autofix) {
750 751 752 753 754 755 756 757
                drupal_install_mkdir($file, $mask);
              }
              if (!file_exists($file)) {
                $return = FALSE;
              }
            }
            break;
          case FILE_READABLE:
758
            if (!is_readable($file)) {
759 760 761 762
              $return = FALSE;
            }
            break;
          case FILE_WRITABLE:
763
            if (!is_writable($file)) {
764 765 766 767
              $return = FALSE;
            }
            break;
          case FILE_EXECUTABLE:
768
            if (!is_executable($file)) {
769 770 771 772
              $return = FALSE;
            }
            break;
          case FILE_NOT_READABLE:
773
            if (is_readable($file)) {
774 775 776 777
              $return = FALSE;
            }
            break;
          case FILE_NOT_WRITABLE:
778
            if (is_writable($file)) {
779 780 781 782
              $return = FALSE;
            }
            break;
          case FILE_NOT_EXECUTABLE:
783
            if (is_executable($file)) {
784 785 786 787 788 789 790
              $return = FALSE;
            }
            break;
        }
      }
    }
  }
791 792 793
  if (!$return && $autofix) {
    return drupal_install_fix_file($file, $mask);
  }
794 795 796 797
  return $return;
}

/**
798
 * Creates a directory with the specified permissions.
799
 *
800
 * @param $file
801
 *   The name of the directory to create;
802
 * @param $mask
803
 *   The permissions of the directory to create.
804
 * @param $message
805
 *   (optional) Whether to output messages. Defaults to TRUE.
806
 *
807
 * @return
808
 *   TRUE/FALSE whether or not the directory was successfully created.
809 810 811
 */
function drupal_install_mkdir($file, $mask, $message = TRUE) {
  $mod = 0;
812
  $masks = [FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
813 814 815 816
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
817
          $mod |= 0444;
818 819
          break;
        case FILE_WRITABLE:
820
          $mod |= 0222;
821 822
          break;
        case FILE_EXECUTABLE:
823
          $mod |= 0111;
824 825 826 827 828
          break;
      }
    }
  }

829
  if (@\Drupal::service('file_system')->mkdir($file, $mod)) {
830 831 832 833 834 835 836 837
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
838
 * Attempts to fix file permissions.
839
 *
840 841 842 843 844 845 846 847 848
 * 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.
 *
849
 * @param $file
850
 *   The name of the file with permissions to fix.
851
 * @param $mask
852
 *   The desired permissions for the file.
853
 * @param $message
854
 *   (optional) Whether to output messages. Defaults to TRUE.
855
 *
856
 * @return
857
 *   TRUE/FALSE whether or not we were able to fix the file's permissions.
858 859
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
860 861 862 863 864
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

865
  $mod = fileperms($file) & 0777;
866
  $masks = [FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE];
867 868 869 870 871

  // 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.
872 873 874 875 876
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
877
            $mod |= 0444;
878 879 880 881
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
882
            $mod |= 0222;
883 884 885 886
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
887
            $mod |= 0111;
888 889 890 891
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
892
            $mod &= ~0444;
893 894 895 896
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
897
            $mod &= ~0222;
898 899 900 901
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
902
            $mod &= ~0111;
903 904 905 906 907 908
          }
          break;
      }
    }
  }

909 910
  // chmod() will work if the web server is running as owner of the file.
  if (@chmod($file, $mod)) {
911 912 913 914 915 916 917
    return TRUE;
  }
  else {
    return FALSE;
  }
}

918
/**
919
 * Sends the user to a different installer page.
920 921
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
922 923 924 925 926
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
927
  global $base_url;
928
  $headers = [
929 930
    // Not a permanent redirect.
    'Cache-Control' => 'no-cache',
931
  ];