install.inc 36.1 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\Core\Database\Database;
11
use Drupal\Core\DrupalKernel;
12

13 14 15
/**
 * Requirement severity -- Informational message only.
 */
16
const REQUIREMENT_INFO = -1;
17 18 19 20

/**
 * Requirement severity -- Requirement successfully met.
 */
21
const REQUIREMENT_OK = 0;
22 23 24 25

/**
 * Requirement severity -- Warning condition; proceed but flag warning.
 */
26
const REQUIREMENT_WARNING = 1;
27 28 29 30

/**
 * Requirement severity -- Error condition; abort installation.
 */
31
const REQUIREMENT_ERROR = 2;
32

33 34 35
/**
 * File permission check -- File exists.
 */
36
const FILE_EXIST = 1;
37 38 39 40

/**
 * File permission check -- File is readable.
 */
41
const FILE_READABLE = 2;
42 43 44 45

/**
 * File permission check -- File is writable.
 */
46
const FILE_WRITABLE = 4;
47 48 49 50

/**
 * File permission check -- File is executable.
 */
51
const FILE_EXECUTABLE = 8;
52 53 54 55

/**
 * File permission check -- File does not exist.
 */
56
const FILE_NOT_EXIST = 16;
57 58 59 60

/**
 * File permission check -- File is not readable.
 */
61
const FILE_NOT_READABLE = 32;
62 63 64 65

/**
 * File permission check -- File is not writable.
 */
66
const FILE_NOT_WRITABLE = 64;
67 68 69 70

/**
 * File permission check -- File is not executable.
 */
71
const FILE_NOT_EXECUTABLE = 128;
72

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

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

/**
109
 * Detects all supported databases that are compiled into PHP.
110 111 112 113 114
 *
 * @return
 *  An array of database types compiled into PHP.
 */
function drupal_detect_database_types() {
115 116 117 118 119 120 121 122 123 124
  $databases = drupal_get_database_types();

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

  return $databases;
}

/**
125
 * Returns all supported database installer objects that are compiled into PHP.
126 127 128 129 130
 *
 * @return
 *  An array of database installer objects compiled into PHP.
 */
function drupal_get_database_types() {
131
  $databases = array();
132
  $drivers = array();
133

134
  // We define a driver as a directory in /core/includes/database that in turn
135
  // contains a database.inc file. That allows us to drop in additional drivers
136
  // without modifying the installer.
137
  require_once __DIR__ . '/database.inc';
138 139 140 141 142 143 144 145
  // Allow any valid PHP identifier.
  // @see http://www.php.net/manual/en/language.variables.basics.php.
  $mask = '/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/';
  $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) {
146
    if (file_exists($file->uri . '/Install/Tasks.php')) {
147 148
      $drivers[$file->filename] = $file->uri;
    }
149 150
  }
  foreach ($drivers as $driver => $file) {
151
    $installer = db_installer_object($driver);
152
    if ($installer->installable()) {
153
      $databases[$driver] = $installer;
154 155
    }
  }
156

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

164 165 166
  return $databases;
}

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

306 307
    // Write the new settings file.
    if (file_put_contents(DRUPAL_ROOT . '/' . $settings_file, $buffer) === FALSE) {
308
      throw new Exception(t('Failed to modify %settings. Verify the file permissions.', array('%settings' => $settings_file)));
309 310 311
    }
  }
  else {
312
    throw new Exception(t('Failed to open %settings. Verify the file permissions.', array('%settings' => $settings_file)));
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
/**
 * 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.
 *
364
 * @param array|null $ref
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 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
 *   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.
 *
414
 * @param object $variable
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
 *   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;
}

433 434 435 436 437 438
/**
 * Creates the config directory and ensures it is operational.
 *
 * @see install_settings_form_submit()
 * @see update_prepare_d8_bootstrap()
 */
439
function drupal_install_config_directories() {
440
  global $config_directories;
441 442 443

  // Add a randomized config directory name to settings.php, unless it was
  // manually defined in the existing already.
444
  if (empty($config_directories)) {
445
    $config_directories_hash = Crypt::randomStringHashed(55);
446
    $settings['config_directories'] = array(
447 448 449
      CONFIG_ACTIVE_DIRECTORY => (object) array(
        'value' => conf_path() . '/files/config_' . $config_directories_hash . '/active',
        'required' => TRUE,
450
      ),
451 452 453
      CONFIG_STAGING_DIRECTORY => (object) array(
        'value' => conf_path() . '/files/config_' . $config_directories_hash . '/staging',
        'required' => TRUE,
454
      ),
455 456 457 458 459
    );
    // Rewrite settings.php, which also sets the value as global variable.
    drupal_rewrite_settings($settings);
  }

460
  // Ensure the config directories exist or can be created, and are writable.
461
  foreach (array(CONFIG_ACTIVE_DIRECTORY, CONFIG_STAGING_DIRECTORY) as $config_type) {
462 463 464 465 466 467
    // 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().
468
    if (!install_ensure_config_directory($config_type)) {
469
      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(
470 471 472 473
        '%directory' => config_get_config_directory($config_type),
        '@handbook_url' => 'http://drupal.org/server-permissions',
      )));
    }
474 475 476 477 478 479 480

    // 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:
481
        $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.';
482 483
        break;
      case CONFIG_STAGING_DIRECTORY:
484
        $text = 'This directory contains configuration to be imported into your Drupal site. To make this configuration active, see admin/config/development/configuration/sync.';
485 486 487 488
        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);
489 490 491
  }
}

492
/**
493
 * Checks whether a config directory exists and is writable.
494
 *
495
 * This partially duplicates install_ensure_config_directory(), but is required
496 497
 * since the installer would create the config directory too early in the
 * installation process otherwise (e.g., when only visiting install.php when
498 499
 * there is a settings.php already, but not actually executing the
 * installation).
500 501 502 503 504 505 506 507 508 509 510 511 512
 *
 * @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;
  }
513 514 515 516 517 518 519 520 521 522
  // 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) {
523 524 525 526
  }
  return FALSE;
}

527 528
/**
 * Ensures that the config directory exists and is writable, or can be made so.
529 530 531 532 533 534 535
 *
 * @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.
536
 */
537
function install_ensure_config_directory($type) {
538
  // The config directory must be defined in settings.php.
539 540
  global $config_directories;
  if (!isset($config_directories[$type])) {
541 542 543 544 545
    return FALSE;
  }
  // The logic here is similar to that used by system_requirements() for other
  // directories that the installer creates.
  else {
546
    $config_directory = config_get_config_directory($type);
547
    return file_prepare_directory($config_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
548 549 550
  }
}

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

564 565
  $profile = $install_state['parameters']['profile'];
  $profile_file = $install_state['profiles'][$profile]->uri;
566 567

  if (!isset($profile) || !file_exists($profile_file)) {
568
    throw new Exception(install_no_profile_error());
569
  }
570
  $info = $install_state['profile_info'];
571

572 573
  // Get a list of modules that exist in Drupal's assorted subdirectories.
  $present_modules = array();
574
  foreach (drupal_system_listing('/^' . DRUPAL_PHP_FUNCTION_PATTERN . '\.module$/', 'modules') as $present_module) {
575 576 577
    $present_modules[] = $present_module->name;
  }

578 579
  // The installation profile is also a module, which needs to be installed
  // after all the other dependencies have been installed.
580 581
  $present_modules[] = drupal_get_profile();

582
  // Verify that all of the profile's required modules are present.
583
  $missing_modules = array_diff($info['dependencies'], $present_modules);
584 585

  $requirements = array();
586

587
  if (count($missing_modules)) {
588
    $modules = array();
589
    foreach ($missing_modules as $module) {
590
      $modules[] = '<span class="admin-missing">' . drupal_ucfirst($module) . '</span>';
Steven Wittens's avatar
Steven Wittens committed
591
    }
592
    $requirements['required_modules'] = array(
593 594
      'title'       => t('Required modules'),
      'value'       => t('Required modules not found.'),
595
      'severity'    => REQUIREMENT_ERROR,
596
      '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))),
597
    );
Steven Wittens's avatar
Steven Wittens committed
598
  }
599
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
600
}
601

602
/**
603
 * Installs the system module.
604 605 606 607 608
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
 */
function drupal_install_system() {
609 610
  // Create tables.
  drupal_install_schema('system');
611

612 613 614 615 616 617 618
  if (!\Drupal::getContainer()->has('kernel')) {
    // Immediately boot a kernel to have real services ready. If there's already
    // an initialized request object in the pre-kernel container, persist it in
    // the post-kernel container.
    if (\Drupal::getContainer()->initialized('request')) {
      $request = \Drupal::request();
    }
619
    $kernel = new DrupalKernel('install', drupal_classloader(), FALSE);
620
    $kernel->boot();
621 622 623 624
    if (isset($request)) {
      \Drupal::getContainer()->set('request', $request);
    }

625
  }
626

627
  $system_path = drupal_get_path('module', 'system');
628
  require_once DRUPAL_ROOT . '/' . $system_path . '/system.install';
Steven Wittens's avatar
Steven Wittens committed
629 630
  $system_versions = drupal_get_schema_versions('system');
  $system_version = $system_versions ? max($system_versions) : SCHEMA_INSTALLED;
631
  \Drupal::keyValue('system.schema')->set('system', $system_version);
632 633

  // System module needs to be enabled and the system/module lists need to be
634 635
  // reset first in order to allow installation of default configuration to
  // invoke config import callbacks.
636
  // @todo Installation profiles may override the system.module config object.
637
  \Drupal::config('system.module')
638 639 640
    ->set('enabled.system', 0)
    ->save();

641
  // Update the module list to include it.
642
  \Drupal::moduleHandler()->setModuleList(array('system' => $system_path . '/system.module'));
643

644
  \Drupal::service('config.installer')->installDefaultConfig('module', 'system');
645 646

  module_invoke('system', 'install');
647 648
}

649
/**
650
 * Verifies the state of the specified file.
651 652 653 654 655 656 657
 *
 * @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.
658
 *
659
 * @return
660
 *   TRUE on success or FALSE on failure. A message is set for the latter.
661 662 663 664 665 666 667 668 669
 */
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)) {
670
    $check = 'is_' . $type;
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
    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;
}

/**
730
 * Creates a directory with the specified permissions.
731
 *
732
 * @param $file
733
 *  The name of the directory to create;
734
 * @param $mask
735 736 737
 *  The permissions of the directory to create.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
738
 *
739 740 741 742 743 744 745 746 747 748
 * @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:
749
          $mod |= 0444;
750 751
          break;
        case FILE_WRITABLE:
752
          $mod |= 0222;
753 754
          break;
        case FILE_EXECUTABLE:
755
          $mod |= 0111;
756 757 758 759 760
          break;
      }
    }
  }

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

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

797
  $mod = fileperms($file) & 0777;
798
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
799 800 801 802 803

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

841 842 843 844
  // chmod() will work if the web server is running as owner of the file.
  // If PHP safe_mode is enabled the currently executing script must also
  // have the same owner.
  if (@chmod($file, $mod)) {
845 846 847 848 849 850 851
    return TRUE;
  }
  else {
    return FALSE;
  }
}

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

870 871 872 873 874 875 876 877 878 879 880 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 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
/**
 * 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)) {
    $uri .= '?' . drupal_http_build_query($query);
  }
  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);
}

932
/**
933
 * Checks an installation profile's requirements.
934
 *
935
 * @param string $profile
936
 *   Name of installation profile to check.
937 938 939 940
 * @param array $install_state
 *   The current state in the install process.
 *
 * @return array
941
 *   Array of the installation profile's requirements.
942
 */
943
function drupal_check_profile($profile, array $install_state) {
944
  include_once __DIR__ . '/file.inc';
945

946
  $profile_file = $install_state['profiles'][$profile]->uri;
947 948

  if (!isset($profile) || !file_exists($profile_file)) {
949
    throw new Exception(install_no_profile_error());
950 951
  }

952
  $info = install_profile_info($profile);
953

954
  // Collect requirement testing results.
955
  $requirements = array();
956 957 958
  foreach ($info['dependencies'] as $module) {
    module_load_install($module);
    $function = $module . '_requirements';
959 960
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
961
    }
962 963 964 965 966
  }
  return $requirements;
}

/**
967
 * Extracts the highest severity from the requirements array.
968 969
 *
 * @param $requirements
970
 *   An array of requirements, in the same format as is returned by
971
 *   hook_requirements().
972
 *
973 974
 * @return
 *   The highest severity in the array.
975 976 977 978 979 980 981 982 983 984 985 986
 */
function drupal_requirements_severity(&$requirements) {
  $severity = REQUIREMENT_OK;
  foreach ($requirements as $requirement) {
    if (isset($requirement['severity'])) {
      $severity = max($severity, $requirement['severity']);
    }
  }
  return $severity;
}

/**
987
 * Checks a module's requirements.
988 989 990
 *
 * @param $module
 *   Machine name of module to check.
991
 *
992
 * @return
993
 *   TRUE or FALSE, depending on whether the requirements are met.
994 995
 */
function drupal_check_module($module) {
996
  module_load_install($module);
997 998 999 1000 1001 1002 1003 1004 1005
  // Check requirements
  $requirements = module_invoke($module, 'requirements', 'install');
  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'])) . ')';
1006
        }
1007
        drupal_set_message($message, 'error');
1008 1009
      }
    }
1010
    return FALSE;
1011 1012 1013
  }
  return TRUE;
}
1014 1015

/**
1016
 * Retrieves information about an installation profile from its .info.yml file.
1017
 *
1018 1019
 * The information stored in a profile .info.yml file is similar to that stored
 * in a normal Drupal module .info.yml file. For example:
1020
 * - name: The real name of the installation profile for display purposes.
1021
 * - description: A brief description of the profile.
1022 1023
 * - dependencies: An array of shortnames of other modules that this install
 *   profile requires.
1024
 *
1025 1026 1027
 * 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:
1028 1029 1030
 * - distribution_name: The name of the Drupal distribution that is being
 *   installed, to be shown throughout the installation process. Defaults to
 *   'Drupal'.
1031 1032 1033 1034 1035 1036
 * - exclusive: If the install profile is intended to be the only eligible
 *   choice in a distribution, setting exclusive = TRUE will auto-select it
 *   during installation, and the install profile selection screen will be
 *   skipped. If more than one profile is found where exclusive = TRUE then
 *   this property will have no effect and the profile selection screen will
 *   be shown as normal with all available profiles shown.
1037
 *
1038 1039 1040 1041
 * 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().
 *
1042
 * Example of .info.yml file:
1043
 * @code
1044 1045
 *    name = Minimal
 *    description = Start fresh, with only a few modules enabled.