install.inc 22.9 KB
Newer Older
1 2 3
<?php
// $Id$

4 5 6
/**
 * Indicates that a module has not been installed yet.
 */
7
define('SCHEMA_UNINSTALLED', -1);
8 9 10 11

/**
 * Indicates that a module has been installed.
 */
12
define('SCHEMA_INSTALLED', 0);
13

14 15 16
/**
 * Requirement severity -- Informational message only.
 */
Steven Wittens's avatar
Steven Wittens committed
17
define('REQUIREMENT_INFO', -1);
18 19 20 21

/**
 * Requirement severity -- Requirement successfully met.
 */
22
define('REQUIREMENT_OK', 0);
23 24 25 26

/**
 * Requirement severity -- Warning condition; proceed but flag warning.
 */
27
define('REQUIREMENT_WARNING', 1);
28 29 30 31

/**
 * Requirement severity -- Error condition; abort installation.
 */
32
define('REQUIREMENT_ERROR', 2);
33

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
/**
 * File permission check -- File exists.
 */
define('FILE_EXIST', 1);

/**
 * File permission check -- File is readable.
 */
define('FILE_READABLE', 2);

/**
 * File permission check -- File is writable.
 */
define('FILE_WRITABLE', 4);

/**
 * File permission check -- File is executable.
 */
define('FILE_EXECUTABLE', 8);

/**
 * File permission check -- File does not exist.
 */
define('FILE_NOT_EXIST', 16);

/**
 * File permission check -- File is not readable.
 */
define('FILE_NOT_READABLE', 32);

/**
 * File permission check -- File is not writable.
 */
define('FILE_NOT_WRITABLE', 64);

/**
 * File permission check -- File is not executable.
 */
72
define('FILE_NOT_EXECUTABLE', 128);
73

74 75 76 77
/**
 * Initialize the update system by loading all installed module's .install files.
 */
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
 * Returns an array of available schema versions for a module.
87 88 89 90
 *
 * @param $module
 *   A module name.
 * @return
91 92
 *   If the module has updates, an array of available updates sorted by version. 
 *   Otherwise, FALSE.
93 94
 */
function drupal_get_schema_versions($module) {
95
  $updates = array();
96 97
  $functions = get_defined_functions();
  foreach ($functions['user'] as $function) {
98 99
    if (strpos($function, $module . '_update_') === 0) {
      $version = substr($function, strlen($module . '_update_'));
100 101 102
      if (is_numeric($version)) {
        $updates[] = $version;
      }
103
    }
104
  }
105 106
  if (count($updates) == 0) {
    return FALSE;
107
  }
108 109 110 111
  
  // Make sure updates are run in numeric order, not in definition order.
  sort($updates, SORT_NUMERIC);
  
112
  return $updates;
113 114 115 116 117 118 119
}

/**
 * Returns the currently installed schema version for a module.
 *
 * @param $module
 *   A module name.
120 121 122
 * @param $reset
 *   Set to TRUE after modifying the system table.
 * @param $array
123
 *   Set to TRUE if you want to get information about all modules in the
124
 *   system.
125 126 127
 * @return
 *   The currently installed schema version.
 */
128
function drupal_get_installed_schema_version($module, $reset = FALSE, $array = FALSE) {
129
  static $versions = array();
130 131

  if ($reset) {
132
    $versions = array();
133 134 135 136
  }

  if (!$versions) {
    $versions = array();
137
    $result = db_query("SELECT name, schema_version FROM {system} WHERE type = '%s'", 'module');
138 139 140 141 142
    while ($row = db_fetch_object($result)) {
      $versions[$row->name] = $row->schema_version;
    }
  }

143
  return $array ? $versions : $versions[$module];
144 145 146 147 148 149 150 151 152 153 154 155 156
}

/**
 * Update the installed version information for a module.
 *
 * @param $module
 *   A module name.
 * @param $version
 *   The new schema version.
 */
function drupal_set_installed_schema_version($module, $version) {
  db_query("UPDATE {system} SET schema_version = %d WHERE name = '%s'", $version, $module);
}
157 158 159 160 161 162 163 164 165 166 167 168 169

/**
 * Loads the profile definition, extracting the profile's defined name.
 *
 * @return
 *   The name defined in the profile's _profile_details() hook.
 */
function drupal_install_profile_name() {
  global $profile;
  static $name = NULL;

  if (!isset($name)) {
    // Load profile details.
170
    $function = $profile . '_profile_details';
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
    if (function_exists($function)) {
      $details = $function();
    }
    $name = isset($details['name']) ? $details['name'] : 'Drupal';
  }

  return $name;
}

/**
 * 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
 */
function drupal_detect_baseurl($file = 'install.php') {
  global $profile;
  $proto = $_SERVER['HTTPS'] ? 'https://' : 'http://';
  $host = $_SERVER['SERVER_NAME'];
194
  $port = ($_SERVER['SERVER_PORT'] == 80 ? '' : ':' . $_SERVER['SERVER_PORT']);
195
  $uri = preg_replace("/\?.*/", '', $_SERVER['REQUEST_URI']);
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
  $dir = str_replace("/$file", '', $uri);

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

/**
 * Detect all databases supported by Drupal that are compiled into the current
 * PHP installation.
 *
 * @return
 *  An array of database types compiled into PHP.
 */
function drupal_detect_database_types() {
  $databases = array();

  foreach (array('mysql', 'mysqli', 'pgsql') as $type) {
212 213 214
    if (file_exists('./includes/install.' . $type . '.inc')) {
      include_once './includes/install.' . $type . '.inc';
      $function = $type . '_is_available';
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
      if ($function()) {
        $databases[$type] = $type;
      }
    }
  }

  return $databases;
}

/**
 * Read settings.php into a buffer line by line, changing values specified in
 * $settings array, then over-writing the old settings.php file.
 *
 * @param $settings
 *   An array of settings that need to be updated.
 */
function drupal_rewrite_settings($settings = array(), $prefix = '') {
232
  $default_settings = './sites/default/default.settings.php';
233
  $settings_file = './' . conf_path(FALSE, TRUE) . '/' . $prefix . 'settings.php';
234 235 236 237 238 239 240 241 242 243

  // 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;
244
  if ($fp = fopen($default_settings, 'r')) {
245 246 247 248 249 250 251 252 253 254 255 256
    // 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]];
257
          $buffer .= str_replace($variable[2], " '" . $setting['value'] . "'", $line);
258 259 260 261 262 263 264 265 266 267 268 269 270 271
          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]];
272
          $buffer .= '$' . $variable[1] . " = '" . $setting['value'] . "';" . (!empty($setting['comment']) ? ' // ' . $setting['comment'] . "\n" : "\n");
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
          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']) {
288
        $buffer .= "\$$setting = '" . $data['value'] . "';\n";
289 290 291 292 293
      }
    }

    $fp = fopen($settings_file, 'w');
    if ($fp && fwrite($fp, $buffer) === FALSE) {
294
      drupal_set_message(st('Failed to modify %settings, please verify the file permissions.', array('%settings' => $settings_file)), 'error');
295 296 297
    }
  }
  else {
298
    drupal_set_message(st('Failed to open %settings, please verify the file permissions.', array('%settings' => $default_settings)), 'error');
299 300 301 302 303 304 305 306 307 308 309 310
  }
}

/**
 * Get list of all .install files.
 *
 * @param $module_list
 *   An array of modules to search for their .install files.
 */
function drupal_get_install_files($module_list = array()) {
  $installs = array();
  foreach ($module_list as $module) {
311
    $installs = array_merge($installs, drupal_system_listing($module . '.install$', 'modules'));
312 313 314 315 316
  }
  return $installs;
}

/**
Steven Wittens's avatar
Steven Wittens committed
317
 * Verify a profile for installation.
318 319
 *
 * @param profile
Steven Wittens's avatar
Steven Wittens committed
320
 *   Name of profile to verify.
drumm's avatar
drumm committed
321 322
 * @param locale
 *   Name of locale used (if any).
Steven Wittens's avatar
Steven Wittens committed
323 324
 * @return
 *   The list of modules to install.
325
 */
drumm's avatar
drumm committed
326
function drupal_verify_profile($profile, $locale) {
327
  include_once './includes/file.inc';
328
  include_once './includes/common.inc';
329

330
  $profile_file = "./profiles/$profile/$profile.profile";
331 332

  if (!isset($profile) || !file_exists($profile_file)) {
333
    install_no_profile_error();
334 335 336 337 338
  }

  require_once($profile_file);

  // Get a list of modules required by this profile.
339
  $function = $profile . '_profile_modules';
340
  $module_list = array_merge(drupal_required_modules(), $function(), ($locale != 'en' ? array('locale') : array()));
341

342 343
  // Get a list of modules that exist in Drupal's assorted subdirectories.
  $present_modules = array();
344
  foreach (drupal_system_listing('\.module$', 'modules', 'name', 0) as $present_module) {
345 346 347 348 349 350
    $present_modules[] = $present_module->name;
  }

  // Verify that all of the profile's required modules are present.
  $missing_modules = array_diff($module_list, $present_modules);
  if (count($missing_modules)) {
351
    foreach ($missing_modules as $module) {
Steven Wittens's avatar
Steven Wittens committed
352 353 354
      drupal_set_message(st('The %module module is required but was not found. Please move it into the <em>modules</em> subdirectory.', array('%module' => $module)), 'error');
    }
  }
355 356 357
  else {
    return $module_list;
  }
Steven Wittens's avatar
Steven Wittens committed
358
}
359

Steven Wittens's avatar
Steven Wittens committed
360
/**
361 362
 * Calls the install function and updates the system table for a given list of
 * modules.
Steven Wittens's avatar
Steven Wittens committed
363 364
 *
 * @param module_list
365 366 367
 *   The modules to install.
 */
function drupal_install_modules($module_list = array()) {
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
  $files = module_rebuild_cache();
  $module_list = array_flip(array_values($module_list));
  do {
    $moved = FALSE;
    foreach ($module_list as $module => $weight) {
      $file = $files[$module];
      if (isset($file->info['dependencies']) && is_array($file->info['dependencies'])) {
        foreach ($file->info['dependencies'] as $dependency) {
          if (isset($module_list[$dependency]) && $module_list[$module] < $module_list[$dependency] +1) {
            $module_list[$module] = $module_list[$dependency] +1;
            $moved = TRUE;
          }
        }
      }
    }
  } while ($moved);
  asort($module_list);
  $module_list = array_keys($module_list);
386 387 388 389 390 391 392 393 394 395
  array_filter($module_list, '_drupal_install_module');
  module_enable($module_list);
}

/**
 * Callback to install an individual profile module.
 *
 * Used during installation to install modules one at a time and then
 * enable them, or to install a number of modules at one time
 * from admin/build/modules.
Steven Wittens's avatar
Steven Wittens committed
396
 */
397 398 399 400 401 402 403 404 405
function _drupal_install_module($module) {
  if (drupal_get_installed_schema_version($module, TRUE) == SCHEMA_UNINSTALLED) {
    module_load_install($module);
    module_invoke($module, 'install');
    $versions = drupal_get_schema_versions($module);
    drupal_set_installed_schema_version($module, $versions ? max($versions) : SCHEMA_INSTALLED);
    return TRUE;
  }
}
Steven Wittens's avatar
Steven Wittens committed
406

407 408 409 410 411 412 413
/**
 * 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() {
Dries's avatar
Dries committed
414
  $system_path = dirname(drupal_get_filename('module', 'system', NULL));
415
  require_once './' . $system_path . '/system.install';
Steven Wittens's avatar
Steven Wittens committed
416 417 418
  module_invoke('system', 'install');
  $system_versions = drupal_get_schema_versions('system');
  $system_version = $system_versions ? max($system_versions) : SCHEMA_INSTALLED;
419
  db_query("INSERT INTO {system} (filename, name, type, owner, status, bootstrap, schema_version) VALUES('%s', '%s', '%s', '%s', %d, %d, %d)", $system_path . '/system.module', 'system', 'module', '', 1, 0, $system_version);
Steven Wittens's avatar
Steven Wittens committed
420
  // Now that we've installed things properly, bootstrap the full Drupal environment
421
  drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
Steven Wittens's avatar
Steven Wittens committed
422
  module_rebuild_cache();
423 424
}

425

426 427 428 429 430 431 432
/**
 * Calls the uninstall function and updates the system table for a given module.
 *
 * @param $module
 *   The module to uninstall.
 */
function drupal_uninstall_module($module) {
433 434 435 436 437
  // First, retrieve all the module's menu paths from db.
  drupal_load('module', $module);
  $paths = module_invoke($module, 'menu');

  // Uninstall the module(s).
438 439
  module_load_install($module);
  module_invoke($module, 'uninstall');
Dries's avatar
Dries committed
440

441
  // Now remove the menu links for all paths declared by this module.
442 443 444
  if (!empty($paths)) {
    $paths = array_keys($paths);
    // Clean out the names of load functions.
445
    foreach ($paths as $index => $path) {
446 447 448 449 450 451 452 453 454
      $parts = explode('/', $path, MENU_MAX_PARTS);
      foreach ($parts as $k => $part) {
        if (preg_match('/^%[a-z_]*$/', $part)) {
          $parts[$k] = '%';
        }
      }
      $paths[$index] = implode('/', $parts);
    }
    $placeholders = implode(', ', array_fill(0, count($paths), "'%s'"));
Dries's avatar
Dries committed
455

456
    $result = db_query('SELECT * FROM {menu_links} WHERE router_path IN (' . $placeholders . ') AND external = 0 ORDER BY depth DESC', $paths);
457 458 459 460 461 462 463
    // Remove all such items. Starting from those with the greatest depth will
    // minimize the amount of re-parenting done by menu_link_delete().
    while ($item = db_fetch_array($result)) {
      _menu_delete_item($item, TRUE);
    }
  }

464 465 466
  drupal_set_installed_schema_version($module, SCHEMA_UNINSTALLED);
}

467 468 469 470 471 472 473 474 475 476
/**
 * 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
477
 *   TRUE on success or FALSE on failure. A message is set for the latter.
478 479 480 481 482 483 484 485 486
 */
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)) {
487
    $check = 'is_' . $type;
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 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
    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.
 *
 * @param file
 *  The name of the directory to create;
 * @param mask
 *  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:
          $mod += 444;
          break;
        case FILE_WRITABLE:
          $mod += 222;
          break;
        case FILE_EXECUTABLE:
          $mod += 111;
          break;
      }
    }
  }

  if (@mkdir($file, intval("0$mod", 8))) {
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
 * Attempt to fix file permissions.
 *
589 590 591 592 593 594 595 596 597
 * 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.
 *
598 599 600 601 602 603 604 605 606 607 608
 * @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) {
609
  $mod = fileperms($file) & 0777;
610
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
611 612 613 614 615

  // 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.
616 617 618 619 620
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
621
            $mod |= 0444;
622 623 624 625
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
626
            $mod |= 0222;
627 628 629 630
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
631
            $mod |= 0111;
632 633 634 635
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
636
            $mod &= ~0444;
637 638 639 640
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
641
            $mod &= ~0222;
642 643 644 645
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
646
            $mod &= ~0111;
647 648 649 650 651 652
          }
          break;
      }
    }
  }

653 654 655 656
  // 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)) {
657 658 659 660 661 662 663
    return TRUE;
  }
  else {
    return FALSE;
  }
}

664 665 666 667 668 669 670 671 672

/**
 * Send the user to a different installer page. This issues an on-site HTTP
 * redirect. Messages (and errors) are erased.
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
673
  global $base_url;
674
  header('Location: ' . $base_url . '/' . $path);
675
  header('Cache-Control: no-cache'); // Not a permanent redirect.
676 677 678
  exit();
}

679
/**
680 681 682
 * Hardcoded function for doing the equivalent of t() during
 * the install process, when database, theme, and localization
 * system is possibly not yet available.
683 684
 */
function st($string, $args = array()) {
drumm's avatar
drumm committed
685 686 687 688 689
  static $locale_strings = NULL;
  global $profile, $install_locale;

  if (!isset($locale_strings)) {
    $locale_strings = array();
690
    $filename = './profiles/' . $profile . '/translations/' . $install_locale . '.po';
drumm's avatar
drumm committed
691 692 693 694 695 696 697 698
    if (file_exists($filename)) {
      require_once './includes/locale.inc';
      $file = (object) array('filepath' => $filename);
      _locale_import_read_po('mem-store', $file);
      $locale_strings = _locale_import_one_string('mem-report');
    }
  }

699
  require_once './includes/theme.inc';
700
  // Transform arguments before inserting them
701
  foreach ($args as $key => $value) {
702 703 704 705 706 707 708 709
    switch ($key[0]) {
      // Escaped only
      case '@':
        $args[$key] = check_plain($value);
        break;
      // Escaped and placeholder
      case '%':
      default:
710
        $args[$key] = '<em>' . check_plain($value) . '</em>';
711 712 713 714
        break;
      // Pass-through
      case '!':
    }
715
  }
716
  return strtr((!empty($locale_strings[$string]) ? $locale_strings[$string] : $string), $args);
717
}
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736

/**
 * Check a profile's requirements.
 *
 * @param profile
 *   Name of profile to check.
 */
function drupal_check_profile($profile) {
  include_once './includes/file.inc';

  $profile_file = "./profiles/$profile/$profile.profile";

  if (!isset($profile) || !file_exists($profile_file)) {
    install_no_profile_error();
  }

  require_once($profile_file);

  // Get a list of modules required by this profile.
737
  $function = $profile . '_profile_modules';
738
  $module_list = array_unique(array_merge(drupal_required_modules(), $function()));
739 740 741 742 743 744 745 746

  // Get a list of all .install files.
  $installs = drupal_get_install_files($module_list);

  // Collect requirement testing results
  $requirements = array();
  foreach ($installs as $install) {
    require_once $install->filename;
747 748 749
    $function = $install->name. '_requirements';
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
750
    }
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
  }
  return $requirements;
}

/**
 * Extract highest severity from requirements array.
 */
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.
 */
function drupal_check_module($module) {
  // Include install file
  $install = drupal_get_install_files(array($module));
  if (isset($install[$module])) {
    require_once $install[$module]->filename;

    // 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) {
783 784
          $message = $requirement['description'];
          if (isset($requirement['value']) && $requirement['value']) {
785
            $message .= ' (' . t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) . ')';
786 787
          }
          drupal_set_message($message, 'error');
788 789 790 791 792 793 794
        }
      }
      return FALSE;
    }
  }
  return TRUE;
}