install.php

  1. <?php
  2. // $Id: install.php,v 1.113.2.2 2008/02/08 22:00:45 goba Exp $
  3. require_once './includes/install.inc';
  4. define('MAINTENANCE_MODE''install');
  5. /**
  6.  * The Drupal installation happens in a series of steps. We begin by verifying
  7.  * that the current environment meets our minimum requirements. We then go
  8.  * on to verify that settings.php is properly configured. From there we
  9.  * connect to the configured database and verify that it meets our minimum
  10.  * requirements. Finally we can allow the user to select an installation
  11.  * profile and complete the installation process.
  12.  *
  13.  * @param $phase
  14.  *   The installation phase we should proceed to.
  15.  */
  16. function install_main() {
  17.   require_once './includes/bootstrap.inc';
  18.   drupal_bootstrap(DRUPAL_BOOTSTRAP_CONFIGURATION);
  19.   // This must go after drupal_bootstrap(), which unsets globals!
  20.   global $profile$install_locale$conf;
  21.   require_once './modules/system/system.install';
  22.   require_once './includes/file.inc';
  23.   // Ensure correct page headers are sent (e.g. caching)
  24.   drupal_page_header();
  25.   // Set up $language, so t() caller functions will still work.
  26.   drupal_init_language();
  27.   // Load module basics (needed for hook invokes).
  28.   include_once './includes/module.inc';
  29.   $module_list['system']['filename'] = 'modules/system/system.module';
  30.   $module_list['filter']['filename'] = 'modules/filter/filter.module';
  31.   module_list(TRUEFALSEFALSE$module_list);
  32.   drupal_load('module''system');
  33.   drupal_load('module''filter');
  34.   // Set up theme system for the maintenance page.
  35.   drupal_maintenance_theme();
  36.   // Check existing settings.php.
  37.   $verify install_verify_settings();
  38.   if ($verify) {
  39.     // Since we have a database connection, we use the normal cache system.
  40.     // This is important, as the installer calls into the Drupal system for
  41.     // the clean URL checks, so we should maintain the cache properly.
  42.     require_once './includes/cache.inc';
  43.     $conf['cache_inc'] = './includes/cache.inc';
  44.     // Establish a connection to the database.
  45.     require_once './includes/database.inc';
  46.     db_set_active();
  47.     // Check if Drupal is installed.
  48.     $task install_verify_drupal();
  49.     if ($task == 'done') {
  50.       install_already_done_error();
  51.     }
  52.   }
  53.   else {
  54.     // Since no persistent storage is available yet, and functions that check
  55.     // for cached data will fail, we temporarily replace the normal cache
  56.     // system with a stubbed-out version that short-circuits the actual
  57.     // caching process and avoids any errors.
  58.     require_once './includes/cache-install.inc';
  59.     $conf['cache_inc'] = './includes/cache-install.inc';
  60.     $task NULL;
  61.   }
  62.   // Decide which profile to use.
  63.   if (!empty($_GET['profile'])) {
  64.     $profile preg_replace('/[^a-zA-Z_0-9]/'''$_GET['profile']);
  65.   }
  66.   elseif ($profile install_select_profile()) {
  67.     install_goto("install.php?profile=$profile");
  68.   }
  69.   else {
  70.     install_no_profile_error();
  71.   }
  72.   // Load the profile.
  73.   require_once "./profiles/$profile/$profile.profile";
  74.   // Locale selection
  75.   if (!empty($_GET['locale'])) {
  76.     $install_locale preg_replace('/[^a-zA-Z_0-9]/'''$_GET['locale']);
  77.   }
  78.   elseif (($install_locale install_select_locale($profile)) !== FALSE) {
  79.     install_goto("install.php?profile=$profile&locale=$install_locale");
  80.   }
  81.   // Tasks come after the database is set up
  82.   if (!$task) {
  83.     // Check the installation requirements for Drupal and this profile.
  84.     install_check_requirements($profile$verify);
  85.     // Verify existence of all required modules.
  86.     $modules drupal_verify_profile($profile$install_locale);
  87.     // If any error messages are set now, it means a requirement problem.
  88.     $messages drupal_set_message();
  89.     if (!empty($messages['error'])) {
  90.       install_task_list('requirements');
  91.       drupal_set_title(st('Requirements problem'));
  92.       print theme('install_page''');
  93.       exit;
  94.     }
  95.     // Change the settings.php information if verification failed earlier.
  96.     // Note: will trigger a redirect if database credentials change.
  97.     if (!$verify) {
  98.       install_change_settings($profile$install_locale);
  99.     }
  100.     // Install system.module.
  101.     drupal_install_system();
  102.     // Save the list of other modules to install for the 'profile-install'
  103.     // task. variable_set() can be used now that system.module is installed
  104.     // and drupal is bootstrapped.
  105.     variable_set('install_profile_modules'array_diff($modules, array('system')));
  106.   }
  107.   // The database is set up, turn to further tasks.
  108.   install_tasks($profile$task);
  109. }
  110. /**
  111.  * Verify if Drupal is installed.
  112.  */
  113. function install_verify_drupal() {
  114.   // Read the variable manually using the @ so we don't trigger an error if it fails.
  115.   $result = @db_query("SELECT value FROM {variable} WHERE name = '%s'"'install_task');
  116.   if ($result) {
  117.     return unserialize(db_result($result));
  118.   }
  119. }
  120. /**
  121.  * Verify existing settings.php
  122.  */
  123. function install_verify_settings() {
  124.   global $db_prefix$db_type$db_url;
  125.   // Verify existing settings (if any).
  126.   if (!empty($db_url)) {
  127.     // We need this because we want to run form_get_errors.
  128.     include_once './includes/form.inc';
  129.     $url parse_url(is_array($db_url) ? $db_url['default'] : $db_url);
  130.     $db_user urldecode($url['user']);
  131.     $db_pass = isset($url['pass']) ? urldecode($url['pass']) : NULL;
  132.     $db_host urldecode($url['host']);
  133.     $db_port = isset($url['port']) ? urldecode($url['port']) : '';
  134.     $db_path ltrim(urldecode($url['path']), '/');
  135.     $settings_file './'conf_path(FALSETRUE) .'/settings.php';
  136.     $form_state = array();
  137.     _install_settings_form_validate($db_prefix$db_type$db_user$db_pass$db_host$db_port$db_path$settings_file$form_state);
  138.     if (!form_get_errors()) {
  139.       return TRUE;
  140.     }
  141.   }
  142.   return FALSE;
  143. }
  144. /**
  145.  * Configure and rewrite settings.php.
  146.  */
  147. function install_change_settings($profile 'default'$install_locale '') {
  148.   global $db_url$db_type$db_prefix;
  149.   $url parse_url(is_array($db_url) ? $db_url['default'] : $db_url);
  150.   $db_user = isset($url['user']) ? urldecode($url['user']) : '';
  151.   $db_pass = isset($url['pass']) ? urldecode($url['pass']) : '';
  152.   $db_host = isset($url['host']) ? urldecode($url['host']) : '';
  153.   $db_port = isset($url['port']) ? urldecode($url['port']) : '';
  154.   $db_path ltrim(urldecode($url['path']), '/');
  155.   $conf_path './'conf_path(FALSETRUE);
  156.   $settings_file $conf_path .'/settings.php';
  157.   // We always need this because we want to run form_get_errors.
  158.   include_once './includes/form.inc';
  159.   install_task_list('database');
  160.   if ($db_url == 'mysql://username:password@localhost/databasename') {
  161.     $db_user $db_pass $db_path '';
  162.   }
  163.   elseif (!empty($db_url)) {
  164.     // Do not install over a configured settings.php.
  165.     install_already_done_error();
  166.   }
  167.   $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);
  168.   drupal_set_title(st('Database configuration'));
  169.   print theme('install_page'$output);
  170.   exit;
  171. }
  172. /**
  173.  * Form API array definition for install_settings.
  174.  */
  175. 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) {
  176.   if (empty($db_host)) {
  177.     $db_host 'localhost';
  178.   }
  179.   $db_types drupal_detect_database_types();
  180.   // If both 'mysql' and 'mysqli' are available, we disable 'mysql':
  181.   if (isset($db_types['mysqli'])) {
  182.     unset($db_types['mysql']);
  183.   }
  184.   if (count($db_types) == 0) {
  185.     $form['no_db_types'] = array(
  186.       '#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')),
  187.     );
  188.   }
  189.   else {
  190.     $form['basic_options'] = array(
  191.       '#type' => 'fieldset',
  192.       '#title' => st('Basic options'),
  193.       '#description' => '<p>'st('To set up your @drupal database, enter the following information.', array('@drupal' => drupal_install_profile_name())) .'</p>',
  194.     );
  195.     if (count($db_types) > 1) {
  196.       $form['basic_options']['db_type'] = array(
  197.         '#type' => 'radios',
  198.         '#title' => st('Database type'),
  199.         '#required' => TRUE,
  200.         '#options' => $db_types,
  201.         '#default_value' => ($db_type $db_type current($db_types)),
  202.         '#description' => st('The type of database your @drupal data will be stored in.', array('@drupal' => drupal_install_profile_name())),
  203.       );
  204.       $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()));
  205.     }
  206.     else {
  207.       if (count($db_types) == 1) {
  208.         $db_types array_values($db_types);
  209.         $form['basic_options']['db_type'] = array(
  210.           '#type' => 'hidden',
  211.           '#value' => $db_types[0],
  212.         );
  213.         $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()));
  214.       }
  215.     }
  216.     // Database name
  217.     $form['basic_options']['db_path'] = array(
  218.       '#type' => 'textfield',
  219.       '#title' => st('Database name'),
  220.       '#default_value' => $db_path,
  221.       '#size' => 45,
  222.       '#maxlength' => 45,
  223.       '#required' => TRUE,
  224.       '#description' => $db_path_description
  225.     );
  226.     // Database username
  227.     $form['basic_options']['db_user'] = array(
  228.       '#type' => 'textfield',
  229.       '#title' => st('Database username'),
  230.       '#default_value' => $db_user,
  231.       '#size' => 45,
  232.       '#maxlength' => 45,
  233.       '#required' => TRUE,
  234.     );
  235.     // Database username
  236.     $form['basic_options']['db_pass'] = array(
  237.       '#type' => 'password',
  238.       '#title' => st('Database password'),
  239.       '#default_value' => $db_pass,
  240.       '#size' => 45,
  241.       '#maxlength' => 45,
  242.     );
  243.     $form['advanced_options'] = array(
  244.       '#type' => 'fieldset',
  245.       '#title' => st('Advanced options'),
  246.       '#collapsible' => TRUE,
  247.       '#collapsed' => TRUE,
  248.       '#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.")
  249.     );
  250.     // Database host
  251.     $form['advanced_options']['db_host'] = array(
  252.       '#type' => 'textfield',
  253.       '#title' => st('Database host'),
  254.       '#default_value' => $db_host,
  255.       '#size' => 45,
  256.       '#maxlength' => 45,
  257.       '#required' => TRUE,
  258.       '#description' => st('If your database is located on a different server, change this.'),
  259.     );
  260.     // Database port
  261.     $form['advanced_options']['db_port'] = array(
  262.       '#type' => 'textfield',
  263.       '#title' => st('Database port'),
  264.       '#default_value' => $db_port,
  265.       '#size' => 45,
  266.       '#maxlength' => 45,
  267.       '#description' => st('If your database server is listening to a non-standard port, enter its number.'),
  268.     );
  269.     // Table prefix
  270.     $prefix = ($profile == 'default') ? 'drupal_' $profile .'_';
  271.     $form['advanced_options']['db_prefix'] = array(
  272.       '#type' => 'textfield',
  273.       '#title' => st('Table prefix'),
  274.       '#default_value' => $db_prefix,
  275.       '#size' => 45,
  276.       '#maxlength' => 45,
  277.       '#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)),
  278.     );
  279.     $form['save'] = array(
  280.       '#type' => 'submit',
  281.       '#value' => st('Save and continue'),
  282.     );
  283.     $form['errors'] = array();
  284.     $form['settings_file'] = array('#type' => 'value''#value' => $settings_file);
  285.     $form['_db_url'] = array('#type' => 'value');
  286.     $form['#action'] = "install.php?profile=$profile". ($install_locale "&locale=$install_locale" '');
  287.     $form['#redirect'] = FALSE;
  288.   }
  289.   return $form;
  290. }
  291. /**
  292.  * Form API validate for install_settings form.
  293.  */
  294. function install_settings_form_validate($form, &$form_state) {
  295.   global $db_url;
  296.   _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);
  297. }
  298. /**
  299.  * Helper function for install_settings_validate.
  300.  */
  301. 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) {
  302.   global $db_url;
  303.   // Verify the table prefix
  304.   if (!empty($db_prefix) && is_string($db_prefix) && !preg_match('/^[A-Za-z0-9_.]+$/'$db_prefix)) {
  305.     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');
  306.   }
  307.   if (!empty($db_port) && !is_numeric($db_port)) {
  308.     form_set_error('db_port'st('Database port must be a number.'));
  309.   }
  310.   // Check database type
  311.   if (!isset($form)) {
  312.     $_db_url is_array($db_url) ? $db_url['default'] : $db_url;
  313.     $db_type substr($_db_url0strpos($_db_url'://'));
  314.   }
  315.   $databases drupal_detect_database_types();
  316.   if (!in_array($db_type$databases)) {
  317.     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)));
  318.   }
  319.   else {
  320.     // Verify
  321.     $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);
  322.     if (isset($form)) {
  323.       form_set_value($form['_db_url'], $db_url$form_state);
  324.     }
  325.     $success = array();
  326.     $function 'drupal_test_'$db_type;
  327.     if (!$function($db_url$success)) {
  328.       if (isset($success['CONNECT'])) {
  329.         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', '))));
  330.       }
  331.       else {
  332.         form_set_error('db_type''');
  333.       }
  334.     }
  335.   }
  336. }
  337. /**
  338.  * Form API submit for install_settings form.
  339.  */
  340. function install_settings_form_submit($form, &$form_state) {
  341.   global $profile$install_locale;
  342.   // Update global settings array and save
  343.   $settings['db_url'] = array(
  344.     'value'    => $form_state['values']['_db_url'],
  345.     'required' => TRUE,
  346.   );
  347.   $settings['db_prefix'] = array(
  348.     'value'    => $form_state['values']['db_prefix'],
  349.     'required' => TRUE,
  350.   );
  351.   drupal_rewrite_settings($settings);
  352.   // Continue to install profile step
  353.   install_goto("install.php?profile=$profile". ($install_locale "&locale=$install_locale" ''));
  354. }
  355. /**
  356.  * Find all .profile files.
  357.  */
  358. function install_find_profiles() {
  359.   return file_scan_directory('./profiles''\.profile$', array('.''..''CVS'), 0TRUE'name'0);
  360. }
  361. /**
  362.  * Allow admin to select which profile to install.
  363.  *
  364.  * @return
  365.  *   The selected profile.
  366.  */
  367. function install_select_profile() {
  368.   include_once './includes/form.inc';
  369.   $profiles install_find_profiles();
  370.   // Don't need to choose profile if only one available.
  371.   if (sizeof($profiles) == 1) {
  372.     $profile array_pop($profiles);
  373.     require_once $profile->filename;
  374.     return $profile->name;
  375.   }
  376.   elseif (sizeof($profiles) > 1) {
  377.     foreach ($profiles as $profile) {
  378.       if (!empty($_POST['profile']) && ($_POST['profile'] == $profile->name)) {
  379.         return $profile->name;
  380.       }
  381.     }
  382.     install_task_list('profile-select');
  383.     drupal_set_title(st('Select an installation profile'));
  384.     print theme('install_page'drupal_get_form('install_select_profile_form'$profiles));
  385.     exit;
  386.   }
  387. }
  388. /**
  389.  * Form API array definition for the profile selection form.
  390.  */
  391. function install_select_profile_form(&$form_state$profiles) {
  392.   foreach ($profiles as $profile) {
  393.     include_once($profile->filename);
  394.     // Load profile details.
  395.     $function $profile->name .'_profile_details';
  396.     if (function_exists($function)) {
  397.       $details $function();
  398.     }
  399.     // If set, used defined name. Otherwise use file name.
  400.     $name = isset($details['name']) ? $details['name'] : $profile->name;
  401.     $form['profile'][$name] = array(
  402.       '#type' => 'radio',
  403.       '#value' => 'default',
  404.       '#return_value' => $profile->name,
  405.       '#title' => $name,
  406.       '#description' => isset($details['description']) ? $details['description'] : '',
  407.       '#parents' => array('profile'),
  408.     );
  409.   }
  410.   $form['submit'] =  array(
  411.     '#type' => 'submit',
  412.     '#value' => st('Save and continue'),
  413.   );
  414.   return $form;
  415. }
  416. /**
  417.  * Find all .po files for the current profile.
  418.  */
  419. function install_find_locales($profilename) {
  420.   $locales file_scan_directory('./profiles/'$profilename .'/translations''\.po$', array('.''..''CVS'), 0FALSE);
  421.   array_unshift($locales, (object) array('name' => 'en'));
  422.   return $locales;
  423. }
  424. /**
  425.  * Allow admin to select which locale to use for the current profile.
  426.  *
  427.  * @return
  428.  *   The selected language.
  429.  */
  430. function install_select_locale($profilename) {
  431.   include_once './includes/file.inc';
  432.   include_once './includes/form.inc';
  433.   // Find all available locales.
  434.   $locales install_find_locales($profilename);
  435.   // If only the built-in (English) language is available,
  436.   // and we are using the default profile, inform the user
  437.   // that the installer can be localized. Otherwise we assume
  438.   // the user know what he is doing.
  439.   if (count($locales) == 1) {
  440.     if ($profilename == 'default') {
  441.       install_task_list('locale-select');
  442.       drupal_set_title(st('Choose language'));
  443.       if (!empty($_GET['localize'])) {
  444.         $output '<p>'st('With the addition of an appropriate translation package, this installer is capable of proceeding in another language of your choice. To install and use Drupal in a language other than English:') .'</p>';
  445.         $output .= '<ul><li>'st('Determine if <a href="@translations" target="_blank">a translation of this Drupal version</a> is available in your language of choice. A translation is provided via a translation package; each translation package enables the display of a specific version of Drupal in a specific language. Not all languages are available for every version of Drupal.', array('@translations' => 'http://drupal.org/project/translations')) .'</li>';
  446.         $output .= '<li>'st('If an alternative translation package of your choice is available, download and extract its contents to your Drupal root directory.') .'</li>';
  447.         $output .= '<li>'st('Return to choose language using the second link below and select your desired language from the displayed list. Reloading the page allows the list to automatically adjust to the presence of new translation packages.') .'</li>';
  448.         $output .= '</ul><p>'st('Alternatively, to install and use Drupal in English, or to defer the selection of an alternative language until after installation, select the first link below.') .'</p>';
  449.         $output .= '<p>'st('How should the installation continue?') .'</p>';
  450.         $output .= '<ul><li><a href="install.php?profile='$profilename .'&amp;locale=en">'st('Continue installation in English') .'</a></li><li><a href="install.php?profile='$profilename .'">'st('Return to choose a language') .'</a></li></ul>';
  451.       }
  452.       else {
  453.         $output '<ul><li><a href="install.php?profile='$profilename .'&amp;locale=en">'st('Install Drupal in English') .'</a></li><li><a href="install.php?profile='$profilename .'&amp;localize=true">'st('Learn how to install Drupal in other languages') .'</a></li></ul>';
  454.       }
  455.       print theme('install_page'$output);
  456.       exit;
  457.     }
  458.     // One language, but not the default profile, assume
  459.     // the user knows what he is doing.
  460.     return FALSE;
  461.   }
  462.   else {
  463.     // Allow profile to pre-select the language, skipping the selection.
  464.     $function $profilename .'_profile_details';
  465.     if (function_exists($function)) {
  466.       $details $function();
  467.       if (isset($details['language'])) {
  468.         foreach ($locales as $locale) {
  469.           if ($details['language'] == $locale->name) {
  470.             return $locale->name;
  471.           }
  472.         }
  473.       }
  474.     }
  475.     foreach ($locales as $locale) {
  476.       if ($_POST['locale'] == $locale->name) {
  477.         return $locale->name;
  478.       }
  479.     }
  480.     install_task_list('locale-select');
  481.     drupal_set_title(st('Choose language'));
  482.     print theme('install_page'drupal_get_form('install_select_locale_form'$locales));
  483.     exit;
  484.   }
  485. }
  486. /**
  487.  * Form API array definition for language selection.
  488.  */
  489. function install_select_locale_form(&$form_state$locales) {
  490.   include_once './includes/locale.inc';
  491.   $languages _locale_get_predefined_list();
  492.   foreach ($locales as $locale) {
  493.     // Try to use verbose locale name
  494.     $name $locale->name;
  495.     if (isset($languages[$name])) {
  496.       $name $languages[$name][0] . (isset($languages[$name][1]) ? ' 'st('(@language)', array('@language' => $languages[$name][1])) : '');
  497.     }
  498.     $form['locale'][$locale->name] = array(
  499.       '#type' => 'radio',
  500.       '#return_value' => $locale->name,
  501.       '#default_value' => ($locale->name == 'en' TRUE FALSE),
  502.       '#title' => $name . ($locale->name == 'en' ' 'st('(built-in)') : ''),
  503.       '#parents' => array('locale')
  504.     );
  505.   }
  506.   $form['submit'] =  array(
  507.     '#type' => 'submit',
  508.     '#value' => st('Select language'),
  509.   );
  510.   return $form;
  511. }
  512. /**
  513.  * Show an error page when there are no profiles available.
  514.  */
  515. function install_no_profile_error() {
  516.   install_task_list('profile-select');
  517.   drupal_set_title(st('No profiles available'));
  518.   print theme('install_page''<p>'st('We were unable to find any installer profiles. Installer profiles tell us what modules to enable and what schema to install in the database. A profile is necessary to continue with the installation process.') .'</p>');
  519.   exit;
  520. }
  521. /**
  522.  * Show an error page when Drupal has already been installed.
  523.  */
  524. function install_already_done_error() {
  525.   global $base_url;
  526.   drupal_set_title(st('Drupal already installed'));
  527.   print theme('install_page'st('<ul><li>To start over, you must empty your existing database.</li><li>To install to a different database, edit the appropriate <em>settings.php</em> file in the <em>sites</em> folder.</li><li>To upgrade an existing installation, proceed to the <a href="@base-url/update.php">update script</a>.</li><li>View your <a href="@base-url">existing site</a>.</li></ul>', array('@base-url' => $base_url)));
  528.   exit;
  529. }
  530. /**
  531.  * Tasks performed after the database is initialized.
  532.  */
  533. function install_tasks($profile$task) {
  534.   global $base_url$install_locale;
  535.   // Bootstrap newly installed Drupal, while preserving existing messages.
  536.   $messages = isset($_SESSION['messages']) ? $_SESSION['messages'] : '';
  537.   drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
  538.   $_SESSION['messages'] = $messages;
  539.   // URL used to direct page requests.
  540.   $url $base_url .'/install.php?locale='$install_locale .'&profile='$profile;
  541.   // Build a page for final tasks.
  542.   if (empty($task)) {
  543.     variable_set('install_task''profile-install');
  544.     $task 'profile-install';
  545.   }
  546.   // We are using a list of if constructs here to allow for
  547.   // passing from one task to the other in the same request.
  548.   // Install profile modules.
  549.   if ($task == 'profile-install') {
  550.     $modules variable_get('install_profile_modules', array());
  551.     $files module_rebuild_cache();
  552.     variable_del('install_profile_modules');
  553.     $operations = array();
  554.     foreach ($modules as $module) {
  555.       $operations[] = array('_install_module_batch', array($module$files[$module]->info['name']));
  556.     }
  557.     $batch = array(
  558.       'operations' => $operations,
  559.       'finished' => '_install_profile_batch_finished',
  560.       'title' => st('Installing @drupal', array('@drupal' => drupal_install_profile_name())),
  561.       'error_message' => st('The installation has encountered an error.'),
  562.     );
  563.     // Start a batch, switch to 'profile-install-batch' task. We need to
  564.     // set the variable here, because batch_process() redirects.
  565.     variable_set('install_task''profile-install-batch');
  566.     batch_set($batch);
  567.     batch_process($url$url);
  568.   }
  569.   // We are running a batch install of the profile's modules.
  570.   // This might run in multiple HTTP requests, constantly redirecting
  571.   // to the same address, until the batch finished callback is invoked
  572.   // and the task advances to 'locale-initial-import'.
  573.   if ($task == 'profile-install-batch') {
  574.     include_once 'includes/batch.inc';
  575.     $output _batch_page();
  576.   }
  577.   // Import interface translations for the enabled modules.
  578.   if ($task == 'locale-initial-import') {
  579.     if (!empty($install_locale) && ($install_locale != 'en')) {
  580.       include_once 'includes/locale.inc';
  581.       // Enable installation language as default site language.
  582.       locale_add_language($install_localeNULLNULLNULLNULLNULL1TRUE);
  583.       // Collect files to import for this language.
  584.       $batch locale_batch_by_language($install_locale'_install_locale_initial_batch_finished');
  585.       if (!empty($batch)) {
  586.         // Remember components we cover in this batch set.
  587.         variable_set('install_locale_batch_components'$batch['#components']);
  588.         // Start a batch, switch to 'locale-batch' task. We need to
  589.         // set the variable here, because batch_process() redirects.
  590.         variable_set('install_task''locale-initial-batch');
  591.         batch_set($batch);
  592.         batch_process($url$url);
  593.       }
  594.     }
  595.     // Found nothing to import or not foreign language, go to next task.
  596.     $task 'configure';
  597.   }
  598.   if ($task == 'locale-initial-batch') {
  599.     include_once 'includes/batch.inc';
  600.     include_once 'includes/locale.inc';
  601.     $output _batch_page();
  602.   }
  603.   if ($task == 'configure') {
  604.     if (variable_get('site_name'FALSE) || variable_get('site_mail'FALSE)) {
  605.       // Site already configured: This should never happen, means re-running
  606.       // the installer, possibly by an attacker after the 'install_task' variable
  607.       // got accidentally blown somewhere. Stop it now.
  608.       install_already_done_error();
  609.     }
  610.     $form drupal_get_form('install_configure_form'$url);
  611.     if (!variable_get('site_name'FALSE) && !variable_get('site_mail'FALSE)) {
  612.       // Not submitted yet: Prepare to display the form.
  613.       $output $form;
  614.       drupal_set_title(st('Configure site'));
  615.       // Warn about settings.php permissions risk
  616.       $settings_dir './'conf_path();
  617.       $settings_file $settings_dir .'/settings.php';
  618.       if (!drupal_verify_install_file($settings_fileFILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE) || !drupal_verify_install_file($settings_dirFILE_NOT_WRITABLE'dir')) {
  619.         drupal_set_message(st('All necessary changes to %dir and %file have been made, so you should remove write permissions to them now in order to avoid security risks. If you are unsure how to do so, please consult the <a href="@handbook_url">on-line handbook</a>.', array('%dir' => $settings_dir'%file' => $settings_file'@handbook_url' => 'http://drupal.org/getting-started')), 'error');
  620.       }
  621.       else {
  622.         drupal_set_message(st('All necessary changes to %dir and %file have been made. They have been set to read-only for security.', array('%dir' => $settings_dir'%file' => $settings_file)));
  623.       }
  624.       // Add JavaScript validation.
  625.       _user_password_dynamic_validation();
  626.       drupal_add_js(drupal_get_path('module''system') .'/system.js''module');
  627.       // We add these strings as settings because JavaScript translation does not
  628.       // work on install time.
  629.       drupal_add_js(array('copyFieldValue' => array('edit-site-mail' => array('edit-account-mail')), 'cleanURL' => array('success' => st('Your server has been successfully tested to support this feature.'), 'failure' => st('Your system configuration does not currently support this feature. The <a href="http://drupal.org/node/15365">handbook page on Clean URLs</a> has additional troubleshooting information.'), 'testing' => st('Testing clean URLs...'))), 'setting');
  630.       drupal_add_js('
  631. // Global Killswitch
  632. if (Drupal.jsEnabled) {
  633.   $(document).ready(function() {
  634.     Drupal.cleanURLsInstallCheck();
  635.     Drupal.setDefaultTimezone();
  636.   });
  637. }''inline');
  638.       // Build menu to allow clean URL check.
  639.       menu_rebuild();
  640.     }
  641.     else {
  642.       $task 'profile';
  643.     }
  644.   }
  645.   // If found an unknown task or the 'profile' task, which is
  646.   // reserved for profiles, hand over the control to the profile,
  647.   // so it can run any number of custom tasks it defines.
  648.   if (!in_array($taskinstall_reserved_tasks())) {
  649.     $function $profile .'_profile_tasks';
  650.     if (function_exists($function)) {
  651.       // The profile needs to run more code, maybe even more tasks.
  652.       // $task is sent through as a reference and may be changed!
  653.       $output $function($task$url);
  654.     }
  655.     // If the profile doesn't move on to a new task we assume
  656.     // that it is done.
  657.     if ($task == 'profile') {
  658.       $task 'profile-finished';
  659.     }
  660.   }
  661.   // Profile custom tasks are done, so let the installer regain
  662.   // control and proceed with importing the remaining translations.
  663.   if ($task == 'profile-finished') {
  664.     if (!empty($install_locale) && ($install_locale != 'en')) {
  665.       include_once 'includes/locale.inc';
  666.       // Collect files to import for this language. Skip components
  667.       // already covered in the initial batch set.
  668.       $batch locale_batch_by_language($install_locale'_install_locale_remaining_batch_finished'variable_get('install_locale_batch_components', array()));
  669.       // Remove temporary variable.
  670.       variable_del('install_locale_batch_components');
  671.       if (!empty($batch)) {
  672.         // Start a batch, switch to 'locale-remaining-batch' task. We need to
  673.         // set the variable here, because batch_process() redirects.
  674.         variable_set('install_task''locale-remaining-batch');
  675.         batch_set($batch);
  676.         batch_process($url$url);
  677.       }
  678.     }
  679.     // Found nothing to import or not foreign language, go to next task.
  680.     $task 'finished';
  681.   }
  682.   if ($task == 'locale-remaining-batch') {
  683.     include_once 'includes/batch.inc';
  684.     include_once 'includes/locale.inc';
  685.     $output _batch_page();
  686.   }
  687.   // Display a 'finished' page to user.
  688.   if ($task == 'finished') {
  689.     drupal_set_title(st('@drupal installation complete', array('@drupal' => drupal_install_profile_name())));
  690.     $messages drupal_set_message();
  691.     $output '<p>'st('Congratulations, @drupal has been successfully installed.', array('@drupal' => drupal_install_profile_name())) .'</p>';
  692.     $output .= '<p>'. (isset($messages['error']) ? st('Please review the messages above before continuing on to <a href="@url">your new site</a>.', array('@url' => url(''))) : st('You may now visit <a href="@url">your new site</a>.', array('@url' => url('')))) .'</p>';
  693.     $task 'done';
  694.   }
  695.   // The end of the install process. Remember profile used.
  696.   if ($task == 'done') {
  697.     // Rebuild menu to get content type links registered by the profile,
  698.     // and possibly any other menu items created through the tasks.
  699.     menu_rebuild();
  700.     // Register actions declared by any modules.
  701.     actions_synchronize();
  702.     // Randomize query-strings on css/js files, to hide the fact that
  703.     // this is a new install, not upgraded yet.
  704.     _drupal_flush_css_js();
  705.     variable_set('install_profile'$profile);
  706.   }
  707.   // Set task for user, and remember the task in the database.
  708.   install_task_list($task);
  709.   variable_set('install_task'$task);
  710.   // Output page, if some output was required. Otherwise it is possible
  711.   // that we are printing a JSON page and theme output should not be there.
  712.   if (isset($output)) {
  713.     print theme('maintenance_page'$output);
  714.   }
  715. }
  716. /**
  717.  * Batch callback for batch installation of modules.
  718.  */
  719. function _install_module_batch($module$module_name, &$context) {
  720.   _drupal_install_module($module);
  721.   // We enable the installed module right away, so that the module will be
  722.   // loaded by drupal_bootstrap in subsequent batch requests, and other
  723.   // modules possibly depending on it can safely perform their installation
  724.   // steps.
  725.   module_enable(array($module));
  726.   $context['results'][] = $module;
  727.   $context['message'] = 'Installed '$module_name .' module.';
  728. }
  729. /**
  730.  * Finished callback for the modules install batch.
  731.  *
  732.  * Advance installer task to language import.
  733.  */
  734. function _install_profile_batch_finished($success$results) {
  735.   variable_set('install_task''locale-initial-import');
  736. }
  737. /**
  738.  * Finished callback for the first locale import batch.
  739.  *
  740.  * Advance installer task to the configure screen.
  741.  */
  742. function _install_locale_initial_batch_finished($success$results) {
  743.   variable_set('install_task''configure');
  744. }
  745. /**
  746.  * Finished callback for the second locale import batch.
  747.  *
  748.  * Advance installer task to the finished screen.
  749.  */
  750. function _install_locale_remaining_batch_finished($success$results) {
  751.   variable_set('install_task''finished');
  752. }
  753. /**
  754.  * The list of reserved tasks to run in the installer.
  755.  */
  756. function install_reserved_tasks() {
  757.   return array('configure''profile-install''profile-install-batch''locale-initial-import''locale-initial-batch''profile-finished''locale-remaining-batch''finished''done');
  758. }
  759. /**
  760.  * Check installation requirements and report any errors.
  761.  */
  762. function install_check_requirements($profile$verify) {
  763.   // If Drupal is not set up already, we need to create a settings file.
  764.   if (!$verify) {
  765.     $writable FALSE;
  766.     $conf_path './'conf_path(FALSETRUE);
  767.     $settings_file $conf_path .'/settings.php';
  768.     $file $conf_path;
  769.     // Verify that the directory exists.
  770.     if (drupal_verify_install_file($conf_pathFILE_EXIST'dir')) {
  771.       // Check to see if a settings.php already exists.
  772.       if (drupal_verify_install_file($settings_fileFILE_EXIST)) {
  773.         // If it does, make sure it is writable.
  774.         $writable drupal_verify_install_file($settings_fileFILE_READABLE|FILE_WRITABLE);
  775.         $file $settings_file;
  776.       }
  777.       else {
  778.         // If not, make sure the directory is.
  779.         $writable drupal_verify_install_file($conf_pathFILE_READABLE|FILE_WRITABLE'dir');
  780.       }
  781.     }
  782.     if (!$writable) {
  783.       drupal_set_message(st('The @drupal installer requires write permissions to %file during the installation process. If you are unsure how to grant file permissions, please consult the <a href="@handbook_url">on-line handbook</a>.', array('@drupal' => drupal_install_profile_name(), '%file' => $file'@handbook_url' => 'http://drupal.org/server-permissions')), 'error');
  784.     }
  785.   }
  786.   // Check the other requirements.
  787.   $requirements drupal_check_profile($profile);
  788.   $severity drupal_requirements_severity($requirements);
  789.   // If there are issues, report them.
  790.   if ($severity == REQUIREMENT_ERROR) {
  791.     foreach ($requirements as $requirement) {
  792.       if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_ERROR) {
  793.         $message $requirement['description'];
  794.         if (isset($requirement['value']) && $requirement['value']) {
  795.           $message .= ' ('st('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) .')';
  796.         }
  797.         drupal_set_message($message'error');
  798.       }
  799.     }
  800.   }
  801.   if ($severity == REQUIREMENT_WARNING) {
  802.     foreach ($requirements as $requirement) {
  803.       if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_WARNING) {
  804.         $message $requirement['description'];
  805.         if (isset($requirement['value']) && $requirement['value']) {
  806.           $message .= ' ('st('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) .')';
  807.         }
  808.         drupal_set_message($message'warning');
  809.       }
  810.     }
  811.   } 
  812. }
  813. /**
  814.  * Add the installation task list to the current page.
  815.  */
  816. function install_task_list($active NULL) {
  817.   // Default list of tasks.
  818.   $tasks = array(
  819.     'profile-select'        => st('Choose profile'),
  820.     'locale-select'         => st('Choose language'),
  821.     'requirements'          => st('Verify requirements'),
  822.     'database'              => st('Set up database'),
  823.     'profile-install-batch' => st('Install profile'),
  824.     'locale-initial-batch'  => st('Set up translations'),
  825.     'configure'             => st('Configure site'),
  826.   );
  827.   $profiles install_find_profiles();
  828.   $profile = isset($_GET['profile']) && isset($profiles[$_GET['profile']]) ? $_GET['profile'] : '.';
  829.   $locales install_find_locales($profile);
  830.   // If we have only one profile, remove 'Choose profile'
  831.   // and rename 'Install profile'.
  832.   if (count($profiles) == 1) {
  833.     unset($tasks['profile-select']);
  834.     $tasks['profile-install-batch'] = st('Install site');
  835.   }
  836.   // Add tasks defined by the profile.
  837.   if ($profile) {
  838.     $function $profile .'_profile_task_list';
  839.     if (function_exists($function)) {
  840.       $result $function();
  841.       if (is_array($result)) {
  842.         $tasks += $result;
  843.       }
  844.     }
  845.   }
  846.   if (count($locales) < || empty($_GET['locale']) || $_GET['locale'] == 'en') {
  847.     // If not required, remove translation import from the task list.
  848.     unset($tasks['locale-initial-batch']);
  849.   }
  850.   else {
  851.     // If required, add remaining translations import task.
  852.     $tasks += array('locale-remaining-batch' => st('Finish translations'));
  853.   }
  854.   // Add finished step as the last task.
  855.   $tasks += array(
  856.     'finished'     => st('Finished')
  857.   );
  858.   // Let the theming function know that 'finished' and 'done'
  859.   // include everything, so every step is completed.
  860.   if (in_array($active, array('finished''done'))) {
  861.     $active NULL;
  862.   }
  863.   drupal_set_content('left'theme_task_list($tasks$active));
  864. }
  865. /**
  866.  * Form API array definition for site configuration.
  867.  */
  868. function install_configure_form(&$form_state$url) {
  869.   $form['intro'] = array(
  870.     '#value' => st('To configure your website, please provide the following information.'),
  871.     '#weight' => -10,
  872.   );
  873.   $form['site_information'] = array(
  874.     '#type' => 'fieldset',
  875.     '#title' => st('Site information'),
  876.     '#collapsible' => FALSE,
  877.   );
  878.   $form['site_information']['site_name'] = array(
  879.     '#type' => 'textfield',
  880.     '#title' => st('Site name'),
  881.     '#required' => TRUE,
  882.     '#weight' => -20,
  883.   );
  884.   $form['site_information']['site_mail'] = array(
  885.     '#type' => 'textfield',
  886.     '#title' => st('Site e-mail address'),
  887.     '#default_value' => ini_get('sendmail_from'),
  888.     '#description' => st("The <em>From</em> address in automated e-mails sent during registration and new password requests, and other notifications. (Use an address ending in your site's domain to help prevent this e-mail being flagged as spam.)"),
  889.     '#required' => TRUE,
  890.     '#weight' => -15,
  891.   );
  892.   $form['admin_account'] = array(
  893.     '#type' => 'fieldset',
  894.     '#title' => st('Administrator account'),
  895.     '#collapsible' => FALSE,
  896.   );
  897.   $form['admin_account']['account']['#tree'] = TRUE;
  898.   $form['admin_account']['markup'] = array(
  899.     '#value' => '<p class="description">'st('The administrator account has complete access to the site; it will automatically be granted all permissions and can perform any administrative activity. This will be the only account that can perform certain activities, so keep its credentials safe.') .'</p>',
  900.     '#weight' => -10,
  901.   );
  902.   $form['admin_account']['account']['name'] = array('#type' => 'textfield',
  903.     '#title' => st('Username'),
  904.     '#maxlength' => USERNAME_MAX_LENGTH,
  905.     '#description' => st('Spaces are allowed; punctuation is not allowed except for periods, hyphens, and underscores.'),
  906.     '#required' => TRUE,
  907.     '#weight' => -10,
  908.   );
  909.   $form['admin_account']['account']['mail'] = array('#type' => 'textfield',
  910.     '#title' => st('E-mail address'),
  911.     '#maxlength' => EMAIL_MAX_LENGTH,
  912.     '#description' => st('All e-mails from the system will be sent to this address. The e-mail address is not made public and will only be used if you wish to receive a new password or wish to receive certain news or notifications by e-mail.'),
  913.     '#required' => TRUE,
  914.     '#weight' => -5,
  915.   );
  916.   $form['admin_account']['account']['pass'] = array(
  917.     '#type' => 'password_confirm',
  918.     '#required' => TRUE,
  919.     '#size' => 25,
  920.     '#weight' => 0,
  921.   );
  922.   $form['server_settings'] = array(
  923.     '#type' => 'fieldset',
  924.     '#title' => st('Server settings'),
  925.     '#collapsible' => FALSE,
  926.   );
  927.   $form['server_settings']['date_default_timezone'] = array(
  928.     '#type' => 'select',
  929.     '#title' => st('Default time zone'),
  930.     '#default_value' => 0,
  931.     '#options' => _system_zonelist(),
  932.     '#description' => st('By default, dates in this site will be displayed in the chosen time zone.'),
  933.     '#weight' => 5,
  934.   );
  935.   $form['server_settings']['clean_url'] = array(
  936.     '#type' => 'radios',
  937.     '#title' => st('Clean URLs'),
  938.     '#default_value' => 0,
  939.     '#options' => array(=> st('Disabled'), => st('Enabled')),
  940.     '#description' => st('This option makes Drupal emit "clean" URLs (i.e. without <code>?q=</code> in the URL).'),
  941.     '#disabled' => TRUE,
  942.     '#prefix' => '<div id="clean-url" class="install">',
  943.     '#suffix' => '</div>',
  944.     '#weight' => 10,
  945.   );
  946.   $form['server_settings']['update_status_module'] = array(
  947.     '#type' => 'checkboxes',
  948.     '#title' => st('Update notifications'),
  949.     '#options' => array(=> st('Check for updates automatically')),
  950.     '#default_value' => array(1),
  951.     '#description' => st('With this option enabled, Drupal will notify you when new releases are available. This will significantly enhance your site\'s security and is <strong>highly recommended</strong>. This requires your site to periodically send anonymous information on its installed components to <a href="@drupal">drupal.org</a>. For more information please see the <a href="@update">update notification information</a>.', array('@drupal' => 'http://drupal.org''@update' => 'http://drupal.org/handbook/modules/update')),
  952.     '#weight' => 15,
  953.   );
  954.   $form['submit'] = array(
  955.     '#type' => 'submit',
  956.     '#value' => st('Save and continue'),
  957.     '#weight' => 15,
  958.   );
  959.   $form['#action'] = $url;
  960.   $form['#redirect'] = FALSE;
  961.   // Allow the profile to alter this form. $form_state isn't available
  962.   // here, but to conform to the hook_form_alter() signature, we pass
  963.   // an empty array.
  964.   $hook_form_alter $_GET['profile'] .'_form_alter';
  965.   if (function_exists($hook_form_alter)) {
  966.     $hook_form_alter($form, array(), 'install_configure');
  967.   }
  968.   return $form;
  969. }
  970. /**
  971.  * Form API validate for the site configuration form.
  972.  */
  973. function install_configure_form_validate($form, &$form_state) {
  974.   if ($error user_validate_name($form_state['values']['account']['name'])) {
  975.     form_error($form['admin_account']['account']['name'], $error);
  976.   }
  977.   if ($error user_validate_mail($form_state['values']['account']['mail'])) {
  978.     form_error($form['admin_account']['account']['mail'], $error);
  979.   }
  980.   if ($error user_validate_mail($form_state['values']['site_mail'])) {
  981.     form_error($form['site_information']['site_mail'], $error);
  982.   }
  983. }
  984. /**
  985.  * Form API submit for the site configuration form.
  986.  */
  987. function install_configure_form_submit($form, &$form_state) {
  988.   global $user;
  989.   variable_set('site_name'$form_state['values']['site_name']);
  990.   variable_set('site_mail'$form_state['values']['site_mail']);
  991.   variable_set('date_default_timezone'$form_state['values']['date_default_timezone']);
  992.   // Enable update.module if this option was selected.
  993.   if ($form_state['values']['update_status_module'][1]) {
  994.     drupal_install_modules(array('update'));
  995.   }
  996.   // Turn this off temporarily so that we can pass a password through.
  997.   variable_set('user_email_verification'FALSE);
  998.   $form_state['old_values'] = $form_state['values'];
  999.   $form_state['values'] = $form_state['values']['account'];
  1000.   // We precreated user 1 with placeholder values. Let's save the real values.
  1001.   $account user_load(1);
  1002.   $merge_data = array('init' => $form_state['values']['mail'], 'roles' => array(), 'status' => 1);
  1003.   user_save($accountarray_merge($form_state['values'], $merge_data));
  1004.   // Log in the first user.
  1005.   user_authenticate($form_state['values']);
  1006.   $form_state['values'] = $form_state['old_values'];
  1007.   unset($form_state['old_values']);
  1008.   variable_set('user_email_verification'TRUE);
  1009.   if (isset($form_state['values']['clean_url'])) {
  1010.     variable_set('clean_url'$form_state['values']['clean_url']);
  1011.   }
  1012.   // The user is now logged in, but has no session ID yet, which
  1013.   // would be required later in the request, so remember it.
  1014.   $user->sid session_id();
  1015.   // Record when this install ran.
  1016.   variable_set('install_time'time());
  1017. }
  1018. // Start the installer.
  1019. install_main();