install.inc 30.3 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
 *   If the module has updates, an array of available updates sorted by version.
92
 *   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
  // Make sure updates are run in numeric order, not in definition order.
  sort($updates, SORT_NUMERIC);
111

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 138
    $result = db_query("SELECT name, schema_version FROM {system} WHERE type = :type", array(':type' => 'module'));
    foreach ($result as $row) {
139 140 141 142
      $versions[$row->name] = $row->schema_version;
    }
  }

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

/**
 * 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) {
155 156 157 158
  db_update('system')
    ->fields(array('schema_version' => $version))
    ->condition('name', $module)
    ->execute();
159
}
160 161

/**
162
 * Loads the install profile definition, extracting its defined name.
163 164 165 166 167 168 169 170 171 172
 *
 * @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.
173
    $function = $profile . '_profile_details';
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    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'];
196
  $port = ($_SERVER['SERVER_PORT'] == 80 ? '' : ':' . $_SERVER['SERVER_PORT']);
197
  $uri = preg_replace("/\?.*/", '', $_SERVER['REQUEST_URI']);
198 199 200 201 202 203
  $dir = str_replace("/$file", '', $uri);

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

/**
204
 * Detect all supported databases that are compiled into PHP.
205 206 207 208 209 210 211
 *
 * @return
 *  An array of database types compiled into PHP.
 */
function drupal_detect_database_types() {
  $databases = array();

212
  // We define a driver as a directory in /includes/database that in turn
213
  // contains a database.inc file. That allows us to drop in additional drivers
214 215 216
  // without modifying the installer.
  // Because we have no registry yet, we need to also include the install.inc
  // file for the driver explicitly.
217

218
  foreach (file_scan_directory(DRUPAL_ROOT . '/includes/database', '/^[a-z]*$/i', '/(\.\.?|CVS)$/', 0, FALSE) as $file) {
219 220
    include_once "{$file->filename}/install.inc";
    include_once "{$file->filename}/database.inc";
221
    $drivers[$file->basename] = $file->filename;
222 223 224
  }

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

232
  // Usability: unconditionally put the MySQL driver on top.
233 234 235 236 237
  if (isset($databases['mysql'])) {
    $mysql_database = $databases['mysql'];
    unset($databases['mysql']);
    $databases = array('mysql' => $mysql_database) + $databases;
  }
238

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
  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;
293 294
      }
    }
295
    return $this->success;
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 326 327
  /**
   * 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;
      }
    }
  }
328 329 330
}

/**
331
 * Replace values in settings.php with values in the submitted array.
332 333 334 335 336
 *
 * @param $settings
 *   An array of settings that need to be updated.
 */
function drupal_rewrite_settings($settings = array(), $prefix = '') {
337 338
  $default_settings = 'sites/default/default.settings.php';
  $settings_file = conf_path(FALSE, TRUE) . '/' . $prefix . 'settings.php';
339 340 341 342 343 344 345 346 347 348

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

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

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

421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
/**
 * Get a list of modules required by an installation profile.
 *
 * @param profile
 *   Name of profile.
 * @param locale
 *   Name of locale used (if any).
 * @return
 *   The list of modules to install.
 */
function drupal_get_profile_modules($profile, $locale = 'en') {
  $profile_file = "./profiles/$profile/$profile.profile";
  require_once($profile_file);

  // Get a list of modules required by this profile.
  $function = $profile . '_profile_modules';
437
  return array_merge(drupal_required_modules(), $function(), ($locale != 'en' && !empty($locale) ? array('locale') : array()));
438 439
}

440
/**
441
 * Verify an install profile for installation.
442
 *
443 444 445
 * @param $profile
 *   Name of install profile to verify.
 * @param $locale
drumm's avatar
drumm committed
446
 *   Name of locale used (if any).
Steven Wittens's avatar
Steven Wittens committed
447 448
 * @return
 *   The list of modules to install.
449
 */
drumm's avatar
drumm committed
450
function drupal_verify_profile($profile, $locale) {
451 452
  include_once DRUPAL_ROOT . '/includes/file.inc';
  include_once DRUPAL_ROOT . '/includes/common.inc';
453

454
  $profile_file = DRUPAL_ROOT . "/profiles/$profile/$profile.profile";
455 456

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

460
  $module_list = drupal_get_profile_modules($profile, $locale);
461

462 463
  // Get a list of modules that exist in Drupal's assorted subdirectories.
  $present_modules = array();
464
  foreach (drupal_system_listing('/\.module$/', 'modules', 'name', 0) as $present_module) {
465 466 467 468 469
    $present_modules[] = $present_module->name;
  }

  // Verify that all of the profile's required modules are present.
  $missing_modules = array_diff($module_list, $present_modules);
470 471

  $requirements = array();
472

473
  if (count($missing_modules)) {
474
    $modules = array();
475
    foreach ($missing_modules as $module) {
476
      $modules[] = '<span class="admin-missing">' . drupal_ucfirst($module) . '</span>';
Steven Wittens's avatar
Steven Wittens committed
477
    }
478 479 480 481 482 483
    $requirements['required_modules'] = array(
      'title'       => st('Required modules'),
      'value'       => st('Required modules not found.'),
      'severity'    => REQUIREMENT_ERROR,
      'description' => st('The following modules are required but were not found. Please move them into the appropriate modules subdirectory, such as <em>sites/all/modules</em>. Missing modules: !modules', array('!modules' => implode(', ', $modules))),
    );
Steven Wittens's avatar
Steven Wittens committed
484
  }
485
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
486
}
487

Steven Wittens's avatar
Steven Wittens committed
488
/**
489
 * Calls the install function for a given list of modules.
Steven Wittens's avatar
Steven Wittens committed
490
 *
491
 * @param $module_list
492 493 494
 *   The modules to install.
 */
function drupal_install_modules($module_list = array()) {
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
  $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);
513 514 515 516
  $modules_installed = array_filter($module_list, '_drupal_install_module');
  if (!empty($modules_installed)) {
    module_invoke_all('modules_installed', $modules_installed);
  }
517 518 519 520
  module_enable($module_list);
}

/**
521
 * Callback to install an individual install profile module.
522 523 524 525
 *
 * 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.
526 527 528 529 530
 *
 * @param $module
 *   The machine name of the module to install.
 * @return
 *   TRUE if the module got installed.
Steven Wittens's avatar
Steven Wittens committed
531
 */
532 533 534 535 536 537 538 539 540
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
541

542 543 544 545 546 547 548 549
/**
 * 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;
550

551 552 553
  if (!$included) {
    $connection_info = Database::getConnectionInfo();
    $driver = $connection_info['default']['driver'];
554 555 556 557 558
    require_once DRUPAL_ROOT . '/includes/database/query.inc';
    require_once DRUPAL_ROOT . '/includes/database/select.inc';
    require_once DRUPAL_ROOT . '/includes/database/schema.inc';
    foreach (glob(DRUPAL_ROOT . '/includes/database/' . $driver . '/*.inc') as $include_file) {
      require_once $include_file;
559
    }
560
    $included = TRUE;
561 562 563
  }
}

564 565 566 567 568 569 570
/**
 * 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
571
  $system_path = dirname(drupal_get_filename('module', 'system', NULL));
572
  require_once DRUPAL_ROOT . '/' . $system_path . '/system.install';
573
  drupal_install_init_database();
Steven Wittens's avatar
Steven Wittens committed
574
  module_invoke('system', 'install');
575

Steven Wittens's avatar
Steven Wittens committed
576 577
  $system_versions = drupal_get_schema_versions('system');
  $system_version = $system_versions ? max($system_versions) : SCHEMA_INSTALLED;
578 579 580 581 582 583 584 585 586 587 588
  db_insert('system')
    ->fields(array('filename', 'name', 'type', 'owner', 'status', 'schema_version'))
    ->values(array(
        'filename' => $system_path . '/system.module',
        'name' => 'system',
        'type' => 'module',
        'owner' => '',
        'status' => 1,
        'schema_version' => $system_version
        ))
    ->execute();
Steven Wittens's avatar
Steven Wittens committed
589
  // Now that we've installed things properly, bootstrap the full Drupal environment
590
  drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
Steven Wittens's avatar
Steven Wittens committed
591
  module_rebuild_cache();
592 593
}

594 595 596
/**
 * Calls the uninstall function and updates the system table for a given module.
 *
597 598
 * @param $module_list
 *   The modules to uninstall.
599
 */
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
function drupal_uninstall_modules($module_list = array()) {
  foreach ($module_list as $module) {
    // First, retrieve all the module's menu paths from db.
    drupal_load('module', $module);
    $paths = module_invoke($module, 'menu');

    // Uninstall the module.
    module_load_install($module);
    module_invoke($module, 'uninstall');

    // Now remove the menu links for all paths declared by this module.
    if (!empty($paths)) {
      $paths = array_keys($paths);
      // Clean out the names of load functions.
      foreach ($paths as $index => $path) {
        $parts = explode('/', $path, MENU_MAX_PARTS);
        foreach ($parts as $k => $part) {
          if (preg_match('/^%[a-z_]*$/', $part)) {
            $parts[$k] = '%';
          }
620
        }
621
        $paths[$index] = implode('/', $parts);
622
      }
623
      $placeholders = implode(', ', array_fill(0, count($paths), "'%s'"));
Dries's avatar
Dries committed
624

625 626 627 628 629 630
      $result = db_select('menu_links')
         ->fields('menu_links')
         ->condition('router_path', $paths, 'IN')
         ->condition('external', 0)
         ->orderBy('depth')
         ->execute();
631 632
      // Remove all such items. Starting from those with the greatest depth will
      // minimize the amount of re-parenting done by menu_link_delete().
633
      foreach ($result as $item) {
634 635
        _menu_delete_item($item, TRUE);
      }
636
    }
637 638

    drupal_set_installed_schema_version($module, SCHEMA_UNINSTALLED);
639 640
  }

641 642 643 644
  if (!empty($module_list)) {
    // Call hook_module_uninstall to let other modules act
    module_invoke_all('modules_uninstalled', $module_list);
  }
645 646
}

647 648 649 650 651 652 653 654 655 656
/**
 * 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
657
 *   TRUE on success or FALSE on failure. A message is set for the latter.
658 659 660 661 662 663 664 665 666
 */
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)) {
667
    $check = 'is_' . $type;
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
    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.
 *
729
 * @param $file
730
 *  The name of the directory to create;
731
 * @param $mask
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
 *  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.
 *
768 769 770 771 772 773 774 775 776
 * 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.
 *
777 778 779 780 781 782 783 784 785 786
 * @param $file
 *  The name of the file with permissions to fix.
 * @param $mask
 *  The desired permissions for the file.
 * @param $message
 *  (optional) Whether to output messages. Defaults to TRUE.
 * @return
 *  TRUE/FALSE whether or not we were able to fix the file's permissions.
 */
function drupal_install_fix_file($file, $mask, $message = TRUE) {
787 788 789 790 791
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

792
  $mod = fileperms($file) & 0777;
793
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
794 795 796 797 798

  // 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.
799 800 801 802 803
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
804
            $mod |= 0444;
805 806 807 808
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
809
            $mod |= 0222;
810 811 812 813
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
814
            $mod |= 0111;
815 816 817 818
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
819
            $mod &= ~0444;
820 821 822 823
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
824
            $mod &= ~0222;
825 826 827 828
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
829
            $mod &= ~0111;
830 831 832 833 834 835
          }
          break;
      }
    }
  }

836 837 838 839
  // 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)) {
840 841 842 843 844 845 846
    return TRUE;
  }
  else {
    return FALSE;
  }
}

847 848

/**
849
 * Send the user to a different installer page.
850 851
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
852 853 854 855 856
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
857
  global $base_url;
858
  header('Location: ' . $base_url . '/' . $path);
859
  header('Cache-Control: no-cache'); // Not a permanent redirect.
860 861 862
  exit();
}

863
/**
864 865 866
 * Functional equivalent of t(), used when some systems are not available.
 *
 * Used during the install process, when database, theme, and localization
867
 * system is possibly not yet available.
868 869
 *
 * @see t()
870 871
 */
function st($string, $args = array()) {
drumm's avatar
drumm committed
872 873 874 875 876
  static $locale_strings = NULL;
  global $profile, $install_locale;

  if (!isset($locale_strings)) {
    $locale_strings = array();
877 878 879
    $filename = 'profiles/' . $profile . '/translations/' . $install_locale . '.po';
    if (file_exists(DRUPAL_ROOT . '/' . $filename)) {
      require_once DRUPAL_ROOT . '/includes/locale.inc';
drumm's avatar
drumm committed
880 881 882 883 884 885
      $file = (object) array('filepath' => $filename);
      _locale_import_read_po('mem-store', $file);
      $locale_strings = _locale_import_one_string('mem-report');
    }
  }

886
  require_once DRUPAL_ROOT . '/includes/theme.inc';
887
  // Transform arguments before inserting them
888
  foreach ($args as $key => $value) {
889 890 891 892 893 894 895 896
    switch ($key[0]) {
      // Escaped only
      case '@':
        $args[$key] = check_plain($value);
        break;
      // Escaped and placeholder
      case '%':
      default:
897
        $args[$key] = '<em>' . check_plain($value) . '</em>';
898 899 900 901
        break;
      // Pass-through
      case '!':
    }
902
  }
903
  return strtr((!empty($locale_strings[$string]) ? $locale_strings[$string] : $string), $args);
904
}
905 906

/**
907
 * Check an install profile's requirements.
908
 *
909 910 911 912
 * @param $profile
 *   Name of install profile to check.
 * @return
 *   Array of the install profile's requirements.
913 914
 */
function drupal_check_profile($profile) {
915
  include_once DRUPAL_ROOT . '/includes/file.inc';
916

917
  $profile_file = DRUPAL_ROOT . "/profiles/$profile/$profile.profile";
918 919 920 921 922

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

923
  require_once $profile_file;
924 925

  // Get a list of modules required by this profile.
926
  $function = $profile . '_profile_modules';
927
  $module_list = array_unique(array_merge(drupal_required_modules(), $function()));
928 929 930 931 932 933 934

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

  // Collect requirement testing results
  $requirements = array();
  foreach ($installs as $install) {
935
    require_once DRUPAL_ROOT . '/' . $install->filename;
936 937 938
    $function = $install->name. '_requirements';
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
939
    }
940 941 942 943 944 945
  }
  return $requirements;
}

/**
 * Extract highest severity from requirements array.
946 947
 *
 * @param $requirements
948
 *   An array of requirements, in the same format as is returned by
949 950 951
 *   hook_requirements().
 * @return
 *   The highest severity in the array.
952 953 954 955 956 957 958 959 960 961 962 963 964
 */
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.
965 966 967 968 969
 *
 * @param $module
 *   Machine name of module to check.
 * @return
 *   TRUE/FALSE depending on the requirements are in place.
970 971 972 973 974
 */
function drupal_check_module($module) {
  // Include install file
  $install = drupal_get_install_files(array($module));
  if (isset($install[$module])) {
975
    require_once DRUPAL_ROOT . '/' . $install[$module]->filename;
976 977 978 979 980 981 982

    // 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) {
983 984
          $message = $requirement['description'];
          if (isset($requirement['value']) && $requirement['value']) {
985
            $message .= ' (' . t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) . ')';
986 987
          }
          drupal_set_message($message, 'error');
988 989 990 991 992 993 994
        }
      }
      return FALSE;
    }
  }
  return TRUE;
}