install.inc 28 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
  $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();

211 212 213 214 215 216 217
  // We define a driver as a directory in /includes/database that in turn
  // contains a database.inc file.  That allows us to drop in additional drivers
  // without modifying the installer.
  // Because we have no registry yet, we need to also include the install.inc
  // file for the driver explicitly.
  foreach (glob('./includes/database/*/{install,database}.inc', GLOB_BRACE) as $file) {
    include_once($file);
218 219
    $dir_parts = explode('/', $file, -1);
    $drivers[end($dir_parts)] = $file;
220 221 222
  }

  foreach ($drivers as $driver => $file) {
223 224 225 226 227 228
    $class = 'DatabaseInstaller_' . $driver;
    $installer = new $class();
    if ($installer->installable()) {
      $databases[$driver] = $installer->name();
    }
  }
229

230 231 232 233 234 235 236
  // Usability: unconditionnally put the MySQL driver on top.
  if (isset($databases['mysql'])) {
    $mysql_database = $databases['mysql'];
    unset($databases['mysql']);
    $databases = array('mysql' => $mysql_database) + $databases;
  }
  
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
  return $databases;
}

abstract class DatabaseInstaller {
  protected $success = array();
  protected $tests = array(
    'testCreate' => array(
      'query' => 'CREATE TABLE drupal_install_test (id int NULL)',
      'success' => 'CREATE',
      'message' => 'Failed to create a test table on your %name database server with the command %query. %name reports the following message: %error.<ul><li>Are you sure the configured username has the necessary %name permissions to create tables in the database?</li></ul>For more help, see the <a href="http://drupal.org/node/258">Installation and upgrading handbook</a>. If you are unsure what these terms mean you should probably contact your hosting provider.',
      'fatal' => TRUE,
    ),
    'testInsert' => array(
      'query' => 'INSERT INTO drupal_install_test (id) VALUES (1)',
      'success' => 'INSERT',
      'message' => 'Failed to insert a value into a test table on your %name database server. We tried inserting a value with the command %query and %name reported the following error: %error.',
    ),
    'testUpdate' => array(
      'query' => 'UPDATE drupal_install_test SET id = 2',
      'success' => 'UPDATE',
      'message' => 'Failed to update a value in a test table on your %name database server. We tried updating a value with the command %query and %name reported the following error: %error.',
    ),
    'testDelete' => array(
      'query' => 'DELETE FROM drupal_install_test',
      'success' => 'DELETE',
      'message' => 'Failed to delete a value from a test table on your %name database server. We tried deleting a value with the command %query and %name reported the following error: %error.',
    ),
    'testDrop' => array(
      'query' => 'DROP TABLE drupal_install_test',
      'success' => 'DELETE',
      'message' => 'Failed to drop a test table from your %name database server. We tried dropping a table with the command %query and %name reported the following error %error.',
    ),
  );
  public $error = FALSE;

  protected function hasPdoDriver() {
    return in_array($this->pdoDriver, PDO::getAvailableDrivers());
  }

  public function installable() {
    return $this->hasPdoDriver();
  }

  abstract public function name();

  public function test() {
    $return = $this->testConnect();
    if ($return === FALSE) {
      return FALSE;
    }
    foreach ($this->tests as $test) {
      $return = $this->runTestQuery($test['query'], $test['success'], $test['message'], !empty($tests['fatal']));
      if ($return === FALSE) {
        return FALSE;
291 292
      }
    }
293
    return $this->success;
294 295
  }

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
  /**
   * Check if we can connect to the database.
   *
   * @return
   *  FALSE on failure.
   */
  protected function testConnect() {
    try {
      db_set_active();
      $this->success[] = 'CONNECT';
    }
    catch (Exception $e) {
      drupal_set_message(st('Failed to connect to your %name database server. %name reports the following message: %error.<ul><li>Are you sure you have the correct username and password?</li><li>Are you sure that you have typed the correct database hostname?</li><li>Are you sure that the database server is running?</li></ul>For more help, see the <a href="http://drupal.org/node/258">Installation and upgrading handbook</a>. If you are unsure what these terms mean you should probably contact your hosting provider.', array('%error' => $e->getMessage(), 'name' => $this->name())), 'error');
      return FALSE;
    }
  }

  protected function runTestQuery($query, $success, $message, $fatal = FALSE) {
    try {
      db_query($query);
      $this->success[] = $success;
    }
    catch (Exception $e) {
      drupal_set_message(st($message, array('%query' => $query, '%error' => $e->getMessage(), '%name' => $this->name())), 'error');
      $this->error = TRUE;
      if ($fatal) {
        return FALSE;
      }
    }
  }
326 327 328 329 330 331 332 333 334 335
}

/**
 * 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 = '') {
336
  $default_settings = './sites/default/default.settings.php';
337
  $settings_file = './' . conf_path(FALSE, TRUE) . '/' . $prefix . 'settings.php';
338 339 340 341 342 343 344 345 346 347

  // 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;
348
  if ($fp = fopen($default_settings, 'r')) {
349 350 351 352 353 354 355 356 357 358 359 360
    // 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]];
361
          $buffer .= str_replace($variable[2], " '" . $setting['value'] . "'", $line);
362 363 364 365 366 367 368 369 370 371 372 373 374 375
          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]];
376
          $buffer .= '$' . $variable[1] . " = " . var_export($setting['value'], TRUE) . ";" . (!empty($setting['comment']) ? ' // ' . $setting['comment'] . "\n" : "\n");
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
          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']) {
392
        $buffer .= "\$$setting = " . var_export($data['value'], TRUE) . ";\n";
393 394 395 396 397
      }
    }

    $fp = fopen($settings_file, 'w');
    if ($fp && fwrite($fp, $buffer) === FALSE) {
398
      drupal_set_message(st('Failed to modify %settings, please verify the file permissions.', array('%settings' => $settings_file)), 'error');
399 400 401
    }
  }
  else {
402
    drupal_set_message(st('Failed to open %settings, please verify the file permissions.', array('%settings' => $default_settings)), 'error');
403 404 405 406 407 408 409 410 411 412 413 414
  }
}

/**
 * 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) {
415
    $installs = array_merge($installs, drupal_system_listing($module . '.install$', 'modules'));
416 417 418 419 420
  }
  return $installs;
}

/**
Steven Wittens's avatar
Steven Wittens committed
421
 * Verify a profile for installation.
422 423
 *
 * @param profile
Steven Wittens's avatar
Steven Wittens committed
424
 *   Name of profile to verify.
drumm's avatar
drumm committed
425 426
 * @param locale
 *   Name of locale used (if any).
Steven Wittens's avatar
Steven Wittens committed
427 428
 * @return
 *   The list of modules to install.
429
 */
drumm's avatar
drumm committed
430
function drupal_verify_profile($profile, $locale) {
431
  include_once './includes/file.inc';
432
  include_once './includes/common.inc';
433

434
  $profile_file = "./profiles/$profile/$profile.profile";
435 436

  if (!isset($profile) || !file_exists($profile_file)) {
437
    install_no_profile_error();
438 439 440 441 442
  }

  require_once($profile_file);

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

446 447
  // Get a list of modules that exist in Drupal's assorted subdirectories.
  $present_modules = array();
448
  foreach (drupal_system_listing('\.module$', 'modules', 'name', 0) as $present_module) {
449 450 451 452 453 454
    $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)) {
455
    foreach ($missing_modules as $module) {
Steven Wittens's avatar
Steven Wittens committed
456 457 458
      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');
    }
  }
459 460 461
  else {
    return $module_list;
  }
Steven Wittens's avatar
Steven Wittens committed
462
}
463

Steven Wittens's avatar
Steven Wittens committed
464
/**
465 466
 * Calls the install function and updates the system table for a given list of
 * modules.
Steven Wittens's avatar
Steven Wittens committed
467 468
 *
 * @param module_list
469 470 471
 *   The modules to install.
 */
function drupal_install_modules($module_list = array()) {
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
  $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);
490 491 492 493 494 495 496 497 498 499
  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
500
 */
501 502 503 504 505 506 507 508 509
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
510

511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
/**
 * Manually include all files for the active database.
 *
 * Because we have no registry yet, we need to manually include the
 * necessary database include files.
 */
function drupal_install_init_database() {
  static $included = FALSE;
  
  if (!$included) {
    $connection_info = Database::getConnectionInfo();
    $driver = $connection_info['default']['driver'];
    require_once('./includes/database/query.inc');
    require_once('./includes/database/select.inc');
    require_once('./includes/database/schema.inc');
    foreach (glob('./includes/database/' . $driver . '/*.inc') as $include_file) {
      require_once($include_file);
    }
  }
}

532 533 534 535 536 537 538
/**
 * 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
539
  $system_path = dirname(drupal_get_filename('module', 'system', NULL));
540
  require_once './' . $system_path . '/system.install';
541
  drupal_install_init_database();
Steven Wittens's avatar
Steven Wittens committed
542
  module_invoke('system', 'install');
543
  
Steven Wittens's avatar
Steven Wittens committed
544 545
  $system_versions = drupal_get_schema_versions('system');
  $system_version = $system_versions ? max($system_versions) : SCHEMA_INSTALLED;
546
  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
547
  // Now that we've installed things properly, bootstrap the full Drupal environment
548
  drupal_install_init_database();
549
  drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
Steven Wittens's avatar
Steven Wittens committed
550
  module_rebuild_cache();
551 552
}

553

554 555 556 557 558 559 560
/**
 * Calls the uninstall function and updates the system table for a given module.
 *
 * @param $module
 *   The module to uninstall.
 */
function drupal_uninstall_module($module) {
561 562 563 564 565
  // First, retrieve all the module's menu paths from db.
  drupal_load('module', $module);
  $paths = module_invoke($module, 'menu');

  // Uninstall the module(s).
566 567
  module_load_install($module);
  module_invoke($module, 'uninstall');
Dries's avatar
Dries committed
568

569
  // Now remove the menu links for all paths declared by this module.
570 571 572
  if (!empty($paths)) {
    $paths = array_keys($paths);
    // Clean out the names of load functions.
573
    foreach ($paths as $index => $path) {
574 575 576 577 578 579 580 581 582
      $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
583

584
    $result = db_query('SELECT * FROM {menu_links} WHERE router_path IN (' . $placeholders . ') AND external = 0 ORDER BY depth DESC', $paths);
585 586 587 588 589 590 591
    // 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);
    }
  }

592 593 594
  drupal_set_installed_schema_version($module, SCHEMA_UNINSTALLED);
}

595 596 597 598 599 600 601 602 603 604
/**
 * 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
605
 *   TRUE on success or FALSE on failure. A message is set for the latter.
606 607 608 609 610 611 612 613 614
 */
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)) {
615
    $check = 'is_' . $type;
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 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 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716
    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.
 *
717 718 719 720 721 722 723 724 725
 * 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.
 *
726 727 728 729 730 731 732 733 734 735 736
 * @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) {
737
  $mod = fileperms($file) & 0777;
738
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
739 740 741 742 743

  // 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.
744 745 746 747 748
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
749
            $mod |= 0444;
750 751 752 753
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
754
            $mod |= 0222;
755 756 757 758
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
759
            $mod |= 0111;
760 761 762 763
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
764
            $mod &= ~0444;
765 766 767 768
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
769
            $mod &= ~0222;
770 771 772 773
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
774
            $mod &= ~0111;
775 776 777 778 779 780
          }
          break;
      }
    }
  }

781 782 783 784
  // 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)) {
785 786 787 788 789 790 791
    return TRUE;
  }
  else {
    return FALSE;
  }
}

792 793 794 795 796 797 798 799 800

/**
 * 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) {
801
  global $base_url;
802
  header('Location: ' . $base_url . '/' . $path);
803
  header('Cache-Control: no-cache'); // Not a permanent redirect.
804 805 806
  exit();
}

807
/**
808 809 810
 * Hardcoded function for doing the equivalent of t() during
 * the install process, when database, theme, and localization
 * system is possibly not yet available.
811 812
 */
function st($string, $args = array()) {
drumm's avatar
drumm committed
813 814 815 816 817
  static $locale_strings = NULL;
  global $profile, $install_locale;

  if (!isset($locale_strings)) {
    $locale_strings = array();
818
    $filename = './profiles/' . $profile . '/translations/' . $install_locale . '.po';
drumm's avatar
drumm committed
819 820 821 822 823 824 825 826
    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');
    }
  }

827
  require_once './includes/theme.inc';
828
  // Transform arguments before inserting them
829
  foreach ($args as $key => $value) {
830 831 832 833 834 835 836 837
    switch ($key[0]) {
      // Escaped only
      case '@':
        $args[$key] = check_plain($value);
        break;
      // Escaped and placeholder
      case '%':
      default:
838
        $args[$key] = '<em>' . check_plain($value) . '</em>';
839 840 841 842
        break;
      // Pass-through
      case '!':
    }
843
  }
844
  return strtr((!empty($locale_strings[$string]) ? $locale_strings[$string] : $string), $args);
845
}
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864

/**
 * 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.
865
  $function = $profile . '_profile_modules';
866
  $module_list = array_unique(array_merge(drupal_required_modules(), $function()));
867 868 869 870 871 872 873 874

  // 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;
875 876 877
    $function = $install->name. '_requirements';
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
878
    }
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
  }
  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) {
911 912
          $message = $requirement['description'];
          if (isset($requirement['value']) && $requirement['value']) {
913
            $message .= ' (' . t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) . ')';
914 915
          }
          drupal_set_message($message, 'error');
916 917 918 919 920 921 922
        }
      }
      return FALSE;
    }
  }
  return TRUE;
}