<?php

/**

* @file

* API functions for installing modules and themes.

*/

/**

 * Indicates that a module has not been installed yet.

 */

define('SCHEMA_UNINSTALLED', -1);

/**

 * Indicates that a module has been installed.

 */

define('SCHEMA_INSTALLED', 0);

/**

 * Requirement severity -- Informational message only.

 */

define('REQUIREMENT_INFO', -1);

/**

 * Requirement severity -- Requirement successfully met.

 */

define('REQUIREMENT_OK', 0);

/**

 * Requirement severity -- Warning condition; proceed but flag warning.

 */

define('REQUIREMENT_WARNING', 1);

/**

 * Requirement severity -- Error condition; abort installation.

 */

define('REQUIREMENT_ERROR', 2);

/**

 * 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.

 */

define('FILE_NOT_EXECUTABLE', 128);

/**

 * Loads .install files for installed modules to initialize the update system.

 */

function drupal_load_updates() {

  foreach (drupal_get_installed_schema_version(NULL, FALSE, TRUE) as $module => $schema_version) {

    if ($schema_version > -1) {

      module_load_install($module);

    }

  }

}

/**

 * Returns an array of available schema versions for a module.

 *

 * @param $module

 *   A module name.

 * @return

 *   If the module has updates, an array of available updates sorted by version.

 *   Otherwise, FALSE.

 */

function drupal_get_schema_versions($module) {

  $updates = &drupal_static(__FUNCTION__, NULL);

  if (!isset($updates[$module])) {

    $updates = array();

    foreach (module_list() as $loaded_module) {

      $updates[$loaded_module] = array();

    }

    // Prepare regular expression to match all possible defined hook_update_N().

    $regexp = '/^(?P<module>.+)_update_(?P<version>\d+)$/';

    $functions = get_defined_functions();

    // Narrow this down to functions ending with an integer, since all

    // hook_update_N() functions end this way, and there are other

    // possible functions which match '_update_'. We use preg_grep() here

    // instead of foreaching through all defined functions, since the loop

    // through all PHP functions can take significant page execution time

    // and this function is called on every administrative page via

    // system_requirements().

    foreach (preg_grep('/_\d+$/', $functions['user']) as $function) {

      // If this function is a module update function, add it to the list of

      // module updates.

      if (preg_match($regexp, $function, $matches)) {

        $updates[$matches['module']][] = $matches['version'];

      }

    }

    // Ensure that updates are applied in numerical order.

    foreach ($updates as &$module_updates) {

      sort($module_updates, SORT_NUMERIC);

    }

  }

  return empty($updates[$module]) ? FALSE : $updates[$module];

}

/**

 * Returns the currently installed schema version for a module.

 *

 * @param $module

 *   A module name.

 * @param $reset

 *   Set to TRUE after modifying the system table.

 * @param $array

 *   Set to TRUE if you want to get information about all modules in the

 *   system.

 * @return

 *   The currently installed schema version, or SCHEMA_UNINSTALLED if the

 *   module is not installed.

 */

function drupal_get_installed_schema_version($module, $reset = FALSE, $array = FALSE) {

  static $versions = array();

  if ($reset) {

    $versions = array();

  }

  if (!$versions) {

    $versions = array();

    $result = db_query("SELECT name, schema_version FROM {system} WHERE type = :type", array(':type' => 'module'));

    foreach ($result as $row) {

      $versions[$row->name] = $row->schema_version;

    }

  }

  if ($array) {

    return $versions;

  }

  else {

    return isset($versions[$module]) ? $versions[$module] : SCHEMA_UNINSTALLED;

  }

}

/**

 * 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_update('system')

    ->fields(array('schema_version' => $version))

    ->condition('name', $module)

    ->execute();

  // Reset the static cache of module schema versions.

  drupal_get_installed_schema_version(NULL, TRUE);

}

/**

 * Loads the installation profile, extracting its defined distribution name.

 *

 * @return

 *   The distribution name defined in the profile's .info file. Defaults to

 *   "Drupal" if none is explicitly provided by the installation profile.

 *

 * @see install_profile_info()

 */

function drupal_install_profile_distribution_name() {

  // During installation, the profile information is stored in the global

  // installation state (it might not be saved anywhere yet).

  if (drupal_installation_attempted()) {

    global $install_state;

    return $install_state['profile_info']['distribution_name'];

  }

  // At all other times, we load the profile via standard methods.

  else {

    $profile = drupal_get_profile();

    $info = system_get_info('module', $profile);

    return $info['distribution_name'];

  }

}

/**

 * Detects the base URL using the PHP $_SERVER 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'];

  $port = ($_SERVER['SERVER_PORT'] == 80 ? '' : ':' . $_SERVER['SERVER_PORT']);

  $uri = preg_replace("/\?.*/", '', $_SERVER['REQUEST_URI']);

  $dir = str_replace("/$file", '', $uri);

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

}

/**

 * Detects all supported databases that are compiled into PHP.

 *

 * @return

 *  An array of database types compiled into PHP.

 */

function drupal_detect_database_types() {

  $databases = drupal_get_database_types();

  foreach ($databases as $driver => $installer) {

    $databases[$driver] = $installer->name();

  }

  return $databases;

}

/**

 * Returns all supported database installer objects that are compiled into PHP.

 *

 * @return

 *  An array of database installer objects compiled into PHP.

 */

function drupal_get_database_types() {

  $databases = array();

  // 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.

  require_once DRUPAL_ROOT . '/includes/database/database.inc';

  foreach (file_scan_directory(DRUPAL_ROOT . '/includes/database', '/^[a-z]*$/i', array('recurse' => FALSE)) as $file) {

    if (file_exists($file->uri . '/database.inc') && file_exists($file->uri . '/install.inc')) {

      $drivers[$file->filename] = $file->uri;

    }

  }

  foreach ($drivers as $driver => $file) {

    $installer = db_installer_object($driver);

    if ($installer->installable()) {

      $databases[$driver] = $installer;

    }

  }

  // Usability: unconditionally put the MySQL driver on top.

  if (isset($databases['mysql'])) {

    $mysql_database = $databases['mysql'];

    unset($databases['mysql']);

    $databases = array('mysql' => $mysql_database) + $databases;

  }

  return $databases;

}

/**

 * 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(

      'function'    => 'checkEngineVersion',

      'arguments'   => 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 database server with the command %query. The server reports the following message: %error.<p>Are you sure the configured username has the necessary permissions to create tables in the database?</p>',

        TRUE,

      ),

    ),

    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 database server. We tried inserting a value with the command %query and the server reported the following error: %error.',

      ),

    ),

    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 database server. We tried updating a value with the command %query and the server reported the following error: %error.',

      ),

    ),

    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 database server. We tried deleting a value with the command %query and the server reported the following error: %error.',

      ),

    ),

    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 database server. We tried dropping a table with the command %query and the server reported the following error %error.',

      ),

    ),

  );

  /**

   * Results from tasks.

   *

   * @var array

   */

  protected $results = array();

  /**

   * Ensure the PDO driver is supported by the version of PHP in use.

   */

  protected function hasPdoDriver() {

    return in_array($this->pdoDriver, PDO::getAvailableDrivers());

  }

  /**

   * 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.

   */

  public function installable() {

    return $this->hasPdoDriver() && empty($this->error);

  }

  /**

   * Return the human-readable name of the driver.

   */

  abstract public function name();

  /**

   * Return the minimum required version of the engine.

   *

   * @return

   *   A version string. If not NULL, it will be checked against the version

   *   reported by the Database engine using version_compare().

   */

  public function minimumVersion() {

    return NULL;

  }

  /**

   * 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 {

          throw new DatabaseTaskException(st("Failed to run all tasks against the database server. The task %task wasn't found.", array('%task' => $task['function'])));

        }

      }

    }

    // Check for failed results and compile message

    $message = '';

    foreach ($this->results as $result => $success) {

      if (!$success) {

        $message .= '<p class="error">' . $result  . '</p>';

      }

    }

    if (!empty($message)) {

      $message = 'Resolve all issues below to continue the installation. For help configuring your database server, see the <a href="http://drupal.org/getting-started/install">installation handbook</a>, or contact your hosting provider.' . $message;

      throw new DatabaseTaskException($message);

    }

  }

  /**

   * Check if we can connect to the database.

   */

  protected function connect() {

    try {

      // This doesn't actually test the connection.

      db_set_active();

      // Now actually do a check.

      Database::getConnection();

      $this->pass('Drupal can CONNECT to the database ok.');

    }

    catch (Exception $e) {

      $this->fail(st('Failed to connect to your database server. The server reports the following message: %error.<ul><li>Is the database server running?</li><li>Does the database exist, and have you entered the correct database name?</li><li>Have you entered the correct username and password?</li><li>Have you entered the correct database hostname?</li></ul>', array('%error' => $e->getMessage())));

      return FALSE;

    }

    return TRUE;

  }

  /**

   * Run SQL tests to ensure the database can execute commands with the current user.