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

3
use Drupal\Core\Database\Database;
4
use Drupal\Core\Config\FileStorage;
5

6 7 8
/**
 * Indicates that a module has not been installed yet.
 */
9
const SCHEMA_UNINSTALLED = -1;
10 11 12 13

/**
 * Indicates that a module has been installed.
 */
14
const SCHEMA_INSTALLED = 0;
15

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

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

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

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

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

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

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

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

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

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

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

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

76 77 78 79
/**
 * Initialize the update system by loading all installed module's .install files.
 */
function drupal_load_updates() {
80 81 82 83
  foreach (drupal_get_installed_schema_version(NULL, FALSE, TRUE) as $module => $schema_version) {
    if ($schema_version > -1) {
      module_load_install($module);
    }
84 85 86
  }
}

87
/**
88
 * Loads the install profile, extracting its defined distribution name.
89 90
 *
 * @return
91 92 93 94
 *   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()
95
 */
96
function drupal_install_profile_distribution_name() {
97 98 99 100 101 102 103 104 105
  // 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();
106
    $info = system_get_info('module', $profile);
107 108
    return $info['distribution_name'];
  }
109 110 111 112 113 114 115 116 117 118 119
}

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

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

/**
130
 * Detect all supported databases that are compiled into PHP.
131 132 133 134 135
 *
 * @return
 *  An array of database types compiled into PHP.
 */
function drupal_detect_database_types() {
136 137 138 139 140 141 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;
}

/**
 * Return all supported database installer objects that are compiled into PHP.
 *
 * @return
 *  An array of database installer objects compiled into PHP.
 */
function drupal_get_database_types() {
152
  $databases = array();
153
  $drivers = array();
154

155
  // We define a driver as a directory in /core/includes/database that in turn
156
  // contains a database.inc file. That allows us to drop in additional drivers
157 158 159
  // without modifying the installer.
  // Because we have no registry yet, we need to also include the install.inc
  // file for the driver explicitly.
160
  require_once DRUPAL_ROOT . '/core/includes/database.inc';
161
  foreach (file_scan_directory(DRUPAL_ROOT . '/core/lib/Drupal/Core/Database/Driver', '/^[a-z]*$/i', array('recurse' => FALSE)) as $file) {
162
    if (file_exists($file->uri . '/Install/Tasks.php')) {
163 164
      $drivers[$file->filename] = $file->uri;
    }
165 166 167
  }

  foreach ($drivers as $driver => $file) {
168
    $installer = db_installer_object($driver);
169
    if ($installer->installable()) {
170
      $databases[$driver] = $installer;
171 172
    }
  }
173

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

181 182 183
  return $databases;
}

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

  // 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;
  $first = TRUE;
204
  if ($fp = fopen(DRUPAL_ROOT . '/' . $default_settings, 'r')) {
205 206 207 208 209 210 211 212 213 214 215 216
    // Step line by line through settings.php.
    while (!feof($fp)) {
      $line = fgets($fp);
      if ($first && substr($line, 0, 5) != '<?php') {
        $buffer = "<?php\n\n";
      }
      $first = FALSE;
      // Check for constants.
      if (substr($line, 0, 7) == 'define(') {
        preg_match('/define\(\s*[\'"]([A-Z_-]+)[\'"]\s*,(.*?)\);/', $line, $variable);
        if (in_array($variable[1], $keys)) {
          $setting = $settings[$variable[1]];
217
          $buffer .= str_replace($variable[2], " '" . $setting['value'] . "'", $line);
218 219 220 221 222 223 224 225 226 227 228 229 230 231
          unset($settings[$variable[1]]);
          unset($settings[$variable[2]]);
        }
        else {
          $buffer .= $line;
        }
      }
      // Check for variables.
      elseif (substr($line, 0, 1) == '$') {
        preg_match('/\$([^ ]*) /', $line, $variable);
        if (in_array($variable[1], $keys)) {
          // Write new value to settings.php in the following format:
          //    $'setting' = 'value'; // 'comment'
          $setting = $settings[$variable[1]];
232
          $buffer .= '$' . $variable[1] . " = " . var_export($setting['value'], TRUE) . ";" . (!empty($setting['comment']) ? ' // ' . $setting['comment'] . "\n" : "\n");
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
          unset($settings[$variable[1]]);
        }
        else {
          $buffer .= $line;
        }
      }
      else {
        $buffer .= $line;
      }
    }
    fclose($fp);

    // Add required settings that were missing from settings.php.
    foreach ($settings as $setting => $data) {
      if ($data['required']) {
248
        $buffer .= "\$$setting = " . var_export($data['value'], TRUE) . ";\n";
249 250 251
      }
    }

252
    $fp = fopen(DRUPAL_ROOT . '/' . $settings_file, 'w');
253
    if ($fp && fwrite($fp, $buffer) === FALSE) {
254
      throw new Exception(st('Failed to modify %settings. Verify the file permissions.', array('%settings' => $settings_file)));
255 256 257
    }
  }
  else {
258
    throw new Exception(st('Failed to open %settings. Verify the file permissions.', array('%settings' => $default_settings)));
259 260 261 262
  }
}

/**
263
 * Verify an install profile for installation.
264
 *
265 266
 * @param $install_state
 *   An array of information about the current installation state.
Steven Wittens's avatar
Steven Wittens committed
267 268
 * @return
 *   The list of modules to install.
269
 */
270 271 272
function drupal_verify_profile($install_state) {
  $profile = $install_state['parameters']['profile'];

273 274
  include_once DRUPAL_ROOT . '/core/includes/file.inc';
  include_once DRUPAL_ROOT . '/core/includes/common.inc';
275

276
  $profile_file = DRUPAL_ROOT . "/profiles/$profile/$profile.profile";
277 278

  if (!isset($profile) || !file_exists($profile_file)) {
279
    throw new Exception(install_no_profile_error());
280
  }
281
  $info = $install_state['profile_info'];
282

283 284
  // Get a list of modules that exist in Drupal's assorted subdirectories.
  $present_modules = array();
285
  foreach (drupal_system_listing('/^' . DRUPAL_PHP_FUNCTION_PATTERN . '\.module$/', 'modules', 'name', 0) as $present_module) {
286 287 288
    $present_modules[] = $present_module->name;
  }

289 290 291 292
  // 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();

293
  // Verify that all of the profile's required modules are present.
294
  $missing_modules = array_diff($info['dependencies'], $present_modules);
295 296

  $requirements = array();
297

298
  if (count($missing_modules)) {
299
    $modules = array();
300
    foreach ($missing_modules as $module) {
301
      $modules[] = '<span class="admin-missing">' . drupal_ucfirst($module) . '</span>';
Steven Wittens's avatar
Steven Wittens committed
302
    }
303 304 305 306
    $requirements['required_modules'] = array(
      'title'       => st('Required modules'),
      'value'       => st('Required modules not found.'),
      'severity'    => REQUIREMENT_ERROR,
307
      'description' => st('The following modules are required but were not found. Move them into the appropriate modules subdirectory, such as <em>sites/all/modules</em>. Missing modules: !modules', array('!modules' => implode(', ', $modules))),
308
    );
Steven Wittens's avatar
Steven Wittens committed
309
  }
310
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
311
}
312

313 314 315 316 317 318 319
/**
 * Callback to install the system module.
 *
 * Separated from the installation of other modules so core system
 * functions can be made available while other modules are installed.
 */
function drupal_install_system() {
320
  $system_path = drupal_get_path('module', 'system');
321
  require_once DRUPAL_ROOT . '/' . $system_path . '/system.install';
Steven Wittens's avatar
Steven Wittens committed
322
  module_invoke('system', 'install');
323

Steven Wittens's avatar
Steven Wittens committed
324 325
  $system_versions = drupal_get_schema_versions('system');
  $system_version = $system_versions ? max($system_versions) : SCHEMA_INSTALLED;
326
  db_insert('system')
327
    ->fields(array('filename', 'name', 'type', 'owner', 'status', 'schema_version', 'bootstrap'))
328 329 330 331 332 333
    ->values(array(
        'filename' => $system_path . '/system.module',
        'name' => 'system',
        'type' => 'module',
        'owner' => '',
        'status' => 1,
334 335 336
        'schema_version' => $system_version,
        'bootstrap' => 0,
      ))
337
    ->execute();
338
  system_rebuild_module_data();
339
  config_install_default_config('system');
340 341
}

342
/**
343
 * Uninstalls a given list of modules.
344
 *
345 346
 * @param $module_list
 *   The modules to uninstall.
347 348 349 350 351 352 353 354 355 356
 * @param $uninstall_dependents
 *   If TRUE, the function will check that all modules which depend on the
 *   passed-in module list either are already uninstalled or contained in the
 *   list, and it will ensure that the modules are uninstalled in the correct
 *   order. This incurs a significant performance cost, so use FALSE if you
 *   know $module_list is already complete and in the correct order.
 *
 * @return
 *   FALSE if one or more dependent modules are missing from the list, TRUE
 *   otherwise.
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
function drupal_uninstall_modules($module_list = array(), $uninstall_dependents = TRUE) {
  if ($uninstall_dependents) {
    // Get all module data so we can find dependents and sort.
    $module_data = system_rebuild_module_data();
    // Create an associative array with weights as values.
    $module_list = array_flip(array_values($module_list));

    $profile = drupal_get_profile();
    while (list($module) = each($module_list)) {
      if (!isset($module_data[$module]) || drupal_get_installed_schema_version($module) == SCHEMA_UNINSTALLED) {
        // This module doesn't exist or is already uninstalled, skip it.
        unset($module_list[$module]);
        continue;
      }
      $module_list[$module] = $module_data[$module]->sort;

      // If the module has any dependents which are not already uninstalled and
      // not included in the passed-in list, abort. It is not safe to uninstall
      // them automatically because uninstalling a module is a destructive
      // operation.
      foreach (array_keys($module_data[$module]->required_by) as $dependent) {
        if (!isset($module_list[$dependent]) && drupal_get_installed_schema_version($dependent) != SCHEMA_UNINSTALLED && $dependent != $profile) {
          return FALSE;
        }
      }
    }

    // Sort the module list by pre-calculated weights.
    asort($module_list);
    $module_list = array_keys($module_list);
  }

390 391 392 393
  foreach ($module_list as $module) {
    // Uninstall the module.
    module_load_install($module);
    module_invoke($module, 'uninstall');
394 395
    drupal_uninstall_schema($module);

396 397 398 399 400
    // Remove any stray configuration settings.
    // Get the names of default configurations provided by this module
    // by scanning its config directory.
    $module_config_dir = drupal_get_path('module', $module) . '/config';
    if (is_dir($module_config_dir)) {
401
      $files = glob($module_config_dir . '/*.' . FileStorage::getFileExtension());
402
      foreach ($files as $file) {
403
        $config_name = basename($file, '.' . FileStorage::getFileExtension());
404
        $file_storage = new FileStorage($config_name);
405
        // Delete the configuration from storage.
406
        $file_storage->delete();
407 408 409
      }
    }

410
    watchdog('system', '%module module uninstalled.', array('%module' => $module), WATCHDOG_INFO);
411
    drupal_set_installed_schema_version($module, SCHEMA_UNINSTALLED);
412 413
  }

414 415 416 417
  if (!empty($module_list)) {
    // Call hook_module_uninstall to let other modules act
    module_invoke_all('modules_uninstalled', $module_list);
  }
418 419

  return TRUE;
420 421
}

422 423 424 425 426 427 428 429 430 431
/**
 * Verify the state of the specified file.
 *
 * @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.
 * @return
432
 *   TRUE on success or FALSE on failure. A message is set for the latter.
433 434 435 436 437 438 439 440 441
 */
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)) {
442
    $check = 'is_' . $type;
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 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
    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;
}

/**
 * Create a directory with specified permissions.
 *
504
 * @param $file
505
 *  The name of the directory to create;
506
 * @param $mask
507 508 509 510 511 512 513 514 515 516 517 518 519
 *  The permissions of the directory to create.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
 * @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:
520
          $mod |= 0444;
521 522
          break;
        case FILE_WRITABLE:
523
          $mod |= 0222;
524 525
          break;
        case FILE_EXECUTABLE:
526
          $mod |= 0111;
527 528 529 530 531
          break;
      }
    }
  }

532
  if (@drupal_mkdir($file, $mod)) {
533 534 535 536 537 538 539 540 541 542
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
 * Attempt to fix file permissions.
 *
543 544 545 546 547 548 549 550 551
 * 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.
 *
552 553 554 555 556 557 558 559 560 561
 * @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.
 * @return
 *  TRUE/FALSE whether or not we were able to fix the file's permissions.
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
562 563 564 565 566
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

567
  $mod = fileperms($file) & 0777;
568
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
569 570 571 572 573

  // 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.
574 575 576 577 578
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
579
            $mod |= 0444;
580 581 582 583
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
584
            $mod |= 0222;
585 586 587 588
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
589
            $mod |= 0111;
590 591 592 593
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
594
            $mod &= ~0444;
595 596 597 598
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
599
            $mod &= ~0222;
600 601 602 603
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
604
            $mod &= ~0111;
605 606 607 608 609 610
          }
          break;
      }
    }
  }

611 612 613 614
  // 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)) {
615 616 617 618 619 620 621
    return TRUE;
  }
  else {
    return FALSE;
  }
}

622
/**
623
 * Send the user to a different installer page.
624 625
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
626 627 628 629 630
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
631
  global $base_url;
632
  include_once DRUPAL_ROOT . '/core/includes/common.inc';
633
  header('Location: ' . $base_url . '/' . $path);
634
  header('Cache-Control: no-cache'); // Not a permanent redirect.
635
  drupal_exit();
636 637
}

638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
/**
 * 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);
}

700
/**
701 702 703
 * Functional equivalent of t(), used when some systems are not available.
 *
 * Used during the install process, when database, theme, and localization
704
 * system is possibly not yet available.
705
 *
706 707 708 709
 * 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.
 *
710
 * @see t()
711
 * @see get_t()
712
 * @ingroup sanitization
713
 */
714
function st($string, array $args = array(), array $options = array()) {
715
  static $strings = NULL;
716
  global $install_state;
drumm's avatar
drumm committed
717

718 719 720 721
  if (empty($options['context'])) {
    $options['context'] = '';
  }

722 723
  if (!isset($strings)) {
    $strings = array();
724
    if (isset($install_state['parameters']['langcode'])) {
725 726
      // If the given langcode was selected, there should be at least one .po file
      // with its name ending in install.{$install_state['parameters']['langcode']}.po
727 728
      // This might or might not be the entire filename. It is also possible
      // that multiple files end with the same extension, even if unlikely.
729 730
      $files = install_find_translation_files($install_state['parameters']['langcode']);
      if (!empty($files)) {
731 732
        // Include cross-dependent code from locale module and gettext.inc.
        require_once DRUPAL_ROOT . '/core/modules/locale/locale.module';
733
        require_once DRUPAL_ROOT . '/core/includes/gettext.inc';
734 735
        foreach ($files as $file) {
          _locale_import_read_po('mem-store', $file);
736
        }
737
        $strings = _locale_import_one_string('mem-report');
738
      }
739
    }
drumm's avatar
drumm committed
740 741
  }

742
  require_once DRUPAL_ROOT . '/core/includes/theme.inc';
743
  // Transform arguments before inserting them
744
  foreach ($args as $key => $value) {
745 746 747 748 749 750 751 752
    switch ($key[0]) {
      // Escaped only
      case '@':
        $args[$key] = check_plain($value);
        break;
      // Escaped and placeholder
      case '%':
      default:
753
        $args[$key] = '<em>' . check_plain($value) . '</em>';
754 755 756 757
        break;
      // Pass-through
      case '!':
    }
758
  }
759
  return strtr((!empty($strings[$options['context']][$string]) ? $strings[$options['context']][$string] : $string), $args);
760
}
761 762

/**
763
 * Check an install profile's requirements.
764
 *
765 766 767 768
 * @param $profile
 *   Name of install profile to check.
 * @return
 *   Array of the install profile's requirements.
769 770
 */
function drupal_check_profile($profile) {
771
  include_once DRUPAL_ROOT . '/core/includes/file.inc';
772

773
  $profile_file = DRUPAL_ROOT . "/profiles/$profile/$profile.profile";
774 775

  if (!isset($profile) || !file_exists($profile_file)) {
776
    throw new Exception(install_no_profile_error());
777 778
  }

779
  $info = install_profile_info($profile);
780

781
  // Collect requirement testing results.
782
  $requirements = array();
783 784 785
  foreach ($info['dependencies'] as $module) {
    module_load_install($module);
    $function = $module . '_requirements';
786 787
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
788
    }
789 790 791 792 793 794
  }
  return $requirements;
}

/**
 * Extract highest severity from requirements array.
795 796
 *
 * @param $requirements
797
 *   An array of requirements, in the same format as is returned by
798 799 800
 *   hook_requirements().
 * @return
 *   The highest severity in the array.
801 802 803 804 805 806 807 808 809 810 811 812 813
 */
function drupal_requirements_severity(&$requirements) {
  $severity = REQUIREMENT_OK;
  foreach ($requirements as $requirement) {
    if (isset($requirement['severity'])) {
      $severity = max($severity, $requirement['severity']);
    }
  }
  return $severity;
}

/**
 * Check a module's requirements.
814 815 816 817 818
 *
 * @param $module
 *   Machine name of module to check.
 * @return
 *   TRUE/FALSE depending on the requirements are in place.
819 820
 */
function drupal_check_module($module) {
821 822
  module_load_install($module);
  if (module_hook($module, 'requirements')) {
823 824 825 826 827 828
    // 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) {
829 830
          $message = $requirement['description'];
          if (isset($requirement['value']) && $requirement['value']) {
831
            $message .= ' (' . t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) . ')';
832 833
          }
          drupal_set_message($message, 'error');
834 835 836 837 838 839 840
        }
      }
      return FALSE;
    }
  }
  return TRUE;
}
841 842 843

/**
 * Retrieve info about an install profile from its .info file.
844
 *
845 846
 * The information stored in a profile .info file is similar to that stored in
 * a normal Drupal module .info file. For example:
847 848 849 850
 * - name: The real name of the install profile for display purposes.
 * - description: A brief description of the profile.
 * - dependencies: An array of shortnames of other modules this install profile requires.
 *
851 852 853 854 855 856
 * 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'.
 *
857 858 859 860
 * 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().
 *
861
 * Example of .info file:
862
 * @code
863 864
 *    name = Minimal
 *    description = Start fresh, with only a few modules enabled.
865 866
 *    dependencies[] = block
 *    dependencies[] = dblog
867
 * @endcode
868
 *
869
 * @param $profile
870
 *   Name of profile.
871 872
 * @param $langcode
 *   Language code (if any).
873
 *
874 875
 * @return
 *   The info array.
876
 */
877
function install_profile_info($profile, $langcode = 'en') {
878 879 880 881 882 883 884
  $cache = &drupal_static(__FUNCTION__, array());

  if (!isset($cache[$profile])) {
    // Set defaults for module info.
    $defaults = array(
      'dependencies' => array(),
      'description' => '',
885
      'distribution_name' => 'Drupal',
886
      'version' => NULL,
887
      'hidden' => FALSE,
888 889 890 891
      'php' => DRUPAL_MINIMUM_PHP,
    );
    $info = drupal_parse_info_file("profiles/$profile/$profile.info") + $defaults;
    $info['dependencies'] = array_unique(array_merge(
892 893
      drupal_required_modules(),
      $info['dependencies'],
894
      ($langcode != 'en' && !empty($langcode) ? array('locale') : array()))
895
    );
896 897 898 899 900

    // 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']);

901 902 903
    $cache[$profile] = $info;
  }
  return $cache[$profile];
904 905
}

906 907 908 909 910
/**
 * 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
911
 * TABLE to database specific functions like stored procedures and client
912 913 914
 * encoding.
 */
function db_run_tasks($driver) {
915
  db_installer_object($driver)->runTasks();
916
  return TRUE;
917
}
918 919 920 921 922 923 924 925

/**
 * Returns a database installer object.
 *
 * @param $driver
 *   The name of the driver.
 */
function db_installer_object($driver) {
926 927
  // We cannot use Database::getConnection->getDriverClass() here, because
  // the connection object is not yet functional.
928
  $task_class = "Drupal\\Core\\Database\\Driver\\{$driver}\\Install\\Tasks";
929 930
  return new $task_class();
}