<?php

// $Id: install.php,v 1.113.2.9 2009/04/27 10:50:35 goba Exp $

require_once './includes/install.inc';

define('MAINTENANCE_MODE', 'install');

/**

 * The Drupal installation happens in a series of steps. We begin by verifying

 * that the current environment meets our minimum requirements. We then go

 * on to verify that settings.php is properly configured. From there we

 * connect to the configured database and verify that it meets our minimum

 * requirements. Finally we can allow the user to select an installation

 * profile and complete the installation process.

 *

 * @param $phase

 *   The installation phase we should proceed to.

 */

function install_main() {

  require_once './includes/bootstrap.inc';

  drupal_bootstrap(DRUPAL_BOOTSTRAP_CONFIGURATION);

  // This must go after drupal_bootstrap(), which unsets globals!

  global $profile, $install_locale, $conf;

  require_once './modules/system/system.install';

  require_once './includes/file.inc';

  // Ensure correct page headers are sent (e.g. caching)

  drupal_page_header();

  // Set up $language, so t() caller functions will still work.

  drupal_init_language();

  // Load module basics (needed for hook invokes).

  include_once './includes/module.inc';

  $module_list['system']['filename'] = 'modules/system/system.module';

  $module_list['filter']['filename'] = 'modules/filter/filter.module';

  module_list(TRUE, FALSE, FALSE, $module_list);

  drupal_load('module', 'system');

  drupal_load('module', 'filter');

  // Set up theme system for the maintenance page.

  drupal_maintenance_theme();

  // Check existing settings.php.

  $verify = install_verify_settings();

  if ($verify) {

    // Since we have a database connection, we use the normal cache system.

    // This is important, as the installer calls into the Drupal system for

    // the clean URL checks, so we should maintain the cache properly.

    require_once './includes/cache.inc';

    $conf['cache_inc'] = './includes/cache.inc';

    // Establish a connection to the database.

    require_once './includes/database.inc';

    db_set_active();

    // Check if Drupal is installed.

    $task = install_verify_drupal();

    if ($task == 'done') {

      install_already_done_error();

    }

  }

  else {

    // Since no persistent storage is available yet, and functions that check

    // for cached data will fail, we temporarily replace the normal cache

    // system with a stubbed-out version that short-circuits the actual

    // caching process and avoids any errors.

    require_once './includes/cache-install.inc';

    $conf['cache_inc'] = './includes/cache-install.inc';

    $task = NULL;

  }

  // Decide which profile to use.

  if (!empty($_GET['profile'])) {

    $profile = preg_replace('/[^a-zA-Z_0-9]/', '', $_GET['profile']);

  }

  elseif ($profile = install_select_profile()) {

    install_goto("install.php?profile=$profile");

  }

  else {

    install_no_profile_error();

  }

  // Load the profile.

  require_once "./profiles/$profile/$profile.profile";

  // Locale selection

  if (!empty($_GET['locale'])) {

    $install_locale = preg_replace('/[^a-zA-Z_0-9\-]/', '', $_GET['locale']);

  }

  elseif (($install_locale = install_select_locale($profile)) !== FALSE) {

    install_goto("install.php?profile=$profile&locale=$install_locale");

  }

  // Tasks come after the database is set up

  if (!$task) {

    global $db_url;

    if (!$verify && !empty($db_url)) {

      // Do not install over a configured settings.php.

      install_already_done_error();

    }

    // Check the installation requirements for Drupal and this profile.

    install_check_requirements($profile, $verify);

    // Verify existence of all required modules.

    $modules = drupal_verify_profile($profile, $install_locale);

    // If any error messages are set now, it means a requirement problem.

    $messages = drupal_set_message();

    if (!empty($messages['error'])) {

      install_task_list('requirements');

      drupal_set_title(st('Requirements problem'));

      print theme('install_page', '');

      exit;

    }

    // Change the settings.php information if verification failed earlier.

    // Note: will trigger a redirect if database credentials change.

    if (!$verify) {

      install_change_settings($profile, $install_locale);

    }

    // Install system.module.

    drupal_install_system();

    // Save the list of other modules to install for the 'profile-install'

    // task. variable_set() can be used now that system.module is installed

    // and drupal is bootstrapped.

    variable_set('install_profile_modules', array_diff($modules, array('system')));

  }

  // The database is set up, turn to further tasks.

  install_tasks($profile, $task);

}

/**

 * Verify if Drupal is installed.

 */

function install_verify_drupal() {

  // Read the variable manually using the @ so we don't trigger an error if it fails.

  $result = @db_query("SELECT value FROM {variable} WHERE name = '%s'", 'install_task');

  if ($result) {

    return unserialize(db_result($result));

  }

}

/**

 * Verify existing settings.php

 */

function install_verify_settings() {

  global $db_prefix, $db_type, $db_url;

  // Verify existing settings (if any).

  if (!empty($db_url)) {

    // We need this because we want to run form_get_errors.

    include_once './includes/form.inc';

    $url = parse_url(is_array($db_url) ? $db_url['default'] : $db_url);

    $db_user = urldecode($url['user']);

    $db_pass = isset($url['pass']) ? urldecode($url['pass']) : NULL;

    $db_host = urldecode($url['host']);

    $db_port = isset($url['port']) ? urldecode($url['port']) : '';

    $db_path = ltrim(urldecode($url['path']), '/');

    $settings_file = './'. conf_path(FALSE, TRUE) .'/settings.php';

    $form_state = array();

    _install_settings_form_validate($db_prefix, $db_type, $db_user, $db_pass, $db_host, $db_port, $db_path, $settings_file, $form_state);

    if (!form_get_errors()) {

      return TRUE;

    }

  }

  return FALSE;

}

/**

 * Configure and rewrite settings.php.

 */

function install_change_settings($profile = 'default', $install_locale = '') {

  global $db_url, $db_type, $db_prefix;

  $url = parse_url(is_array($db_url) ? $db_url['default'] : $db_url);

  $db_user = isset($url['user']) ? urldecode($url['user']) : '';

  $db_pass = isset($url['pass']) ? urldecode($url['pass']) : '';

  $db_host = isset($url['host']) ? urldecode($url['host']) : '';

  $db_port = isset($url['port']) ? urldecode($url['port']) : '';

  $db_path = ltrim(urldecode($url['path']), '/');

  $conf_path = './'. conf_path(FALSE, TRUE);

  $settings_file = $conf_path .'/settings.php';

  // We always need this because we want to run form_get_errors.

  include_once './includes/form.inc';

  install_task_list('database');

  $output = drupal_get_form('install_settings_form', $profile, $install_locale, $settings_file, $db_url, $db_type, $db_prefix, $db_user, $db_pass, $db_host, $db_port, $db_path);

  drupal_set_title(st('Database configuration'));

  print theme('install_page', $output);

  exit;

}

/**

 * Form API array definition for install_settings.

 */

function install_settings_form(&$form_state, $profile, $install_locale, $settings_file, $db_url, $db_type, $db_prefix, $db_user, $db_pass, $db_host, $db_port, $db_path) {

  if (empty($db_host)) {

    $db_host = 'localhost';

  }

  $db_types = drupal_detect_database_types();

  // If both 'mysql' and 'mysqli' are available, we disable 'mysql':

  if (isset($db_types['mysqli'])) {

    unset($db_types['mysql']);

  }

  if (count($db_types) == 0) {

    $form['no_db_types'] = array(

      '#value' => st('Your web server does not appear to support any common database types. Check with your hosting provider to see if they offer any databases that <a href="@drupal-databases">Drupal supports</a>.', array('@drupal-databases' => 'http://drupal.org/node/270#database')),

    );

  }

  else {

    $form['basic_options'] = array(

      '#type' => 'fieldset',

      '#title' => st('Basic options'),

      '#description' => '<p>'. st('To set up your @drupal database, enter the following information.', array('@drupal' => drupal_install_profile_name())) .'</p>',

    );

    if (count($db_types) > 1) {

      $form['basic_options']['db_type'] = array(

        '#type' => 'radios',

        '#title' => st('Database type'),

        '#required' => TRUE,

        '#options' => $db_types,

        '#default_value' => ($db_type ? $db_type : current($db_types)),

        '#description' => st('The type of database your @drupal data will be stored in.', array('@drupal' => drupal_install_profile_name())),

      );

      $db_path_description = st('The name of the database your @drupal data will be stored in. It must exist on your server before @drupal can be installed.', array('@drupal' => drupal_install_profile_name()));

    }

    else {

      if (count($db_types) == 1) {

        $db_types = array_values($db_types);

        $form['basic_options']['db_type'] = array(

          '#type' => 'hidden',

          '#value' => $db_types[0],

        );

        $db_path_description = st('The name of the %db_type database your @drupal data will be stored in. It must exist on your server before @drupal can be installed.', array('%db_type' => $db_types[0], '@drupal' => drupal_install_profile_name()));

      }

    }

    // Database name

    $form['basic_options']['db_path'] = array(

      '#type' => 'textfield',

      '#title' => st('Database name'),

      '#default_value' => $db_path,

      '#size' => 45,

      '#required' => TRUE,

      '#description' => $db_path_description

    );

    // Database username

    $form['basic_options']['db_user'] = array(

      '#type' => 'textfield',

      '#title' => st('Database username'),

      '#default_value' => $db_user,

      '#size' => 45,

      '#required' => TRUE,

    );

    // Database username

    $form['basic_options']['db_pass'] = array(

      '#type' => 'password',

      '#title' => st('Database password'),

      '#default_value' => $db_pass,

      '#size' => 45,

    );

    $form['advanced_options'] = array(

      '#type' => 'fieldset',

      '#title' => st('Advanced options'),

      '#collapsible' => TRUE,

      '#collapsed' => TRUE,

      '#description' => st("These options are only necessary for some sites. If you're not sure what you should enter here, leave the default settings or check with your hosting provider.")

    );

    // Database host

    $form['advanced_options']['db_host'] = array(

      '#type' => 'textfield',

      '#title' => st('Database host'),

      '#default_value' => $db_host,

      '#size' => 45,

      // Hostnames can be 255 characters long.

      '#maxlength' => 255,

      '#required' => TRUE,

      '#description' => st('If your database is located on a different server, change this.'),

    );

    // Database port

    $form['advanced_options']['db_port'] = array(

      '#type' => 'textfield',

      '#title' => st('Database port'),

      '#default_value' => $db_port,

      '#size' => 45,

      // The maximum port number is 65536, 5 digits.

      '#maxlength' => 5,

      '#description' => st('If your database server is listening to a non-standard port, enter its number.'),

    );

    // Table prefix

    $prefix = ($profile == 'default') ? 'drupal_' : $profile .'_';

    $form['advanced_options']['db_prefix'] = array(

      '#type' => 'textfield',

      '#title' => st('Table prefix'),

      '#default_value' => $db_prefix,

      '#size' => 45,

      '#description' => st('If more than one application will be sharing this database, enter a table prefix such as %prefix for your @drupal site here.', array('@drupal' => drupal_install_profile_name(), '%prefix' => $prefix)),

    );

    $form['save'] = array(

      '#type' => 'submit',

      '#value' => st('Save and continue'),

    );

    $form['errors'] = array();

    $form['settings_file'] = array('#type' => 'value', '#value' => $settings_file);

    $form['_db_url'] = array('#type' => 'value');

    $form['#action'] = "install.php?profile=$profile". ($install_locale ? "&locale=$install_locale" : '');

    $form['#redirect'] = FALSE;

  }

  return $form;

}

/**

 * Form API validate for install_settings form.

 */

function install_settings_form_validate($form, &$form_state) {

  global $db_url;

  _install_settings_form_validate($form_state['values']['db_prefix'], $form_state['values']['db_type'], $form_state['values']['db_user'], $form_state['values']['db_pass'], $form_state['values']['db_host'], $form_state['values']['db_port'], $form_state['values']['db_path'], $form_state['values']['settings_file'], $form_state, $form);

}

/**

 * Helper function for install_settings_validate.

 */

function _install_settings_form_validate($db_prefix, $db_type, $db_user, $db_pass, $db_host, $db_port, $db_path, $settings_file, &$form_state, $form = NULL) {

  global $db_url;

  // Verify the table prefix

  if (!empty($db_prefix) && is_string($db_prefix) && !preg_match('/^[A-Za-z0-9_.]+$/', $db_prefix)) {

    form_set_error('db_prefix', st('The database table prefix you have entered, %db_prefix, is invalid. The table prefix can only contain alphanumeric characters, periods, or underscores.', array('%db_prefix' => $db_prefix)), 'error');

  }

  if (!empty($db_port) && !is_numeric($db_port)) {

    form_set_error('db_port', st('Database port must be a number.'));

  }

  // Check database type

  if (!isset($form)) {

    $_db_url = is_array($db_url) ? $db_url['default'] : $db_url;

    $db_type = substr($_db_url, 0, strpos($_db_url, '://'));

  }

  $databases = drupal_detect_database_types();

  if (!in_array($db_type, $databases)) {

    form_set_error('db_type', st("In your %settings_file file you have configured @drupal to use a %db_type server, however your PHP installation currently does not support this database type.", array('%settings_file' => $settings_file, '@drupal' => drupal_install_profile_name(), '%db_type' => $db_type)));

  }

  else {

    // Verify

    $db_url = $db_type .'://'. urlencode($db_user) . ($db_pass ? ':'. urlencode($db_pass) : '') .'@'. ($db_host ? urlencode($db_host) : 'localhost') . ($db_port ? ":$db_port" : '') .'/'. urlencode($db_path);

    if (isset($form)) {

      form_set_value($form['_db_url'], $db_url, $form_state);

    }

    $success = array();

    $function = 'drupal_test_'. $db_type;

    if (!$function($db_url, $success)) {

      if (isset($success['CONNECT'])) {

        form_set_error('db_type', st('In order for Drupal to work, and to continue with the installation process, you must resolve all permission issues reported above. We were able to verify that we have permission for the following commands: %commands. 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.', array('%commands' => implode($success, ', '))));

      }

      else {

        form_set_error('db_type', '');

      }

    }

  }

}

/**

 * Form API submit for install_settings form.

 */

function install_settings_form_submit($form, &$form_state) {

  global $profile, $install_locale;

  // Update global settings array and save

  $settings['db_url'] = array(

    'value'    => $form_state['values']['_db_url'],

    'required' => TRUE,

  );

  $settings['db_prefix'] = array(

    'value'    => $form_state['values']['db_prefix'],

    'required' => TRUE,

  );

  drupal_rewrite_settings($settings);

  // Continue to install profile step

  install_goto("install.php?profile=$profile". ($install_locale ? "&locale=$install_locale" : ''));

}