install.inc 34.8 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 = array();
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
 * Detects all supported databases that are compiled into PHP.
116 117 118 119 120
 *
 * @return
 *  An array of database types compiled into PHP.
 */
function drupal_detect_database_types() {
121 122 123 124 125 126 127 128 129 130
  $databases = drupal_get_database_types();

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

  return $databases;
}

/**
131
 * Returns all supported database driver installer objects.
132
 *
133 134
 * @return \Drupal\Core\Database\Install\Tasks[]
 *   An array of available database driver installer objects.
135 136
 */
function drupal_get_database_types() {
137
  $databases = array();
138
  $drivers = array();
139

140 141
  // The internal database driver name is any valid PHP identifier.
  $mask = '/^' . DRUPAL_PHP_FUNCTION_PATTERN . '$/';
142 143 144 145 146
  $files = file_scan_directory(DRUPAL_ROOT . '/core/lib/Drupal/Core/Database/Driver', $mask, array('recurse' => FALSE));
  if (is_dir(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database')) {
    $files += file_scan_directory(DRUPAL_ROOT . '/drivers/lib/Drupal/Driver/Database/', $mask, array('recurse' => FALSE));
  }
  foreach ($files as $file) {
147
    if (file_exists($file->uri . '/Install/Tasks.php')) {
148 149
      $drivers[$file->filename] = $file->uri;
    }
150 151
  }
  foreach ($drivers as $driver => $file) {
152
    $installer = db_installer_object($driver);
153
    if ($installer->installable()) {
154
      $databases[$driver] = $installer;
155 156
    }
  }
157

158
  // Usability: unconditionally put the MySQL driver on top.
159 160 161 162 163
  if (isset($databases['mysql'])) {
    $mysql_database = $databases['mysql'];
    unset($databases['mysql']);
    $databases = array('mysql' => $mysql_database) + $databases;
  }
164

165 166 167
  return $databases;
}

168
/**
169
 * Replaces values in settings.php with values in the submitted array.
170
 *
171 172 173 174
 * 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.
 *
175
 * @param $settings
176 177 178 179 180
 *   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(
181 182 183
 *     CONFIG_STAGING_DIRECTORY => (object) array(
 *       'value' => 'config_hash/staging',
 *       'required' => TRUE,
184 185 186 187 188
 *     ),
 *   );
 *   @endcode
 *   gets dumped as:
 *   @code
189 190
 *   $config_directories['active'] = 'config_hash/active';
 *   $config_directories['staging'] = 'config_hash/staging'
191
 *   @endcode
192
 */
193 194
function drupal_rewrite_settings($settings = array(), $settings_file = NULL) {
  if (!isset($settings_file)) {
195
    $settings_file = \Drupal::service('site.path') . '/settings.php';
196
  }
197
  // Build list of setting names and insert the values into the global namespace.
198
  $variable_names = array();
199
  $settings_settings = array();
200
  foreach ($settings as $setting => $data) {
201 202 203 204 205 206
    if ($setting != 'settings') {
      _drupal_rewrite_settings_global($GLOBALS[$setting], $data);
    }
    else {
      _drupal_rewrite_settings_global($settings_settings, $data);
    }
207
    $variable_names['$'. $setting] = $setting;
208
  }
209
  $contents = file_get_contents($settings_file);
210
  if ($contents !== FALSE) {
211 212 213 214
    // Initialize the contents for the settings.php file if it is empty.
    if (trim($contents) === '') {
      $contents = "<?php\n";
    }
215 216
    // Step through each token in settings.php and replace any variables that
    // are in the passed-in array.
217 218
    $buffer = '';
    $state = 'default';
219
    foreach (token_get_all($contents) as $token) {
220 221
      if (is_array($token)) {
        list($type, $value) = $token;
222
      }
223
      else {
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 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
        $type = -1;
        $value = $token;
      }
      // Do not operate on whitespace.
      if (!in_array($type, array(T_WHITESPACE, T_COMMENT, T_DOC_COMMENT))) {
        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.
302
              throw new Exception('Unexpected token after replacing value.');
303 304
            }
            break;
305 306
        }
      }
307
      $buffer .= $value;
308
    }
309 310
    foreach ($settings as $name => $setting) {
      $buffer .= _drupal_rewrite_settings_dump($setting, '$' . $name);
311 312
    }

313
    // Write the new settings file.
314
    if (file_put_contents($settings_file, $buffer) === FALSE) {
315
      throw new Exception(t('Failed to modify %settings. Verify the file permissions.', array('%settings' => $settings_file)));
316
    }
317 318 319 320
    else {
      // In case any $settings variables were written, import them into the
      // Settings singleton.
      if (!empty($settings_settings)) {
321
        $old_settings = Settings::getAll();
322 323
        new Settings($settings_settings + $old_settings);
      }
324 325 326 327 328
      // 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);
329
    }
330 331
  }
  else {
332
    throw new Exception(t('Failed to open %settings. Verify the file permissions.', array('%settings' => $settings_file)));
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
/**
 * Helper for drupal_rewrite_settings().
 *
 * Checks whether this token represents a scalar or NULL.
 *
 * @param int $type
 *   The token type
 *   @see token_name().
 * @param string $value
 *   The value of the token.
 *
 * @return bool
 *   TRUE if this token represents a scalar or NULL.
 */
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;
  $is_boolean_or_null = $type == T_STRING && in_array(strtoupper($value), array('TRUE', 'FALSE', 'NULL'));
  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
363
 * string.
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
 *
 * @param int $type
 *   The token type
 *   @see token_name().
 *
 * @return bool
 *   TRUE if this token represents a number or a string.
 */
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.
 *
384
 * @param array|null $ref
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
 *   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.
 *
434
 * @param object $variable
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
 *   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;
}

453 454 455 456 457 458
/**
 * Creates the config directory and ensures it is operational.
 *
 * @see install_settings_form_submit()
 * @see update_prepare_d8_bootstrap()
 */
459
function drupal_install_config_directories() {
460
  global $config_directories;
461 462 463

  // Add a randomized config directory name to settings.php, unless it was
  // manually defined in the existing already.
464 465 466 467
  $settings = [];
  $config_directories_hash = Crypt::randomBytesBase64(55);
  if (empty($config_directories[CONFIG_STAGING_DIRECTORY])) {
    $settings['config_directories'][CONFIG_STAGING_DIRECTORY] = (object) [
468
      'value' => \Drupal::service('site.path') . '/files/config_' . $config_directories_hash . '/staging',
469 470 471 472 473
      'required' => TRUE,
    ];
  }

  if (!empty($settings)) {
474 475 476 477
    // Rewrite settings.php, which also sets the value as global variable.
    drupal_rewrite_settings($settings);
  }

478 479 480 481 482 483 484
  // 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().
  if (!install_ensure_config_directory(CONFIG_STAGING_DIRECTORY)) {
485
    throw new Exception(t('The directory %directory could not be created or could not be made writable. To proceed with the installation, either create the directory and modify its permissions manually or ensure that the installer has the permissions to create it automatically. For more information, see the <a href=":handbook_url">online handbook</a>.', array(
486
      '%directory' => config_get_config_directory(CONFIG_STAGING_DIRECTORY),
487
      ':handbook_url' => 'https://www.drupal.org/server-permissions',
488
    )));
489
  }
490 491 492 493 494 495 496

  // Put a README.txt into the staging 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_STAGING_DIRECTORY) . '/README.txt', $text);
497 498 499 500
}

/**
 * Ensures that the config directory exists and is writable, or can be made so.
501 502 503 504 505 506 507
 *
 * @param string $type
 *   Type of config directory to return. Drupal core provides 'active' and
 *   'staging'.
 *
 * @return bool
 *   TRUE if the config directory exists and is writable.
508
 */
509
function install_ensure_config_directory($type) {
510
  // The config directory must be defined in settings.php.
511 512
  global $config_directories;
  if (!isset($config_directories[$type])) {
513 514 515 516 517
    return FALSE;
  }
  // The logic here is similar to that used by system_requirements() for other
  // directories that the installer creates.
  else {
518
    $config_directory = config_get_config_directory($type);
519
    return file_prepare_directory($config_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
520 521 522
  }
}

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

536
  // Get the list of available modules for the selected installation profile.
537
  $listing = new ExtensionDiscovery(\Drupal::root());
538
  $present_modules = array();
539
  foreach ($listing->scan('module') as $present_module) {
540
    $present_modules[] = $present_module->getName();
541 542
  }

543 544
  // The installation profile is also a module, which needs to be installed
  // after all the other dependencies have been installed.
545
  $present_modules[] = $profile;
546

547
  // Verify that all of the profile's required modules are present.
548
  $missing_modules = array_diff($info['dependencies'], $present_modules);
549 550

  $requirements = array();
551

552
  if (count($missing_modules)) {
553
    $modules = array();
554
    foreach ($missing_modules as $module) {
555
      $modules[] = '<span class="admin-missing">' . Unicode::ucfirst($module) . '</span>';
Steven Wittens's avatar
Steven Wittens committed
556
    }
557
    $requirements['required_modules'] = array(
558 559
      'title'       => t('Required modules'),
      'value'       => t('Required modules not found.'),
560
      'severity'    => REQUIREMENT_ERROR,
561
      'description' => t('The following modules are required but were not found. Move them into the appropriate modules subdirectory, such as <em>/modules</em>. Missing modules: !modules', array('!modules' => implode(', ', $modules))),
562
    );
Steven Wittens's avatar
Steven Wittens committed
563
  }
564
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
565
}
566

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

581 582 583 584 585 586 587 588
  $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);
589

590 591
  // Install base system configuration.
  \Drupal::service('config.installer')->installDefaultConfig('core', 'core');
592

593
  // Install System module and rebuild the newly available routes.
594
  $kernel->getContainer()->get('module_installer')->install(array('system'), FALSE);
595
  \Drupal::service('router.builder')->rebuild();
596

597 598
  // Ensure default language is saved.
  if (isset($install_state['parameters']['langcode'])) {
599
    \Drupal::configFactory()->getEditable('system.site')
600 601 602
      ->set('langcode', (string) $install_state['parameters']['langcode'])
      ->set('default_langcode', (string) $install_state['parameters']['langcode'])
      ->save(TRUE);
603
  }
604 605
}

606
/**
607
 * Verifies the state of the specified file.
608 609 610 611 612 613 614
 *
 * @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.
615
 *
616
 * @return
617
 *   TRUE on success or FALSE on failure. A message is set for the latter.
618 619 620 621 622 623 624 625 626
 */
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)) {
627
    $check = 'is_' . $type;
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
    if (!function_exists($check) || !$check($file)) {
      $return = FALSE;
    }
  }

  // Verify file permissions.
  if (isset($mask)) {
    $masks = array(FILE_EXIST, FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
    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;
}

/**
687
 * Creates a directory with the specified permissions.
688
 *
689
 * @param $file
690
 *  The name of the directory to create;
691
 * @param $mask
692 693 694
 *  The permissions of the directory to create.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
695
 *
696 697 698 699 700 701 702 703 704 705
 * @return
 *  TRUE/FALSE whether or not the directory was successfully created.
 */
function drupal_install_mkdir($file, $mask, $message = TRUE) {
  $mod = 0;
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
706
          $mod |= 0444;
707 708
          break;
        case FILE_WRITABLE:
709
          $mod |= 0222;
710 711
          break;
        case FILE_EXECUTABLE:
712
          $mod |= 0111;
713 714 715 716 717
          break;
      }
    }
  }

718
  if (@drupal_mkdir($file, $mod)) {
719 720 721 722 723 724 725 726
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
727
 * Attempts to fix file permissions.
728
 *
729 730 731 732 733 734 735 736 737
 * 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.
 *
738 739 740 741 742 743
 * @param $file
 *  The name of the file with permissions to fix.
 * @param $mask
 *  The desired permissions for the file.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
744
 *
745 746 747 748
 * @return
 *  TRUE/FALSE whether or not we were able to fix the file's permissions.
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
749 750 751 752 753
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

754
  $mod = fileperms($file) & 0777;
755
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
756 757 758 759 760

  // 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.
761 762 763 764 765
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
766
            $mod |= 0444;
767 768 769 770
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
771
            $mod |= 0222;
772 773 774 775
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
776
            $mod |= 0111;
777 778 779 780
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
781
            $mod &= ~0444;
782 783 784 785
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
786
            $mod &= ~0222;
787 788 789 790
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
791
            $mod &= ~0111;
792 793 794 795 796 797
          }
          break;
      }
    }
  }

798 799
  // chmod() will work if the web server is running as owner of the file.
  if (@chmod($file, $mod)) {
800 801 802 803 804 805 806
    return TRUE;
  }
  else {
    return FALSE;
  }
}

807
/**
808
 * Sends the user to a different installer page.
809 810
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
811 812 813 814 815
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
816
  global $base_url;
817 818 819 820 821 822
  $headers = array(
    // Not a permanent redirect.
    'Cache-Control' => 'no-cache',
  );
  $response = new RedirectResponse($base_url . '/' . $path, 302, $headers);
  $response->send();
823 824
}

825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
/**
 * 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
846 847
 *   through \Drupal\Component\Utility\UrlHelper::filterBadProtocol() if it will be
 *   used as an HTML attribute value.
848 849
 *
 * @see drupal_requirements_url()
850
 * @see Drupal\Component\Utility\UrlHelper::filterBadProtocol()
851 852 853
 */
function drupal_current_script_url($query = array()) {
  $uri = $_SERVER['SCRIPT_NAME'];
854
  $query = array_merge(UrlHelper::filterQueryParameters(\Drupal::request()->query->all()), $query);
855
  if (!empty($query)) {
856
    $uri .= '?' . UrlHelper::buildQuery($query);
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
  }
  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
874 875 876
 *   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.
877 878
 *
 * @see drupal_current_script_url()
879
 * @see \Drupal\Component\Utility\UrlHelper::filterBadProtocol()
880 881 882 883 884 885 886 887 888 889 890
 */
function drupal_requirements_url($severity) {
  $query = array();
  // 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);
}

891
/**
892
 * Checks an installation profile's requirements.
893
 *
894
 * @param string $profile
895
 *   Name of installation profile to check.
896 897 898 899
 * @param array $install_state
 *   The current state in the install process.
 *
 * @return array
900
 *   Array of the installation profile's requirements.
901
 */
902
function drupal_check_profile($profile, array $install_state) {
903
  $info = install_profile_info($profile);
904

905
  // Collect requirement testing results.
906
  $requirements = array();
907 908 909 910 911 912

  // 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
  $listing = new ExtensionDiscovery(\Drupal::root());
  $module_list = $listing->scan('module');
913
  foreach ($info['dependencies'] as $module) {
914 915 916 917
    $file = \Drupal::root() . '/' . $module_list[$module]->getPath() . "/$module.install";
    if (is_file($file)) {
      require_once $file;
    }
918
    $function = $module . '_requirements';
919

920
    drupal_classloader_register($module, $module_list[$module]->getPath());
921 922
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
923
    }
924 925 926 927 928
  }
  return $requirements;
}

/**
929
 * Extracts the highest severity from the requirements array.
930 931
 *
 * @param $requirements
932
 *   An array of requirements, in the same format as is returned by
933
 *   hook_requirements().
934
 *
935 936
 * @return
 *   The highest severity in the array.
937 938 939 940 941 942 943 944 945 946 947 948
 */
function drupal_requirements_severity(&$requirements) {
  $severity = REQUIREMENT_OK;
  foreach ($requirements as $requirement) {
    if (isset($requirement['severity'])) {
      $severity = max($severity, $requirement['severity']);
    }
  }
  return $severity;
}

/**
949
 * Checks a module's requirements.
950 951 952
 *
 * @param $module
 *   Machine name of module to check.
953
 *
954
 * @return
955
 *   TRUE or FALSE, depending on whether the requirements are met.
956 957
 */
function drupal_check_module($module) {
958
  module_load_install($module);
959
  // Check requirements
960
  $requirements = \Drupal::moduleHandler()->invoke($module, 'requirements', array('install'));
961 962 963 964
  if (is_array($requirements) && drupal_requirements_severity($requirements) == REQUIREMENT_ERROR) {
    // Print any error messages
    foreach ($requirements as $requirement) {
      if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_ERROR) {
965
        $message = $requirement['description'];
966
        if (isset($requirement['value']) && $requirement['value']) {
967
          $message = t('@requirements_message (Currently using @item version @version)', array('@requirements_message' => $requirement['description'], '@item' => $requirement['title'], '@version' => $requirement['value']));
968
        }
969
        drupal_set_message($message, 'error');
970 971
      }
    }
972
    return FALSE;
973 974 975
  }
  return TRUE;
}
976 977

/**
978
 * Retrieves information about an installation profile from its .info.yml file.
979
 *
980 981
 * The information stored in a profile .info.yml file is similar to that stored
 * in a normal Drupal module .info.yml file. For example:
982
 * - name: The real name of the installation profile for display purposes.
983
 * - description: A brief description of the profile.
984 985
 * - dependencies: An array of shortnames of other modules that this install
 *   profile requires.
986
 *
987 988 989
 * Additional, less commonly-used information that can appear in a
 * profile.info.yml file but not in a normal Drupal module .info.yml file
 * includes:
990 991 992 993 994 995 996 997 998 999 1000 1001 1002
 *
 * - distribution: Existence of this key denotes that the installation profile
 *   is intended to be the only eligible choice in a distribution and will be
 *   auto-selected during installation, whereas the installation profile
 *   selection screen will be skipped. If more than one distribution profile is
 *   found then the first one discovered will be selected.
 *   The following subproperties may be set:
 *   - name: The name of the distribution that is being installed, to be shown
 *     throughout the installation process. If omitted,
 *     drupal_install_profile_distribution_name() defaults to 'Drupal'.
 *   - install: Optional parameters to override the installer:
 *     - theme: The machine name of a theme to use in the installer instead of
 *       Drupal's default installer theme.
1003
 *
1004 1005 1006 1007
 * Note that