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

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

8
use Drupal\Component\Utility\Crypt;
9
use Drupal\Core\Database\Database;
10
use Drupal\Core\DrupalKernel;
11 12
use Drupal\Core\StringTranslation\TranslationManager;
use Drupal\Core\StringTranslation\Translator\CustomStrings;
13

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $databases;
}

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

135
  // We define a driver as a directory in /core/includes/database that in turn
136
  // contains a database.inc file. That allows us to drop in additional drivers
137
  // without modifying the installer.
138
  require_once __DIR__ . '/database.inc';
139 140 141 142 143 144 145 146
  // 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) {
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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
 *   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(
 *     CONFIG_ACTIVE_DIRECTORY => array(
 *       'path' => (object) array(
 *         'value' => 'config__hash/active'
 *         'required' => TRUE,
 *       ),
 *     ),
 *     CONFIG_STAGING_DIRECTORY => array(
 *       'path' => (object) array(
 *         'value' => 'config_hash/staging',
 *         'required' => TRUE,
 *       ),
 *     ),
 *   );
 *   @endcode
 *   gets dumped as:
 *   @code
 *   $config_directories['active']['path'] = 'config__hash/active';
 *   $config_directories['staging']['path'] = 'config__hash/staging'
 *   @endcode
200
 */
201 202 203 204
function drupal_rewrite_settings($settings = array(), $settings_file = NULL) {
  if (!isset($settings_file)) {
    $settings_file = conf_path(FALSE) . '/settings.php';
  }
205
  // Build list of setting names and insert the values into the global namespace.
206
  $variable_names = array();
207
  foreach ($settings as $setting => $data) {
208 209
    _drupal_rewrite_settings_global($GLOBALS[$setting], $data);
    $variable_names['$'. $setting] = $setting;
210
  }
211 212 213 214
  $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.
215 216
    $buffer = '';
    $state = 'default';
217
    foreach (token_get_all($contents) as $token) {
218 219
      if (is_array($token)) {
        list($type, $value) = $token;
220
      }
221
      else {
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 298 299 300 301 302
        $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;
303 304
        }
      }
305
      $buffer .= $value;
306
    }
307 308
    foreach ($settings as $name => $setting) {
      $buffer .= _drupal_rewrite_settings_dump($setting, '$' . $name);
309 310
    }

311 312
    // Write the new settings file.
    if (file_put_contents(DRUPAL_ROOT . '/' . $settings_file, $buffer) === FALSE) {
313
      throw new Exception(st('Failed to modify %settings. Verify the file permissions.', array('%settings' => $settings_file)));
314 315 316
    }
  }
  else {
317
    throw new Exception(st('Failed to open %settings. Verify the file permissions.', array('%settings' => $settings_file)));
318 319 320
  }
}

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 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 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
/**
 * 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.
 *
 * @param array|NULL $ref
 *   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.
 *
 * @param stdClass $variable
 *   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;
}

438 439 440 441 442 443
/**
 * Creates the config directory and ensures it is operational.
 *
 * @see install_settings_form_submit()
 * @see update_prepare_d8_bootstrap()
 */
444 445
function drupal_install_config_directories() {
  global $config_directories;
446 447 448

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

469
  // Ensure the config directories exist or can be created, and are writable.
470
  foreach (array(CONFIG_ACTIVE_DIRECTORY, CONFIG_STAGING_DIRECTORY) as $config_type) {
471 472 473 474 475 476
    // 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().
477 478 479 480 481 482
    if (!install_ensure_config_directory($config_type)) {
      throw new Exception(st('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(
        '%directory' => config_get_config_directory($config_type),
        '@handbook_url' => 'http://drupal.org/server-permissions',
      )));
    }
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497

    // 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:
        $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/sync on the target server.';
        break;
      case CONFIG_STAGING_DIRECTORY:
        $text = 'This directory contains configuration to be imported into your Drupal site. To make this configuration active, see admin/config/development/sync.';
        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);
498 499 500
  }
}

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

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

560
/**
561
 * Verifies that all dependencies are met for a given installation profile.
562
 *
563 564
 * @param $install_state
 *   An array of information about the current installation state.
565
 *
Steven Wittens's avatar
Steven Wittens committed
566 567
 * @return
 *   The list of modules to install.
568
 */
569
function drupal_verify_profile($install_state) {
570 571
  include_once __DIR__ . '/file.inc';
  include_once __DIR__ . '/common.inc';
572

573 574
  $profile = $install_state['parameters']['profile'];
  $profile_file = $install_state['profiles'][$profile]->uri;
575 576

  if (!isset($profile) || !file_exists($profile_file)) {
577
    throw new Exception(install_no_profile_error());
578
  }
579
  $info = $install_state['profile_info'];
580

581 582
  // Get a list of modules that exist in Drupal's assorted subdirectories.
  $present_modules = array();
583
  foreach (drupal_system_listing('/^' . DRUPAL_PHP_FUNCTION_PATTERN . '\.module$/', 'modules') as $present_module) {
584 585 586
    $present_modules[] = $present_module->name;
  }

587 588
  // The installation profile is also a module, which needs to be installed
  // after all the other dependencies have been installed.
589 590
  $present_modules[] = drupal_get_profile();

591
  // Verify that all of the profile's required modules are present.
592
  $missing_modules = array_diff($info['dependencies'], $present_modules);
593 594

  $requirements = array();
595

596
  if (count($missing_modules)) {
597
    $modules = array();
598
    foreach ($missing_modules as $module) {
599
      $modules[] = '<span class="admin-missing">' . drupal_ucfirst($module) . '</span>';
Steven Wittens's avatar
Steven Wittens committed
600
    }
601 602 603 604
    $requirements['required_modules'] = array(
      'title'       => st('Required modules'),
      'value'       => st('Required modules not found.'),
      'severity'    => REQUIREMENT_ERROR,
605
      'description' => st('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))),
606
    );
Steven Wittens's avatar
Steven Wittens committed
607
  }
608
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
609
}
610

611
/**
612
 * Installs the system module.
613 614 615 616 617
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
 */
function drupal_install_system() {
618 619
  // Create tables.
  drupal_install_schema('system');
620

621
  if (!drupal_container()->has('kernel')) {
622 623 624 625
    // Immediately boot a kernel to have real services ready.
    $kernel = new DrupalKernel('install', FALSE, drupal_classloader(), FALSE);
    $kernel->boot();
  }
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 634 635 636 637 638 639 640

  // System module needs to be enabled and the system/module lists need to be
  // reset first in order to allow config_install_default_config() to invoke
  // config import callbacks.
  // @todo Installation profiles may override the system.module config object.
  config('system.module')
    ->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
  config_install_default_config('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
  include_once __DIR__ . '/common.inc';
863
  header('Location: ' . $base_url . '/' . $path);
864
  header('Cache-Control: no-cache'); // Not a permanent redirect.
865
  drupal_exit();
866 867
}

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
/**
 * 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);
}

930
/**
931
 * Translates a string when some systems are not available.
932 933
 *
 * Used during the install process, when database, theme, and localization
934
 * system is possibly not yet available.
935
 *
936 937 938 939
 * Use t() if your code will never run during the Drupal installation phase.
 * Use st() if your code will only run during installation and never any other
 * time. Use get_t() if your code could run in either circumstance.
 *
940
 * @see t()
941
 * @see get_t()
942
 * @ingroup sanitization
943
 */
944
function st($string, array $args = array(), array $options = array()) {
945
  global $install_state;
946 947 948 949 950 951 952 953 954 955 956 957 958 959
  static $install_translation;

  // This may be invoked before the container has been initialized.
  $container = Drupal::getContainer();
  if ($container && $container->has('translation')) {
    // Since the container is properly initialized, we can use standard translation.
    return t($string, $args, $options);
  }
  elseif (drupal_installation_attempted() && isset($install_state['parameters']['langcode'])) {
    // The translation service is not there yet, use a temporary one.
    if (!isset($install_translation)) {
      $install_translation = new TranslationManager();
      foreach (array(new CustomStrings(), install_file_translation_service()) as $translator) {
        $install_translation->addTranslator($translator);
960
      }
961
      $install_translation->setDefaultLangcode($install_state['parameters']['langcode']);
962
    }
963
    return $install_translation->translate($string, $args, $options);
drumm's avatar
drumm committed
964
  }
965 966
  // Just return an untraslated string.
  return format_string($string, $args);
967
}
968 969

/**
970
 * Checks an installation profile's requirements.
971
 *
972
 * @param string $profile
973
 *   Name of installation profile to check.
974 975 976 977
 * @param array $install_state
 *   The current state in the install process.
 *
 * @return array
978
 *   Array of the installation profile's requirements.
979
 */
980
function drupal_check_profile($profile, array $install_state) {
981
  include_once __DIR__ . '/file.inc';
982

983
  $profile_file = $install_state['profiles'][$profile]->uri;
984 985

  if (!isset($profile) || !file_exists($profile_file)) {
986
    throw new Exception(install_no_profile_error());
987 988
  }

989
  $info = install_profile_info($profile);
990

991
  // Collect requirement testing results.
992
  $requirements = array();
993 994 995
  foreach ($info['dependencies'] as $module) {
    module_load_install($module);
    $function = $module . '_requirements';
996 997
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
998
    }
999 1000 1001 1002 1003
  }
  return $requirements;
}

/**
1004
 * Extracts the highest severity from the requirements array.
1005 1006
 *
 * @param $requirements
1007
 *   An array of requirements, in the same format as is returned by
1008
 *   hook_requirements().
1009
 *
1010 1011
 * @return
 *   The highest severity in the array.
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
 */
function drupal_requirements_severity(&$requirements) {
  $severity = REQUIREMENT_OK;
  foreach ($requirements as $requirement) {
    if (isset($requirement['severity'])) {
      $severity = max($severity, $requirement['severity']);
    }
  }
  return $severity;
}

/**
1024
 * Checks a module's requirements.
1025 1026 1027
 *
 * @param $module
 *   Machine name of module to check.
1028
 *
1029
 * @return
1030
 *   TRUE or FALSE, depending on whether the requirements are met.
1031 1032
 */
function drupal_check_module($module) {
1033 1034
  module_load_install($module);
  if (module_hook($module, 'requirements')) {
1035 1036 1037 1038 1039 1040
    // 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) {
1041 1042
          $message = $requirement['description'];
          if (isset($requirement['value']) && $requirement['value']) {
1043
            $message .= ' (' . t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) . ')';
1044 1045
          }
          drupal_set_message($message, 'error');
1046 1047 1048 1049 1050 1051 1052
        }
      }
      return FALSE;
    }
  }
  return TRUE;
}
1053 1054

/**
1055
 * Retrieves information about an installation profile from its .info.yml file.
1056
 *
1057 1058
 * The information stored in a profile .info.yml file is similar to that stored
 * in a normal Drupal module .info.yml file. For example:
1059
 * - name: The real name of the installation profile for display purposes.
1060
 * - description: A brief description of the profile.
1061 1062
 * - dependencies: An array of shortnames of other modules that this install
 *   profile requires.
1063
 *
1064 1065 1066
 * 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:
1067 1068 1069
 * - distribution_name: The name of the Drupal distribution that is being
 *   installed, to be shown throughout the installation process. Defaults to
 *   'Drupal'.
1070 1071 1072 1073 1074 1075
 * - 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.
1076
 *
1077 1078 1079 1080
 * 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().
 *