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

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

8
use Drupal\Core\Database\Database;
9
use Drupal\locale\Gettext;
10

11 12 13
/**
 * Indicates that a module has not been installed yet.
 */
14
const SCHEMA_UNINSTALLED = -1;
15 16 17 18

/**
 * Indicates that a module has been installed.
 */
19
const SCHEMA_INSTALLED = 0;
20

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

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

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

/**
 * Requirement severity -- Error condition; abort installation.
 */
39
const REQUIREMENT_ERROR = 2;
40

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

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

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

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

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

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

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

/**
 * File permission check -- File is not executable.
 */
79
const FILE_NOT_EXECUTABLE = 128;
80

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

92
/**
93
 * Loads the install profile, extracting its defined distribution name.
94 95
 *
 * @return
96 97 98 99
 *   The distribution name defined in the profile's .info file. Defaults to
 *   "Drupal" if none is explicitly provided by the install profile.
 *
 * @see install_profile_info()
100
 */
101
function drupal_install_profile_distribution_name() {
102 103 104 105 106 107 108 109 110
  // 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();
111
    $info = system_get_info('module', $profile);
112 113
    return $info['distribution_name'];
  }
114 115 116
}

/**
117
 * Detects the base URL using the PHP $_SERVER variables.
118 119 120 121
 *
 * @param $file
 *   The name of the file calling this function so we can strip it out of
 *   the URI when generating the base_url.
122
 *
123 124 125
 * @return
 *   The auto-detected $base_url that should be configured in settings.php
 */
126
function drupal_detect_baseurl($file = 'core/install.php') {
127 128
  $proto = $_SERVER['HTTPS'] ? 'https://' : 'http://';
  $host = $_SERVER['SERVER_NAME'];
129
  $port = ($_SERVER['SERVER_PORT'] == 80 ? '' : ':' . $_SERVER['SERVER_PORT']);
130
  $dir = str_replace("/$file", '', $_SERVER['SCRIPT_NAME']);
131 132 133 134 135

  return "$proto$host$port$dir";
}

/**
136
 * Detects all supported databases that are compiled into PHP.
137 138 139 140 141
 *
 * @return
 *  An array of database types compiled into PHP.
 */
function drupal_detect_database_types() {
142 143 144 145 146 147 148 149 150 151
  $databases = drupal_get_database_types();

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

  return $databases;
}

/**
152
 * Returns all supported database installer objects that are compiled into PHP.
153 154 155 156 157
 *
 * @return
 *  An array of database installer objects compiled into PHP.
 */
function drupal_get_database_types() {
158
  $databases = array();
159
  $drivers = array();
160

161
  // We define a driver as a directory in /core/includes/database that in turn
162
  // contains a database.inc file. That allows us to drop in additional drivers
163
  // without modifying the installer.
164
  require_once DRUPAL_ROOT . '/core/includes/database.inc';
165
  foreach (file_scan_directory(DRUPAL_ROOT . '/core/lib/Drupal/Core/Database/Driver', '/^[a-z]*$/i', array('recurse' => FALSE)) as $file) {
166
    if (file_exists($file->uri . '/Install/Tasks.php')) {
167 168
      $drivers[$file->filename] = $file->uri;
    }
169 170 171
  }

  foreach ($drivers as $driver => $file) {
172
    $installer = db_installer_object($driver);
173
    if ($installer->installable()) {
174
      $databases[$driver] = $installer;
175 176
    }
  }
177

178
  // Usability: unconditionally put the MySQL driver on top.
179 180 181 182 183
  if (isset($databases['mysql'])) {
    $mysql_database = $databases['mysql'];
    unset($databases['mysql']);
    $databases = array('mysql' => $mysql_database) + $databases;
  }
184

185 186 187
  return $databases;
}

188
/**
189
 * Replaces values in settings.php with values in the submitted array.
190 191 192 193
 *
 * @param $settings
 *   An array of settings that need to be updated.
 */
194
function drupal_rewrite_settings($settings = array()) {
195
  drupal_static_reset('conf_path');
196
  $settings_file = conf_path(FALSE) . '/settings.php';
197 198 199 200 201 202 203 204 205

  // Build list of setting names and insert the values into the global namespace.
  $keys = array();
  foreach ($settings as $setting => $data) {
    $GLOBALS[$setting] = $data['value'];
    $keys[] = $setting;
  }

  $buffer = NULL;
206 207 208 209 210 211 212 213 214 215 216 217 218 219
  $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.
    $replacing_variable = FALSE;
    foreach (token_get_all($contents) as $token) {
      // Strip off the leading "$" before comparing the variable name.
      if (is_array($token) && $token[0] == T_VARIABLE && ($variable_name = substr($token[1], 1)) && in_array($variable_name, $keys)) {
        // Write the new value to settings.php in the following format:
        //    $[setting] = '[value]'; // [comment]
        $setting = $settings[$variable_name];
        $buffer .= '$' . $variable_name . ' = ' . var_export($setting['value'], TRUE) . ';';
        if (!empty($setting['comment'])) {
          $buffer .= ' // ' . $setting['comment'];
220
        }
221 222
        unset($settings[$variable_name]);
        $replacing_variable = TRUE;
223
      }
224 225 226 227 228
      else {
        // Write a regular token (that is not part of a variable we're
        // replacing) to settings.php directly.
        if (!$replacing_variable) {
          $buffer .= is_array($token) ? $token[1] : $token;
229
        }
230 231 232 233
        // When we hit a semicolon, we are done with the code that defines the
        // variable that is being replaced.
        if ($token == ';') {
          $replacing_variable = FALSE;
234 235 236 237 238 239
        }
      }
    }

    // Add required settings that were missing from settings.php.
    foreach ($settings as $setting => $data) {
240
      if (!empty($data['required'])) {
241
        $buffer .= "\$$setting = " . var_export($data['value'], TRUE) . ";\n";
242 243 244
      }
    }

245 246
    // Write the new settings file.
    if (file_put_contents(DRUPAL_ROOT . '/' . $settings_file, $buffer) === FALSE) {
247
      throw new Exception(st('Failed to modify %settings. Verify the file permissions.', array('%settings' => $settings_file)));
248 249 250
    }
  }
  else {
251
    throw new Exception(st('Failed to open %settings. Verify the file permissions.', array('%settings' => $settings_file)));
252 253 254
  }
}

255 256 257 258 259 260
/**
 * Creates the config directory and ensures it is operational.
 *
 * @see install_settings_form_submit()
 * @see update_prepare_d8_bootstrap()
 */
261 262
function drupal_install_config_directories() {
  global $config_directories;
263 264 265

  // Add a randomized config directory name to settings.php, unless it was
  // manually defined in the existing already.
266 267 268
  if (empty($config_directories)) {
    $settings['config_directories'] = array(
      'value' => array(
269 270 271 272 273 274
        CONFIG_ACTIVE_DIRECTORY => array(
          'path' => 'config/active_' . drupal_hash_base64(drupal_random_bytes(55)),
        ),
        CONFIG_STAGING_DIRECTORY => array(
          'path' => 'config/staging_' . drupal_hash_base64(drupal_random_bytes(55)),
        ),
275
      ),
276 277 278 279 280 281
      'required' => TRUE,
    );
    // Rewrite settings.php, which also sets the value as global variable.
    drupal_rewrite_settings($settings);
  }

282
  // Ensure the config directories exist or can be created, and are writable.
283
  foreach (array(CONFIG_ACTIVE_DIRECTORY, CONFIG_STAGING_DIRECTORY) as $config_type) {
284 285 286 287 288 289
    // 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().
290 291 292 293 294 295
    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',
      )));
    }
296 297 298
  }
}

299 300 301 302
/**
 * Checks whether a config directory name is defined, and if so, whether it
 * exists and is writable.
 *
303
 * This partially duplicates install_ensure_config_directory(), but is required
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
 * since the installer would create the config directory too early in the
 * installation process otherwise (e.g., when only visiting install.php when
 * there is a settings.php already, but not actually executing the installation).
 *
 * @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;
  }
320 321 322 323 324 325 326 327 328 329
  // 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) {
330 331 332 333
  }
  return FALSE;
}

334 335
/**
 * Ensures that the config directory exists and is writable, or can be made so.
336 337 338 339 340 341 342
 *
 * @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.
343
 */
344
function install_ensure_config_directory($type) {
345
  // The config directory must be defined in settings.php.
346 347
  global $config_directories;
  if (!isset($config_directories[$type])) {
348 349 350 351 352
    return FALSE;
  }
  // The logic here is similar to that used by system_requirements() for other
  // directories that the installer creates.
  else {
353
    $config_directory = config_get_config_directory($type);
354 355 356 357
    return file_prepare_directory($config_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
  }
}

358
/**
359
 * Verifies an install profile for installation.
360
 *
361 362
 * @param $install_state
 *   An array of information about the current installation state.
363
 *
Steven Wittens's avatar
Steven Wittens committed
364 365
 * @return
 *   The list of modules to install.
366
 */
367
function drupal_verify_profile($install_state) {
368 369
  include_once DRUPAL_ROOT . '/core/includes/file.inc';
  include_once DRUPAL_ROOT . '/core/includes/common.inc';
370

371 372
  $profile = $install_state['parameters']['profile'];
  $profile_file = $install_state['profiles'][$profile]->uri;
373 374

  if (!isset($profile) || !file_exists($profile_file)) {
375
    throw new Exception(install_no_profile_error());
376
  }
377
  $info = $install_state['profile_info'];
378

379 380
  // Get a list of modules that exist in Drupal's assorted subdirectories.
  $present_modules = array();
381
  foreach (drupal_system_listing('/^' . DRUPAL_PHP_FUNCTION_PATTERN . '\.module$/', 'modules', 'name', 0) as $present_module) {
382 383 384
    $present_modules[] = $present_module->name;
  }

385 386 387 388
  // The install profile is also a module, which needs to be installed after all the other dependencies
  // have been installed.
  $present_modules[] = drupal_get_profile();

389
  // Verify that all of the profile's required modules are present.
390
  $missing_modules = array_diff($info['dependencies'], $present_modules);
391 392

  $requirements = array();
393

394
  if (count($missing_modules)) {
395
    $modules = array();
396
    foreach ($missing_modules as $module) {
397
      $modules[] = '<span class="admin-missing">' . drupal_ucfirst($module) . '</span>';
Steven Wittens's avatar
Steven Wittens committed
398
    }
399 400 401 402
    $requirements['required_modules'] = array(
      'title'       => st('Required modules'),
      'value'       => st('Required modules not found.'),
      'severity'    => REQUIREMENT_ERROR,
403
      '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))),
404
    );
Steven Wittens's avatar
Steven Wittens committed
405
  }
406
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
407
}
408

409
/**
410
 * Installs the system module.
411 412 413 414 415
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
 */
function drupal_install_system() {
416 417 418
  // Create tables.
  drupal_install_schema('system');

419
  $system_path = drupal_get_path('module', 'system');
420
  require_once DRUPAL_ROOT . '/' . $system_path . '/system.install';
Steven Wittens's avatar
Steven Wittens committed
421 422
  $system_versions = drupal_get_schema_versions('system');
  $system_version = $system_versions ? max($system_versions) : SCHEMA_INSTALLED;
423
  db_insert('system')
424
    ->fields(array('filename', 'name', 'type', 'owner', 'status', 'schema_version', 'bootstrap'))
425 426 427 428 429 430
    ->values(array(
        'filename' => $system_path . '/system.module',
        'name' => 'system',
        'type' => 'module',
        'owner' => '',
        'status' => 1,
431 432 433
        'schema_version' => $system_version,
        'bootstrap' => 0,
      ))
434
    ->execute();
435 436 437

  // Clear out module list and hook implementation statics before calling
  // system_rebuild_theme_data().
438
  system_list_reset();
439 440 441
  module_list_reset();
  module_implements_reset();

442
  system_rebuild_module_data();
443 444
  system_rebuild_theme_data();

445
  config_install_default_config('module', 'system');
446 447

  module_invoke('system', 'install');
448 449
}

450
/**
451
 * Verifies the state of the specified file.
452 453 454 455 456 457 458
 *
 * @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.
459
 *
460
 * @return
461
 *   TRUE on success or FALSE on failure. A message is set for the latter.
462 463 464 465 466 467 468 469 470
 */
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)) {
471
    $check = 'is_' . $type;
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
    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;
}

/**
531
 * Creates a directory with the specified permissions.
532
 *
533
 * @param $file
534
 *  The name of the directory to create;
535
 * @param $mask
536 537 538
 *  The permissions of the directory to create.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
539
 *
540 541 542 543 544 545 546 547 548 549
 * @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:
550
          $mod |= 0444;
551 552
          break;
        case FILE_WRITABLE:
553
          $mod |= 0222;
554 555
          break;
        case FILE_EXECUTABLE:
556
          $mod |= 0111;
557 558 559 560 561
          break;
      }
    }
  }

562
  if (@drupal_mkdir($file, $mod)) {
563 564 565 566 567 568 569 570
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
571
 * Attempts to fix file permissions.
572
 *
573 574 575 576 577 578 579 580 581
 * 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.
 *
582 583 584 585 586 587
 * @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.
588
 *
589 590 591 592
 * @return
 *  TRUE/FALSE whether or not we were able to fix the file's permissions.
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
593 594 595 596 597
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

598
  $mod = fileperms($file) & 0777;
599
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
600 601 602 603 604

  // 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.
605 606 607 608 609
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
610
            $mod |= 0444;
611 612 613 614
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
615
            $mod |= 0222;
616 617 618 619
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
620
            $mod |= 0111;
621 622 623 624
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
625
            $mod &= ~0444;
626 627 628 629
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
630
            $mod &= ~0222;
631 632 633 634
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
635
            $mod &= ~0111;
636 637 638 639 640 641
          }
          break;
      }
    }
  }

642 643 644 645
  // 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)) {
646 647 648 649 650 651 652
    return TRUE;
  }
  else {
    return FALSE;
  }
}

653
/**
654
 * Sends the user to a different installer page.
655 656
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
657 658 659 660 661
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
662
  global $base_url;
663
  include_once DRUPAL_ROOT . '/core/includes/common.inc';
664
  header('Location: ' . $base_url . '/' . $path);
665
  header('Cache-Control: no-cache'); // Not a permanent redirect.
666
  drupal_exit();
667 668
}

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

731
/**
732
 * Translates a string when some systems are not available.
733 734
 *
 * Used during the install process, when database, theme, and localization
735
 * system is possibly not yet available.
736
 *
737 738 739 740
 * 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.
 *
741
 * @see t()
742
 * @see get_t()
743
 * @ingroup sanitization
744
 */
745
function st($string, array $args = array(), array $options = array()) {
746
  static $strings = NULL;
747
  global $install_state;
drumm's avatar
drumm committed
748

749 750 751 752
  if (empty($options['context'])) {
    $options['context'] = '';
  }

753 754
  if (!isset($strings)) {
    $strings = array();
755
    if (isset($install_state['parameters']['langcode'])) {
756 757
      // If the given langcode was selected, there should be at least one .po
      // file with its name in the pattern drupal-$version.$langcode.po.
758
      // This might or might not be the entire filename. It is also possible
759
      // that multiple files end with the same suffix, even if unlikely.
760 761
      $files = install_find_translation_files($install_state['parameters']['langcode']);
      if (!empty($files)) {
762 763 764
        // Register locale classes with the classloader. Locale module is not
        // yet enabled at this stage, so this is not happening automatically.
        drupal_classloader_register('locale', drupal_get_path('module', 'locale'));
765
        $strings = Gettext::filesToArray($install_state['parameters']['langcode'], $files);
766
      }
767
    }
drumm's avatar
drumm committed
768 769
  }

770
  require_once DRUPAL_ROOT . '/core/includes/theme.inc';
771
  // Transform arguments before inserting them
772
  foreach ($args as $key => $value) {
773 774 775 776 777 778 779 780
    switch ($key[0]) {
      // Escaped only
      case '@':
        $args[$key] = check_plain($value);
        break;
      // Escaped and placeholder
      case '%':
      default:
781
        $args[$key] = '<em>' . check_plain($value) . '</em>';
782 783 784 785
        break;
      // Pass-through
      case '!':
    }
786
  }
787
  return strtr((!empty($strings[$options['context']][$string]) ? $strings[$options['context']][$string] : $string), $args);
788
}
789 790

/**
791
 * Checks an install profile's requirements.
792
 *
793
 * @param string $profile
794
 *   Name of install profile to check.
795 796 797 798
 * @param array $install_state
 *   The current state in the install process.
 *
 * @return array
799
 *   Array of the install profile's requirements.
800
 */
801
function drupal_check_profile($profile, array $install_state) {
802
  include_once DRUPAL_ROOT . '/core/includes/file.inc';
803

804
  $profile_file = $install_state['profiles'][$profile]->uri;
805 806

  if (!isset($profile) || !file_exists($profile_file)) {
807
    throw new Exception(install_no_profile_error());
808 809
  }

810
  $info = install_profile_info($profile);
811

812
  // Collect requirement testing results.
813
  $requirements = array();
814 815 816
  foreach ($info['dependencies'] as $module) {
    module_load_install($module);
    $function = $module . '_requirements';
817 818
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
819
    }
820 821 822 823 824
  }
  return $requirements;
}

/**
825
 * Extracts the highest severity from the requirements array.
826 827
 *
 * @param $requirements
828
 *   An array of requirements, in the same format as is returned by
829
 *   hook_requirements().
830
 *
831 832
 * @return
 *   The highest severity in the array.
833 834 835 836 837 838 839 840 841 842 843 844
 */
function drupal_requirements_severity(&$requirements) {
  $severity = REQUIREMENT_OK;
  foreach ($requirements as $requirement) {
    if (isset($requirement['severity'])) {
      $severity = max($severity, $requirement['severity']);
    }
  }
  return $severity;
}

/**
845
 * Checks a module's requirements.
846 847 848
 *
 * @param $module
 *   Machine name of module to check.
849
 *
850
 * @return
851
 *   TRUE or FALSE, depending on whether the requirements are met.
852 853
 */
function drupal_check_module($module) {
854 855
  module_load_install($module);
  if (module_hook($module, 'requirements')) {
856 857 858 859 860 861
    // 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) {
862 863
          $message = $requirement['description'];
          if (isset($requirement['value']) && $requirement['value']) {
864
            $message .= ' (' . t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) . ')';
865 866
          }
          drupal_set_message($message, 'error');
867 868 869 870 871 872 873
        }
      }
      return FALSE;
    }
  }
  return TRUE;
}
874 875

/**
876
 * Retrieves information about an install profile from its .info file.
877
 *
878 879
 * The information stored in a profile .info file is similar to that stored in
 * a normal Drupal module .info file. For example:
880 881
 * - name: The real name of the install profile for display purposes.
 * - description: A brief description of the profile.
882 883
 * - dependencies: An array of shortnames of other modules that this install
 *   profile requires.
884
 *
885 886 887 888 889 890
 * Additional, less commonly-used information that can appear in a profile.info
 * file but not in a normal Drupal module .info file includes:
 * - distribution_name: The name of the Drupal distribution that is being
 *   installed, to be shown throughout the installation process. Defaults to
 *   'Drupal'.
 *
891 892 893 894
 * 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().
 *
895
 * Example of .info file:
896
 * @code
897 898
 *    name = Minimal
 *    description = Start fresh, with only a few modules enabled.
899 900
 *    dependencies[] = block
 *    dependencies[] = dblog
901
 * @endcode
902
 *
903
 * @param $profile
904
 *   Name of profile.
905 906
 * @param $langcode
 *   Language code (if any).
907
 *
908 909
 * @return
 *   The info array.
910
 */
911
function install_profile_info($profile, $langcode = 'en') {
912 913 914 915 916 917 918
  $cache = &drupal_static(__FUNCTION__, array());

  if (!isset($cache[$profile])) {
    // Set defaults for module info.
    $defaults = array(
      'dependencies' => array(),
      'description' => '',
919
      'distribution_name' => 'Drupal',
920
      'version' => NULL,
921
      'hidden' => FALSE,
922 923
      'php' => DRUPAL_MINIMUM_PHP,
    );
924 925 926
    $profile_file = drupal_get_path('profile', $profile) . "/$profile.info";
    $info = drupal_parse_info_file($profile_file);
    $info += $defaults;
927
    $info['dependencies'] = array_unique(array_merge(
928 929
      drupal_required_modules(),
      $info['dependencies'],
930
      ($langcode != 'en' && !empty($langcode) ? array('locale') : array()))
931
    );
932 933 934 935 936

    // drupal_required_modules() includes the current profile as a dependency.
    // Since a module can't depend on itself we remove that element of the array.
    array_shift($info['dependencies']);

937 938 939
    $cache[$profile] = $info;
  }
  return $cache[$profile];
940 941
}

942 943 944 945 946
/**
 * 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
947
 * TABLE to database specific functions like stored procedures and client
948 949 950
 * encoding.
 */
function db_run_tasks($driver) {
951
  db_installer_object($driver)->runTasks();
952
  return TRUE;
953
}
954 955 956 957 958 959 </