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

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

8
use Symfony\Component\HttpFoundation\RedirectResponse;
9
use Drupal\Component\Utility\Crypt;
10
use Drupal\Component\Utility\OpCodeCache;
11
use Drupal\Component\Utility\Settings;
12
use Drupal\Component\Utility\UrlHelper;
13
use Drupal\Core\Database\Database;
14
use Drupal\Core\DrupalKernel;
15
use Drupal\Core\Extension\ExtensionDiscovery;
16

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/**
116
 * Detects all supported databases that are compiled into PHP.
117 118 119 120 121
 *
 * @return
 *  An array of database types compiled into PHP.
 */
function drupal_detect_database_types() {
122 123 124 125 126 127 128 129 130 131
  $databases = drupal_get_database_types();

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

  return $databases;
}

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

141 142
  // The internal database driver name is any valid PHP identifier.
  $mask = '/^' . DRUPAL_PHP_FUNCTION_PATTERN . '$/';
143 144 145 146 147
  $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) {
148
    if (file_exists($file->uri . '/Install/Tasks.php')) {
149 150
      $drivers[$file->filename] = $file->uri;
    }
151 152
  }
  foreach ($drivers as $driver => $file) {
153
    $installer = db_installer_object($driver);
154
    if ($installer->installable()) {
155
      $databases[$driver] = $installer;
156 157
    }
  }
158

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

166 167 168
  return $databases;
}

169
/**
170
 * Replaces values in settings.php with values in the submitted array.
171
 *
172 173 174 175
 * 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.
 *
176
 * @param $settings
177 178 179 180 181
 *   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(
182 183 184
 *     CONFIG_ACTIVE_DIRECTORY => (object) array(
 *       'value' => 'config_hash/active'
 *       'required' => TRUE,
185
 *     ),
186 187 188
 *     CONFIG_STAGING_DIRECTORY => (object) array(
 *       'value' => 'config_hash/staging',
 *       'required' => TRUE,
189 190 191 192 193
 *     ),
 *   );
 *   @endcode
 *   gets dumped as:
 *   @code
194 195
 *   $config_directories['active'] = 'config_hash/active';
 *   $config_directories['staging'] = 'config_hash/staging'
196
 *   @endcode
197
 */
198 199 200 201
function drupal_rewrite_settings($settings = array(), $settings_file = NULL) {
  if (!isset($settings_file)) {
    $settings_file = conf_path(FALSE) . '/settings.php';
  }
202
  // Build list of setting names and insert the values into the global namespace.
203
  $variable_names = array();
204
  $settings_settings = array();
205
  foreach ($settings as $setting => $data) {
206 207 208 209 210 211
    if ($setting != 'settings') {
      _drupal_rewrite_settings_global($GLOBALS[$setting], $data);
    }
    else {
      _drupal_rewrite_settings_global($settings_settings, $data);
    }
212
    $variable_names['$'. $setting] = $setting;
213
  }
214 215
  $contents = file_get_contents(DRUPAL_ROOT . '/' . $settings_file);
  if ($contents !== FALSE) {
216 217 218 219
    // Initialize the contents for the settings.php file if it is empty.
    if (trim($contents) === '') {
      $contents = "<?php\n";
    }
220 221
    // Step through each token in settings.php and replace any variables that
    // are in the passed-in array.
222 223
    $buffer = '';
    $state = 'default';
224
    foreach (token_get_all($contents) as $token) {
225 226
      if (is_array($token)) {
        list($type, $value) = $token;
227
      }
228
      else {
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 302 303 304 305 306
        $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.
307
              throw new Exception('Unexpected token after replacing value.');
308 309
            }
            break;
310 311
        }
      }
312
      $buffer .= $value;
313
    }
314 315
    foreach ($settings as $name => $setting) {
      $buffer .= _drupal_rewrite_settings_dump($setting, '$' . $name);
316 317
    }

318 319
    // Write the new settings file.
    if (file_put_contents(DRUPAL_ROOT . '/' . $settings_file, $buffer) === FALSE) {
320
      throw new Exception(t('Failed to modify %settings. Verify the file permissions.', array('%settings' => $settings_file)));
321
    }
322 323 324 325
    else {
      // In case any $settings variables were written, import them into the
      // Settings singleton.
      if (!empty($settings_settings)) {
326
        $old_settings = Settings::getAll();
327 328
        new Settings($settings_settings + $old_settings);
      }
329 330 331 332 333
      // 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);
334
    }
335 336
  }
  else {
337
    throw new Exception(t('Failed to open %settings. Verify the file permissions.', array('%settings' => $settings_file)));
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 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
/**
 * 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
 * stirng.
 *
 * @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.
 *
389
 * @param array|null $ref
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 434 435 436 437 438
 *   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.
 *
439
 * @param object $variable
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
 *   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;
}

458 459 460 461 462 463
/**
 * Creates the config directory and ensures it is operational.
 *
 * @see install_settings_form_submit()
 * @see update_prepare_d8_bootstrap()
 */
464
function drupal_install_config_directories() {
465
  global $config_directories;
466 467 468

  // Add a randomized config directory name to settings.php, unless it was
  // manually defined in the existing already.
469
  if (empty($config_directories)) {
470
    $config_directories_hash = Crypt::randomBytesBase64(55);
471
    $settings['config_directories'] = array(
472 473 474
      CONFIG_ACTIVE_DIRECTORY => (object) array(
        'value' => conf_path() . '/files/config_' . $config_directories_hash . '/active',
        'required' => TRUE,
475
      ),
476 477 478
      CONFIG_STAGING_DIRECTORY => (object) array(
        'value' => conf_path() . '/files/config_' . $config_directories_hash . '/staging',
        'required' => TRUE,
479
      ),
480 481 482 483 484
    );
    // Rewrite settings.php, which also sets the value as global variable.
    drupal_rewrite_settings($settings);
  }

485
  // Ensure the config directories exist or can be created, and are writable.
486
  foreach (array(CONFIG_ACTIVE_DIRECTORY, CONFIG_STAGING_DIRECTORY) as $config_type) {
487 488 489 490 491 492
    // 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().
493
    if (!install_ensure_config_directory($config_type)) {
494
      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(
495 496 497 498
        '%directory' => config_get_config_directory($config_type),
        '@handbook_url' => 'http://drupal.org/server-permissions',
      )));
    }
499 500 501 502 503 504 505

    // Put a README.txt into each config directory. This is required so that
    // they can later be added to git. Since these directories are auto-
    // created, we have to write out the README rather than just adding it
    // to the drupal core repo.
    switch ($config_type) {
      case CONFIG_ACTIVE_DIRECTORY:
506
        $text = 'This directory contains the active configuration for your Drupal site. To move this configuration between environments, contents from this directory should be placed in the staging directory on the target server. To make this configuration active, see admin/config/development/configuration/sync on the target server.';
507 508
        break;
      case CONFIG_STAGING_DIRECTORY:
509
        $text = 'This directory contains configuration to be imported into your Drupal site. To make this configuration active, see admin/config/development/configuration/sync.';
510 511 512 513
        break;
    }
    $text .=  ' For information about deploying configuration between servers, see http://drupal.org/documentation/administer/config';
    file_put_contents(config_get_config_directory($config_type) . '/README.txt', $text);
514 515 516
  }
}

517
/**
518
 * Checks whether a config directory exists and is writable.
519
 *
520
 * This partially duplicates install_ensure_config_directory(), but is required
521 522
 * since the installer would create the config directory too early in the
 * installation process otherwise (e.g., when only visiting install.php when
523 524
 * there is a settings.php already, but not actually executing the
 * installation).
525 526 527 528 529 530 531 532 533 534 535 536 537
 *
 * @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.
 */
function install_verify_config_directory($type) {
  global $config_directories;
  if (!isset($config_directories[$type])) {
    return FALSE;
  }
538 539 540 541 542 543 544 545 546 547
  // config_get_config_directory() throws an exception when the passed $type
  // does not exist in $config_directories. This can happen if there is a
  // prepared settings.php that defines $config_directories already.
  try {
    $config_directory = config_get_config_directory($type);
    if (is_dir($config_directory) && is_writable($config_directory)) {
      return TRUE;
    }
  }
  catch (\Exception $e) {
548 549 550 551
  }
  return FALSE;
}

552 553
/**
 * Ensures that the config directory exists and is writable, or can be made so.
554 555 556 557 558 559 560
 *
 * @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.
561
 */
562
function install_ensure_config_directory($type) {
563
  // The config directory must be defined in settings.php.
564 565
  global $config_directories;
  if (!isset($config_directories[$type])) {
566 567 568 569 570
    return FALSE;
  }
  // The logic here is similar to that used by system_requirements() for other
  // directories that the installer creates.
  else {
571
    $config_directory = config_get_config_directory($type);
572
    return file_prepare_directory($config_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
573 574 575
  }
}

576
/**
577
 * Verifies that all dependencies are met for a given installation profile.
578
 *
579 580
 * @param $install_state
 *   An array of information about the current installation state.
581
 *
Steven Wittens's avatar
Steven Wittens committed
582 583
 * @return
 *   The list of modules to install.
584
 */
585
function drupal_verify_profile($install_state) {
586 587
  include_once __DIR__ . '/file.inc';
  include_once __DIR__ . '/common.inc';
588

589
  $profile = $install_state['parameters']['profile'];
590
  if (!isset($profile) || !isset($install_state['profiles'][$profile])) {
591
    throw new Exception(install_no_profile_error());
592
  }
593
  $info = $install_state['profile_info'];
594

595 596
  // Get the list of available modules for the selected installation profile.
  $listing = new ExtensionDiscovery();
597
  $present_modules = array();
598
  foreach ($listing->scan('module') as $present_module) {
599
    $present_modules[] = $present_module->getName();
600 601
  }

602 603
  // The installation profile is also a module, which needs to be installed
  // after all the other dependencies have been installed.
604
  $present_modules[] = $profile;
605

606
  // Verify that all of the profile's required modules are present.
607
  $missing_modules = array_diff($info['dependencies'], $present_modules);
608 609

  $requirements = array();
610

611
  if (count($missing_modules)) {
612
    $modules = array();
613
    foreach ($missing_modules as $module) {
614
      $modules[] = '<span class="admin-missing">' . drupal_ucfirst($module) . '</span>';
Steven Wittens's avatar
Steven Wittens committed
615
    }
616
    $requirements['required_modules'] = array(
617 618
      'title'       => t('Required modules'),
      'value'       => t('Required modules not found.'),
619
      'severity'    => REQUIREMENT_ERROR,
620
      '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))),
621
    );
Steven Wittens's avatar
Steven Wittens committed
622
  }
623
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
624
}
625

626
/**
627
 * Installs the system module.
628 629 630
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
631 632 633 634
 *
 * @param array $install_state
 *   An array of information about the current installation state. This is used
 *   to set the default language.
635
 */
636
function drupal_install_system($install_state) {
637
  // Boot a new kernel into a regular production environment.
638 639 640 641 642
  $request = \Drupal::hasRequest() ? \Drupal::request() : FALSE;

  unset($GLOBALS['conf']['container_service_providers']['InstallerServiceProvider']);
  $kernel = new DrupalKernel('prod', drupal_classloader(), FALSE);
  $kernel->boot();
643

644 645 646
  if ($request) {
    $kernel->getContainer()->enterScope('request');
    $kernel->getContainer()->set('request', $request, 'request');
647
    $kernel->getContainer()->get('request_stack')->push($request);
648
  }
649

650 651
  // Install base system configuration.
  \Drupal::service('config.installer')->installDefaultConfig('core', 'core');
652

653 654
  // Install System module.
  \Drupal::moduleHandler()->install(array('system'), FALSE);
655

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

664
/**
665
 * Verifies the state of the specified file.
666 667 668 669 670 671 672
 *
 * @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.
673
 *
674
 * @return
675
 *   TRUE on success or FALSE on failure. A message is set for the latter.
676 677 678 679 680 681 682 683 684
 */
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)) {
685
    $check = 'is_' . $type;
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
    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;
}

/**
745
 * Creates a directory with the specified permissions.
746
 *
747
 * @param $file
748
 *  The name of the directory to create;
749
 * @param $mask
750 751 752
 *  The permissions of the directory to create.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
753
 *
754 755 756 757 758 759 760 761 762 763
 * @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:
764
          $mod |= 0444;
765 766
          break;
        case FILE_WRITABLE:
767
          $mod |= 0222;
768 769
          break;
        case FILE_EXECUTABLE:
770
          $mod |= 0111;
771 772 773 774 775
          break;
      }
    }
  }

776
  if (@drupal_mkdir($file, $mod)) {
777 778 779 780 781 782 783 784
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
785
 * Attempts to fix file permissions.
786
 *
787 788 789 790 791 792 793 794 795
 * 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.
 *
796 797 798 799 800 801
 * @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.
802
 *
803 804 805 806
 * @return
 *  TRUE/FALSE whether or not we were able to fix the file's permissions.
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
807 808 809 810 811
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

812
  $mod = fileperms($file) & 0777;
813
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
814 815 816 817 818

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

856 857
  // chmod() will work if the web server is running as owner of the file.
  if (@chmod($file, $mod)) {
858 859 860 861 862 863 864
    return TRUE;
  }
  else {
    return FALSE;
  }
}

865
/**
866
 * Sends the user to a different installer page.
867 868
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
869 870 871 872 873
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
874
  global $base_url;
875 876 877 878 879 880
  $headers = array(
    // Not a permanent redirect.
    'Cache-Control' => 'no-cache',
  );
  $response = new RedirectResponse($base_url . '/' . $path, 302, $headers);
  $response->send();
881 882
}

883 884 885 886 887 888 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
 *   through check_url() if it will be used as an HTML attribute value.
 *
 * @see drupal_requirements_url()
 */
function drupal_current_script_url($query = array()) {
  $uri = $_SERVER['SCRIPT_NAME'];
  $query = array_merge(drupal_get_query_parameters(), $query);
  if (!empty($query)) {
912
    $uri .= '?' . UrlHelper::buildQuery($query);
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
  }
  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
 *   not sanitized, so it still needs to be run through check_url() if it will
 *   be used as an HTML attribute value.
 *
 * @see drupal_current_script_url()
 */
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);
}

945
/**
946
 * Checks an installation profile's requirements.
947
 *
948
 * @param string $profile
949
 *   Name of installation profile to check.
950 951 952 953
 * @param array $install_state
 *   The current state in the install process.
 *
 * @return array
954
 *   Array of the installation profile's requirements.
955
 */
956
function drupal_check_profile($profile, array $install_state) {
957
  include_once __DIR__ . '/file.inc';
958

959
  if (!isset($profile) || !isset($install_state['profiles'][$profile])) {
960
    throw new Exception(install_no_profile_error());
961 962
  }

963
  $info = install_profile_info($profile);
964

965
  // Collect requirement testing results.
966
  $requirements = array();
967 968 969
  foreach ($info['dependencies'] as $module) {
    module_load_install($module);
    $function = $module . '_requirements';
970 971
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
972
    }
973 974 975 976 977
  }
  return $requirements;
}

/**
978
 * Extracts the highest severity from the requirements array.
979 980
 *
 * @param $requirements
981
 *   An array of requirements, in the same format as is returned by
982
 *   hook_requirements().
983
 *
984 985
 * @return
 *   The highest severity in the array.
986 987 988 989 990 991 992 993 994 995 996 997
 */
function drupal_requirements_severity(&$requirements) {
  $severity = REQUIREMENT_OK;
  foreach ($requirements as $requirement) {
    if (isset($requirement['severity'])) {
      $severity = max($severity, $requirement['severity']);
    }
  }
  return $severity;
}

/**
998
 * Checks a module's requirements.
999 1000 1001
 *
 * @param $module
 *   Machine name of module to check.
1002
 *
1003
 * @return
1004
 *   TRUE or FALSE, depending on whether the requirements are met.
1005 1006
 */
function drupal_check_module($module) {
1007
  module_load_install($module);
1008
  // Check requirements
1009
  $requirements = \Drupal::moduleHandler()->invoke($module, 'requirements', array('install'));
1010 1011 1012 1013 1014 1015 1016
  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) {
        $message = $requirement['description'];
        if (isset($requirement['value']) && $requirement['value']) {
          $message .= ' (' . t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) . ')';
1017
        }
1018
        drupal_set_message($message, 'error');
1019 1020
      }
    }
1021
    return FALSE;
1022 1023 1024
  }
  return TRUE;
}
1025 1026

/**
1027
 * Retrieves information about an installation profile from its .info.yml file.
1028
 *
1029 1030
 * The information stored in a profile .info.yml file is similar to that stored
 * in a normal Drupal module .info.yml file. For example:
1031
 * - name: The real name of the installation profile for display purposes.
1032
 * - description: A brief description of the profile.
1033 1034
 * - dependencies: An array of shortnames of other modules that this install
 *   profile requires.
1035
 *
1036 1037 1038
 * 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:
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
 *
 * - 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.
1052
 *
1053 1054 1055 1056
 * Note that this function does an expensive file system scan to get info file
 * information for dependencies. If you only need information from the info
 * file itself, use system_get_info().
 *
1057
 * Example of .info.yml file:
1058
 * @code
1059 1060
 *    name = Minimal
 *    description = Start fresh, with only a few modules enabled.
1061 1062
 *    dependencies[] = block
 *    dependencies[] = dblog
1063
 * @endcode
1064
 *
1065
 * @param $profile
1066
 *   Name of profile.
1067 1068
 * @param $langcode
 *   Language code (if any).
1069
 *
1070 1071
 * @return
 *   The info array.
1072
 */
1073
function install_profile_info($profile, $langcode = 'en') {
1074 1075 1076 1077 1078 1079
  $cache = &drupal_static(__FUNCTION__, array());

  if (!isset($cache[$profile])) {
    // Set defaults for module info.
    $defaults = array(
      'dependencies' => array(),
1080
      'themes' => array('stark'),
1081 1082
      'description' => '',
      'version' => NULL,
1083
      'hidden' => FALSE,
1084 1085
      'php' => DRUPAL_MINIMUM_PHP,
    );
1086
    $profile_file = drupal_get_path('profile', $profile) . "/$profile.info.yml";
1087
    $info = \Drupal::service('info_parser')->parse($profile_file);
1088
    $info += $defaults;
1089 1090

    // drupal_required_modules() includes the current profile as a dependency.
1091 1092 1093 1094 1095 1096
    // Remove that dependency, since a module cannot depend on itself.
    $required = array_diff(drupal_required_modules(), array($profile));

    $locale = !empty($langcode) && $langcode != 'en' ? array('locale') : array();

    $info['dependencies'] = array_unique(array_merge($required, $info['dependencies'], $locale));
1097

1098 1099 1100
    $cache[$profile] = $info;
  }
  return $cache[$profile];
1101 1102
}

1103 1104 1105 1106 1107
/**
 * Ensures the environment for a Drupal database on a predefined connection.
 *
 * This will run tasks that check that Drupal can perform all of the functions
 * on a database, that Drupal needs. Tasks include simple checks like CREATE
1108
 * TABLE to database specific functions like stored procedures and client
1109 1110 1111
 * encoding.
 */
function db_run_tasks($driver) {
1112
  db_installer_object($driver)->runTasks();
1113
  return TRUE;
1114
}
1115 1116 1117 1118 1119 1120

/**
 * Returns a database installer object.
 *
 * @param $driver
 *   The name of the driver.
1121 1122
 *
 * @return \Drupal\Core\Database\Install\Tasks
1123
 *   A class defining the requirements and tasks for installing the database.
1124 1125
 */
function db_installer_object($driver) {
1126 1127
  // We cannot use Database::getConnection->getDriverClass() here, because
  // the connection object is not yet functional.
1128
  $task_class = "Drupal\\Core\\Database\\Driver\\{$driver}\\Install\\Tasks";
1129 1130 1131 1132 1133 1134 1135
  if (class_exists($task_class)) {
    return new $task_class();
  }
  else {
    $task_class = "Drupal\\Driver\\Database\\{$driver}\\Install\\Tasks";
    return new $task_class();
  }
1136
}