install.inc 33.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
 *   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
 *
 * @return
 *   The name defined in the profile's _profile_details() hook.
 */
function drupal_install_profile_name() {
168 169
  global $install_state;
  $profile = $install_state['parameters']['profile'];
170 171 172 173
  static $name = NULL;

  if (!isset($name)) {
    // Load profile details.
174
    $function = $profile . '_profile_details';
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') {
  $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
  require_once DRUPAL_ROOT . '/includes/database/database.inc';
218
  foreach (file_scan_directory(DRUPAL_ROOT . '/includes/database', '/^[a-z]*$/i', array('recurse' => FALSE)) as $file) {
219 220 221
    include_once "{$file->uri}/install.inc";
    include_once "{$file->uri}/database.inc";
    $drivers[$file->filename] = $file->uri;
222 223 224
  }

  foreach ($drivers as $driver => $file) {
225
    $class = 'DatabaseTasks_' . $driver;
226 227 228 229 230
    $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
  return $databases;
}

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
/**
 * Database installer structure.
 *
 * Defines basic Drupal requirements for databases.
 */
abstract class DatabaseTasks {

  /**
   * Structure that describes each task to run.
   *
   * @var array
   *
   * Each value of the tasks array is an associative array defining the function
   * to call (optional) and any arguments to be passed to the function.
   */
  protected $tasks = array(
    array(
      'arguments'   => array(
        'CREATE TABLE drupal_install_test (id int NULL)',
        'Drupal can use CREATE TABLE database commands.',
        'Failed to <strong>CREATE</strong> a test table on your %name database server with the command %query. %name reports the following message: %error.<p>Are you sure the configured username has the necessary %name permissions to create tables in the database?</p>',
        TRUE,
      ),
265
    ),
266 267 268 269 270 271
    array(
      'arguments'   => array(
        'INSERT INTO drupal_install_test (id) VALUES (1)',
        'Drupal can use INSERT database commands.',
        'Failed to <strong>INSERT</strong> 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.',
      ),
272
    ),
273 274 275 276 277 278
    array(
      'arguments'   => array(
        'UPDATE drupal_install_test SET id = 2',
        'Drupal can use UPDATE database commands.',
        'Failed to <strong>UPDATE</strong> 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.',
      ),
279
    ),
280 281 282 283 284 285
    array(
      'arguments'   => array(
        'DELETE FROM drupal_install_test',
        'Drupal can use DELETE database commands.',
        'Failed to <strong>DELETE</strong> 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.',
      ),
286
    ),
287 288 289 290 291 292
    array(
      'arguments'   => array(
        'DROP TABLE drupal_install_test',
        'Drupal can use DROP TABLE database commands.',
        'Failed to <strong>DROP</strong> a test table from your %name database server. We tried dropping a table with the command %query and %name reported the following error %error.',
      ),
293 294
    ),
  );
295 296 297 298 299 300
  /**
   * Results from tasks.
   *
   * @var array
   */
  protected $results = array();
301

302 303 304
  /**
   * Ensure the PDO driver is supported by the version of PHP in use.
   */
305 306 307 308
  protected function hasPdoDriver() {
    return in_array($this->pdoDriver, PDO::getAvailableDrivers());
  }

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
  /**
   * Assert test as failed.
   */
  protected function fail($message) {
    $this->results[$message] = FALSE;
  }

  /**
   * Assert test as a pass.
   */
  protected function pass($message) {
    $this->results[$message] = TRUE;
  }

  /**
   * Check whether Drupal is installable on the database.
   */
326
  public function installable() {
327
    return $this->hasPdoDriver() && empty($this->error);
328 329 330 331
  }

  abstract public function name();

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
  /**
   * Run database tasks and tests to see if Drupal can run on the database.
   */
  public function runTasks() {
    // We need to establish a connection before we can run tests.
    if ($this->connect()) {
      foreach ($this->tasks as $task) {
        if (!isset($task['function'])) {
          $task['function'] = 'runTestQuery';
        }
        if (method_exists($this, $task['function'])) {
          // Returning false is fatal. No other tasks can run.
          if (FALSE === call_user_func_array(array($this, $task['function']), $task['arguments'])) {
            break;
          }
        }
        else {
349
          throw new DatabaseTaskException(st("Failed to run all tasks against the database server. The task %task wasn't found.", array('%task' => $task['function'])));
350 351
        }
      }
352
    }
353 354 355 356 357
    // Check for failed results and compile message
    $message = '';
    foreach ($this->results as $result => $success) {
      if (!$success) {
        $message .= '<p class="error">' . $result  . '</p>';
358 359
      }
    }
360 361 362 363
    if (!empty($message)) {
      $message = '<p>In order for Drupal to work, and to continue with the installation process, you must resolve all issues reported below. For more help with configuring your database server, see the <a href="http://drupal.org/node/258">Installation and upgrading handbook</a>. If you are unsure what any of this means you should probably contact your hosting provider.</p>' . $message;
      throw new DatabaseTaskException($message);
    }
364 365
  }

366 367 368
  /**
   * Check if we can connect to the database.
   */
369
  protected function connect() {
370
    try {
371
      // This doesn't actually test the connection.
372
      db_set_active();
373 374
      // Now actually do a check.
      Database::getConnection();
375
      $this->pass('Drupal can CONNECT to the database ok.');
376 377
    }
    catch (Exception $e) {
378
      $this->fail(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())));
379 380
      return FALSE;
    }
381
    return TRUE;
382 383
  }

384 385 386 387
  /**
   * Run SQL tests to ensure the database can execute commands with the current user.
   */
  protected function runTestQuery($query, $pass, $fail, $fatal = FALSE) {
388 389
    try {
      db_query($query);
390
      $this->pass(st($pass));
391 392
    }
    catch (Exception $e) {
393 394
      $this->fail(st($fail, array('%query' => $query, '%error' => $e->getMessage(), '%name' => $this->name())));
      return !$fatal;
395 396
    }
  }
397
}
398 399 400 401 402
/**
 * @class Exception class used to throw error if the DatabaseInstaller fails.
 */
class DatabaseTaskException extends Exception {
}
403 404

/**
405
 * Replace values in settings.php with values in the submitted array.
406 407 408 409 410
 *
 * @param $settings
 *   An array of settings that need to be updated.
 */
function drupal_rewrite_settings($settings = array(), $prefix = '') {
411
  $default_settings = 'sites/default/default.settings.php';
412 413
  drupal_static_reset('conf_path');
  $settings_file = conf_path(FALSE) . '/' . $prefix . 'settings.php';
414 415 416 417 418 419 420 421 422 423

  // 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;
424
  if ($fp = fopen(DRUPAL_ROOT . '/' . $default_settings, 'r')) {
425 426 427 428 429 430 431 432 433 434 435 436
    // 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]];
437
          $buffer .= str_replace($variable[2], " '" . $setting['value'] . "'", $line);
438 439 440 441 442 443 444 445 446 447 448 449 450 451
          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]];
452
          $buffer .= '$' . $variable[1] . " = " . var_export($setting['value'], TRUE) . ";" . (!empty($setting['comment']) ? ' // ' . $setting['comment'] . "\n" : "\n");
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
          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']) {
468
        $buffer .= "\$$setting = " . var_export($data['value'], TRUE) . ";\n";
469 470 471
      }
    }

472
    $fp = fopen(DRUPAL_ROOT . '/' . $settings_file, 'w');
473
    if ($fp && fwrite($fp, $buffer) === FALSE) {
474
      throw new Exception(st('Failed to modify %settings, please verify the file permissions.', array('%settings' => $settings_file)));
475 476 477
    }
  }
  else {
478
    throw new Exception(st('Failed to open %settings, please verify the file permissions.', array('%settings' => $default_settings)));
479 480 481 482 483 484 485 486 487 488 489 490
  }
}

/**
 * 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) {
491
    $installs = array_merge($installs, drupal_system_listing('/' . $module . '.install$/', 'modules'));
492 493 494 495
  }
  return $installs;
}

496

497
/**
498
 * Verify an install profile for installation.
499
 *
500 501
 * @param $install_state
 *   An array of information about the current installation state.
Steven Wittens's avatar
Steven Wittens committed
502 503
 * @return
 *   The list of modules to install.
504
 */
505 506 507 508
function drupal_verify_profile($install_state) {
  $profile = $install_state['parameters']['profile'];
  $locale = $install_state['parameters']['locale'];

509 510
  include_once DRUPAL_ROOT . '/includes/file.inc';
  include_once DRUPAL_ROOT . '/includes/common.inc';
511

512
  $profile_file = DRUPAL_ROOT . "/profiles/$profile/$profile.profile";
513 514

  if (!isset($profile) || !file_exists($profile_file)) {
515
    throw new Exception(install_no_profile_error());
516
  }
517
  $info = $install_state['profile_info'];
518

519 520
  // Get a list of modules that exist in Drupal's assorted subdirectories.
  $present_modules = array();
521
  foreach (drupal_system_listing('/\.module$/', 'modules', 'name', 0) as $present_module) {
522 523 524 525
    $present_modules[] = $present_module->name;
  }

  // Verify that all of the profile's required modules are present.
526
  $missing_modules = array_diff($info['dependencies'], $present_modules);
527 528

  $requirements = array();
529

530
  if (count($missing_modules)) {
531
    $modules = array();
532
    foreach ($missing_modules as $module) {
533
      $modules[] = '<span class="admin-missing">' . drupal_ucfirst($module) . '</span>';
Steven Wittens's avatar
Steven Wittens committed
534
    }
535 536 537 538 539 540
    $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
541
  }
542
  return $requirements;
Steven Wittens's avatar
Steven Wittens committed
543
}
544

Steven Wittens's avatar
Steven Wittens committed
545
/**
546
 * Calls the install function for a given list of modules.
Steven Wittens's avatar
Steven Wittens committed
547
 *
548
 * @param $module_list
549
 *   The modules to install.
Dries's avatar
 
Dries committed
550 551
 * @param $disable_modules_installed_hook
 *   Normally just testing wants to set this to TRUE.
552
 */
Dries's avatar
 
Dries committed
553
function drupal_install_modules($module_list = array(), $disable_modules_installed_hook = FALSE) {
554
  $files = system_get_module_data();
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
  $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);
572
  module_enable($module_list, $disable_modules_installed_hook);
573 574 575
}

/**
576
 * Callback to install an individual install profile module.
577 578 579
 *
 * Used during installation to install modules one at a time and then
 * enable them, or to install a number of modules at one time
580
 * from admin/config/modules.
581 582 583 584 585
 *
 * @param $module
 *   The machine name of the module to install.
 * @return
 *   TRUE if the module got installed.
Steven Wittens's avatar
Steven Wittens committed
586
 */
587 588 589
function _drupal_install_module($module) {
  if (drupal_get_installed_schema_version($module, TRUE) == SCHEMA_UNINSTALLED) {
    module_load_install($module);
590
    drupal_load('module', $module);
591 592 593 594 595 596
    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
597

598 599 600 601 602 603
/**
 * Manually include all files for the active database.
 *
 * Because we have no registry yet, we need to manually include the
 * necessary database include files.
 */
604
function drupal_install_initialize_database() {
605
  static $included = FALSE;
606

607 608 609
  if (!$included) {
    $connection_info = Database::getConnectionInfo();
    $driver = $connection_info['default']['driver'];
610 611 612 613 614
    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;
615
    }
616
    $included = TRUE;
617 618 619
  }
}

620 621 622 623 624 625 626
/**
 * 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
627
  $system_path = dirname(drupal_get_filename('module', 'system', NULL));
628
  require_once DRUPAL_ROOT . '/' . $system_path . '/system.install';
629
  drupal_install_initialize_database();
Steven Wittens's avatar
Steven Wittens committed
630
  module_invoke('system', 'install');
631

Steven Wittens's avatar
Steven Wittens committed
632 633
  $system_versions = drupal_get_schema_versions('system');
  $system_version = $system_versions ? max($system_versions) : SCHEMA_INSTALLED;
634 635 636 637 638 639 640 641 642 643 644
  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
645
  // Now that we've installed things properly, bootstrap the full Drupal environment
646
  drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
647
  system_get_module_data();
648 649
}

650 651 652
/**
 * Calls the uninstall function and updates the system table for a given module.
 *
653 654
 * @param $module_list
 *   The modules to uninstall.
655
 */
656 657 658 659 660 661 662 663 664
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');
665
    watchdog('system', '%module module uninstalled.', array('%module' => $module), WATCHDOG_INFO);
666 667 668 669 670 671 672 673 674 675 676

    // 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] = '%';
          }
677
        }
678
        $paths[$index] = implode('/', $parts);
679
      }
Dries's avatar
Dries committed
680

681
      $result = db_select('menu_links')
682 683 684 685 686
        ->fields('menu_links')
        ->condition('router_path', $paths, 'IN')
        ->condition('external', 0)
        ->orderBy('depth')
        ->execute();
687 688
      // Remove all such items. Starting from those with the greatest depth will
      // minimize the amount of re-parenting done by menu_link_delete().
689
      foreach ($result as $item) {
690 691
        _menu_delete_item($item, TRUE);
      }
692
    }
693 694

    drupal_set_installed_schema_version($module, SCHEMA_UNINSTALLED);
695 696
  }

697 698 699 700
  if (!empty($module_list)) {
    // Call hook_module_uninstall to let other modules act
    module_invoke_all('modules_uninstalled', $module_list);
  }
701 702
}

703 704 705 706 707 708 709 710 711 712
/**
 * 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
713
 *   TRUE on success or FALSE on failure. A message is set for the latter.
714 715 716 717 718 719 720 721 722
 */
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)) {
723
    $check = 'is_' . $type;
724 725 726 727 728 729 730 731 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 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
    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.
 *
785
 * @param $file
786
 *  The name of the directory to create;
787
 * @param $mask
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
 *  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;
      }
    }
  }

813
  if (@drupal_mkdir($file, intval("0$mod", 8))) {
814 815 816 817 818 819 820 821 822 823
    return TRUE;
  }
  else {
    return FALSE;
  }
}

/**
 * Attempt to fix file permissions.
 *
824 825 826 827 828 829 830 831 832
 * 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.
 *
833 834 835 836 837 838 839 840 841 842
 * @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) {
843 844 845 846 847
  // If $file does not exist, fileperms() issues a PHP warning.
  if (!file_exists($file)) {
    return FALSE;
  }

848
  $mod = fileperms($file) & 0777;
849
  $masks = array(FILE_READABLE, FILE_WRITABLE, FILE_EXECUTABLE, FILE_NOT_READABLE, FILE_NOT_WRITABLE, FILE_NOT_EXECUTABLE);
850 851 852 853 854

  // 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.
855 856 857 858 859
  foreach ($masks as $m) {
    if ($mask & $m) {
      switch ($m) {
        case FILE_READABLE:
          if (!is_readable($file)) {
860
            $mod |= 0444;
861 862 863 864
          }
          break;
        case FILE_WRITABLE:
          if (!is_writable($file)) {
865
            $mod |= 0222;
866 867 868 869
          }
          break;
        case FILE_EXECUTABLE:
          if (!is_executable($file)) {
870
            $mod |= 0111;
871 872 873 874
          }
          break;
        case FILE_NOT_READABLE:
          if (is_readable($file)) {
875
            $mod &= ~0444;
876 877 878 879
          }
          break;
        case FILE_NOT_WRITABLE:
          if (is_writable($file)) {
880
            $mod &= ~0222;
881 882 883 884
          }
          break;
        case FILE_NOT_EXECUTABLE:
          if (is_executable($file)) {
885
            $mod &= ~0111;
886 887 888 889 890 891
          }
          break;
      }
    }
  }

892 893 894 895
  // 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)) {
896 897 898 899 900 901 902
    return TRUE;
  }
  else {
    return FALSE;
  }
}

903 904

/**
905
 * Send the user to a different installer page.
906 907
 *
 * This issues an on-site HTTP redirect. Messages (and errors) are erased.
908 909 910 911 912
 *
 * @param $path
 *   An installer path.
 */
function install_goto($path) {
913
  global $base_url;
914
  header('Location: ' . $base_url . '/' . $path);
915
  header('Cache-Control: no-cache'); // Not a permanent redirect.
916 917 918
  exit();
}

919
/**
920 921 922
 * Functional equivalent of t(), used when some systems are not available.
 *
 * Used during the install process, when database, theme, and localization
923
 * system is possibly not yet available.
924 925
 *
 * @see t()
926 927
 */
function st($string, $args = array()) {
drumm's avatar
drumm committed
928
  static $locale_strings = NULL;
929
  global $install_state;
drumm's avatar
drumm committed
930 931 932

  if (!isset($locale_strings)) {
    $locale_strings = array();
933 934
    if (isset($install_state['parameters']['profile']) && isset($install_state['parameters']['locale'])) {
    $filename = 'profiles/' . $install_state['parameters']['profile'] . '/translations/' . $install_state['parameters']['locale'] . '.po';
935 936
    if (file_exists(DRUPAL_ROOT . '/' . $filename)) {
      require_once DRUPAL_ROOT . '/includes/locale.inc';
937
      $file = (object) array('uri' => $filename);
drumm's avatar
drumm committed
938 939 940
      _locale_import_read_po('mem-store', $file);
      $locale_strings = _locale_import_one_string('mem-report');
    }
941
    }
drumm's avatar
drumm committed
942 943
  }

944
  require_once DRUPAL_ROOT . '/includes/theme.inc';
945
  // Transform arguments before inserting them
946
  foreach ($args as $key => $value) {
947 948 949 950 951 952 953 954
    switch ($key[0]) {
      // Escaped only
      case '@':
        $args[$key] = check_plain($value);
        break;
      // Escaped and placeholder
      case '%':
      default:
955
        $args[$key] = '<em>' . check_plain($value) . '</em>';
956 957 958 959
        break;
      // Pass-through
      case '!':
    }
960
  }
961
  return strtr((!empty($locale_strings[$string]) ? $locale_strings[$string] : $string), $args);
962
}
963 964

/**
965
 * Check an install profile's requirements.
966
 *
967 968 969 970
 * @param $profile
 *   Name of install profile to check.
 * @return
 *   Array of the install profile's requirements.
971 972
 */
function drupal_check_profile($profile) {
973
  include_once DRUPAL_ROOT . '/includes/file.inc';
974

975
  $profile_file = DRUPAL_ROOT . "/profiles/$profile/$profile.profile";
976 977

  if (!isset($profile) || !file_exists($profile_file)) {
978
    throw new Exception(install_no_profile_error());
979 980
  }

981
  $info = install_profile_info($profile);
982 983

  // Get a list of all .install files.
984
  $installs = drupal_get_install_files($info['dependencies']);
985 986 987 988

  // Collect requirement testing results
  $requirements = array();
  foreach ($installs as $install) {
989
    require_once DRUPAL_ROOT . '/' . $install->uri;
990
    $function = $install->name . '_requirements';
991 992
    if (function_exists($function)) {
      $requirements = array_merge($requirements, $function('install'));
993
    }
994 995 996 997 998 999
  }
  return $requirements;
}

/**
 * Extract highest severity from requirements array.
1000 1001
 *
 * @param $requirements
1002
 *   An array of requirements, in the same format as is returned by
1003 1004 1005
 *   hook_requirements().
 * @return
 *   The highest severity in the array.
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
 */
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.
1019 1020 1021 1022 1023
 *
 * @param $module
 *   Machine name of module to check.
 * @return
 *   TRUE/FALSE depending on the requirements are in place.
1024 1025 1026 1027 1028
 */
function drupal_check_module($module) {
  // Include install file
  $install = drupal_get_install_files(array($module));
  if (isset($install[$module])) {
1029
    require_once DRUPAL_ROOT . '/' . $install[$module]->uri;
1030 1031 1032 1033 1034 1035 1036

    // 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) {
1037 1038
          $message = $requirement['description'];
          if (isset($requirement['value']) && $requirement['value']) {
1039
            $message .= ' (' . t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) . ')';
1040 1041
          }
          drupal_set_message($message, 'error');
1042 1043 1044 1045 1046 1047 1048
        }
      }
      return FALSE;
    }
  }
  return TRUE;
}
1049 1050 1051

/**
 * Retrieve info about an install profile from its .info file.