Index: CHANGELOG.txt =================================================================== RCS file: /cvs/drupal/drupal/CHANGELOG.txt,v retrieving revision 1.318 diff -u -p -r1.318 CHANGELOG.txt --- CHANGELOG.txt 27 Jul 2009 19:53:17 -0000 1.318 +++ CHANGELOG.txt 27 Jul 2009 20:51:37 -0000 @@ -124,6 +124,9 @@ Drupal 7.0, xxxx-xx-xx (development vers and allow custom data fields to be attached to itself. * Provides a subset of the features of the Content Construction Kit (CCK) module. +- Installer: + * Refactored the installer into an API that allows Drupal to be installed + via a command line script. - Page organization * Made the help text area a full featured region with blocks. * Site mission is replaced with the highlighted content block region and Index: install.php =================================================================== RCS file: /cvs/drupal/drupal/install.php,v retrieving revision 1.187 diff -u -p -r1.187 install.php --- install.php 27 Jul 2009 19:42:54 -0000 1.187 +++ install.php 27 Jul 2009 20:51:42 -0000 @@ -14,17 +14,216 @@ require_once DRUPAL_ROOT . '/includes/in 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. + * Global flag to indicate that a task should not be run during the current + * installation request. * - * @param $phase - * The installation phase we should proceed to. + * This can be used to skip running an installation task when certain + * conditions are met, even though the task may still show on the list of + * installation tasks presented to the user. For example, the Drupal installer + * uses this flag to skip over the database configuration form when valid + * database connection information is already available from settings.php. It + * also uses this flag to skip language import tasks when the installation is + * being performed in English. */ -function install_main() { +define('INSTALL_TASK_SKIP', 1); + +/** + * Global flag to indicate that a task should be run on each installation + * request that reaches it. + * + * This is primarily used by the Drupal installer for bootstrap-related tasks. + */ +define('INSTALL_TASK_RUN_IF_REACHED', 2); + +/** + * Global flag to indicate that a task should be run on each installation + * request that reaches it, until the database is set up and we are able to + * record the fact that it already ran. + * + * This is the default method for running tasks and should be used for most + * tasks that occur after the database is set up; these tasks will then run + * once and be marked complete once they are successfully finished. For + * example, the Drupal installer uses this flag for the batch installation of + * modules on the new site, and also for the configuration form that collects + * basic site information and sets up the first user account. + */ +define('INSTALL_TASK_RUN_IF_NOT_COMPLETED', 3); + +/** + * Install Drupal either interactively or via an array of passed-in settings. + * + * The Drupal installation happens in a series of steps, which may be spread + * out over multiple page requests. Each request begins by trying to determine + * the last completed installation step (also known as a "task"), if one is + * available from a previous request. Control is then passed to the task + * handler, which processes the remaining tasks that need to be run until (a) + * an error is thrown, (b) a new page needs to be displayed, or (c) the + * installation finishes (whichever happens first). + * + * @param $settings + * An optional array of installation settings. Leave this empty for a normal, + * interactive, browser-based installation intended to occur over multiple + * page requests. Alternatively, if an array of settings is passed in, the + * installer will attempt to use it to perform the installation in a single + * page request (optimized for the command line) and not send any output + * intended for the web browser. See install_state_defaults() for a list of + * elements that are allowed to appear in this array. + * + * @see install_state_defaults() + */ +function install_drupal($settings = array()) { + global $install_state; + // Initialize the installation state with the settings that were passed in, + // as well as a boolean indicating whether or not this is an interactive + // installation. + $interactive = empty($settings); + $install_state = $settings + array('interactive' => $interactive) + install_state_defaults(); + try { + // Begin the page request. This adds information about the current state of + // the Drupal installation to the passed-in array. + install_begin_request($install_state); + // Based on the installation state, run the remaining tasks for this page + // request, and collect any output. + $output = install_run_tasks($install_state); + } + catch (Exception $e) { + // When an installation error occurs, either send the error to the web + // browser or pass on the exception so the calling script can use it. + if ($install_state['interactive']) { + install_display_output($e->getMessage(), $install_state); + } + else { + throw $e; + } + } + // All available tasks for this page request are now complete. Interactive + // installations can send output to the browser or redirect the user to the + // next page. + if ($install_state['interactive']) { + if ($install_state['parameters_changed']) { + // Redirect to the correct page if the URL parameters have changed. + install_goto(install_redirect_url($install_state)); + } + elseif (isset($output)) { + // Display a page only if some output is available. Otherwise it is + // possible that we are printing a JSON page and theme output should + // not be shown. + install_display_output($output, $install_state); + } + } +} + +/** + * Return an array of default settings for the global installation state. + * + * The installation state is initialized with these settings at the beginning + * of each page request. They may evolve during the page request, but they are + * initialized again once the next request begins. + * + * Non-interactive Drupal installations can override some of these default + * settings by passing in an array to the installation script, most notably + * 'parameters' (which contains one-time parameters such as 'profile' and + * 'locale' that are normally passed in via the URL) and 'forms' (which can + * be used to programmatically submit forms during the installation; the keys + * of each element indicate the name of the installation task that the form + * submission is for, and the values are used as the $form_state['values'] + * array that is passed on to the form submission via drupal_form_submit()). + * + * @see drupal_form_submit() + */ +function install_state_defaults() { + $defaults = array( + // The current task being processed. + 'active_task' => NULL, + // The last task that was completed during the previous installation + // request. + 'completed_task' => NULL, + // This becomes TRUE only when Drupal's system module is installed. + 'database_tables_exist' => FALSE, + // An array of forms to be programmatically submitted during the + // installation. The keys of each element indicate the name of the + // installation task that the form submission is for, and the values are + // used as the $form_state['values'] array that is passed on to the form + // submission via drupal_form_submit(). + 'forms' => array(), + // This becomes TRUE only at the end of the installation process, after + // all available tasks have been completed and Drupal is fully installed. + // It is used by the installer to store correct information in the database + // about the completed installation, as well as to inform theme functions + // that all tasks are finished (so that the task list can be displayed + // correctly). + 'installation_finished' => FALSE, + // Whether or not this installation is interactive. By default this will + // be set to FALSE if settings are passed in to install_drupal(). + 'interactive' => TRUE, + // An array of available languages for the installation. + 'locales' => array(), + // An array of parameters for the installation, pre-populated by the URL + // or by the settings passed in to install_drupal(). This is primarily + // used to store 'profile' (the name of the chosen installation profile) + // and 'locale' (the name of the chosen installation language), since + // these settings need to persist from page request to page request before + // the database is available for storage. + 'parameters' => array(), + // Whether or not the parameters have changed during the current page + // request. For interactive installations, this will trigger a page + // redirect. + 'parameters_changed' => FALSE, + // An array of information about the chosen installation profile. This will + // be filled in based on the profile's .info file. + 'profile_info' => array(), + // An array of available installation profiles. + 'profiles' => array(), + // An array of server variables that will be substituted into the global + // $_SERVER array via drupal_override_server_variables(). Used by + // non-interactive installations only. + 'server' => array(), + // This becomes TRUE only when a valid database connection can be + // established. + 'settings_verified' => FALSE, + // Installation tasks can set this to TRUE to force the page request to + // end (even if there is no themable output), in the case of an interactive + // installation. This is needed only rarely; for example, it would be used + // by an installation task that prints JSON output rather than returning a + // themed page. The most common example of this is during batch processing, + // but the Drupal installer automatically takes care of setting this + // parameter properly in that case, so that individual installation tasks + // which implement the batch API do not need to set it themselves. + 'stop_page_request' => FALSE, + // Installation tasks can set this to TRUE to indicate that the task should + // be run again, even if it normally wouldn't be. This can be used, for + // example, if a single task needs to be spread out over multiple page + // requests, or if it needs to perform some validation before allowing + // itself to be marked complete. The most common examples of this are batch + // processing and form submissions, but the Drupal installer automatically + // takes care of setting this parameter properly in those cases, so that + // individual installation tasks which implement the batch API or form API + // do not need to set it themselves. + 'task_not_complete' => FALSE, + // A list of installation tasks which have already been performed during + // the current page request. + 'tasks_performed' => array(), + ); + return $defaults; +} + +/** + * Begin an installation request, modifying the installation state as needed. + * + * This function performs commands that must run at the beginning of every page + * request. It throws an exception if the installation should not proceed. + * + * @param $install_state + * An array of information about the current installation state. This is + * modified with information gleaned from the beginning of the page request. + */ +function install_begin_request(&$install_state) { + // Allow command line scripts to override server variables used by Drupal. + require_once DRUPAL_ROOT . '/includes/bootstrap.inc'; + if (!$install_state['interactive']) { + drupal_override_server_variables($install_state['server']); + } + // The user agent header is used to pass a database prefix in the request when // running tests. However, for security reasons, it is imperative that no // installation be permitted using such a prefix. @@ -33,17 +232,15 @@ function install_main() { exit; } - require_once DRUPAL_ROOT . '/includes/bootstrap.inc'; drupal_bootstrap(DRUPAL_BOOTSTRAP_CONFIGURATION); // This must go after drupal_bootstrap(), which unsets globals! - global $profile, $install_locale, $conf; + global $conf; require_once DRUPAL_ROOT . '/modules/system/system.install'; + require_once DRUPAL_ROOT . '/includes/common.inc'; require_once DRUPAL_ROOT . '/includes/file.inc'; - - // Ensure correct page headers are sent (e.g. caching) - drupal_page_header(); + require_once DRUPAL_ROOT . '/includes/path.inc'; // Set up $language, so t() caller functions will still work. drupal_language_initialize(); @@ -57,13 +254,17 @@ function install_main() { drupal_load('module', 'system'); drupal_load('module', 'filter'); - // Set up theme system for the maintenance page. - drupal_maintenance_theme(); + // Prepare for themed output, if necessary. We need to run this at the + // beginning of the page request to avoid a different theme accidentally + // getting set. + if ($install_state['interactive']) { + drupal_maintenance_theme(); + } // Check existing settings.php. - $verify = install_verify_settings(); + $install_state['settings_verified'] = install_verify_settings(); - if ($verify) { + if ($install_state['settings_verified']) { // 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. @@ -74,11 +275,8 @@ function install_main() { // won't be initialized until it is actually requested. require_once DRUPAL_ROOT . '/includes/database/database.inc'; - // Check if Drupal is installed. - $task = install_verify_drupal(); - if ($task == 'done') { - install_already_done_error(); - } + // Verify the last completed task in the database, if there is one. + $task = install_verify_completed_task(); } else { // Since no persistent storage is available yet, and functions that check @@ -89,90 +287,479 @@ function install_main() { $conf['cache_inc'] = 'includes/cache-install.inc'; $task = NULL; + + // Since previous versions of Drupal stored database connection information + // in the 'db_url' variable, we should never let an installation proceed if + // this variable is defined and the settings file was not verified above + // (otherwise we risk installing over an existing site whose settings file + // has not yet been updated). + if (!empty($GLOBALS['db_url'])) { + throw new Exception(install_already_done_error()); + } } - // Decide which profile to use. - if (!empty($_GET['profile'])) { - $profile = preg_replace('/[^a-zA-Z_0-9]/', '', $_GET['profile']); + // Modify the installation state as appropriate. + $install_state['completed_task'] = $task; + $install_state['database_tables_exist'] = !empty($task); + + // Add any installation parameters passed in via the URL. + $install_state['parameters'] += $_GET; + + // Validate certain core settings that are used throughout the installation. + if (!empty($install_state['parameters']['profile'])) { + $install_state['parameters']['profile'] = preg_replace('/[^a-zA-Z_0-9]/', '', $install_state['parameters']['profile']); } - elseif ($profile = install_select_profile()) { - install_goto("install.php?profile=$profile"); + if (!empty($install_state['parameters']['locale'])) { + $install_state['parameters']['locale'] = preg_replace('/[^a-zA-Z_0-9\-]/', '', $install_state['parameters']['locale']); } - else { - install_no_profile_error(); +} + +/** + * Run all tasks for the current installation request. + * + * In the case of an interactive installation, all tasks will be attempted + * until one is reached that has output which needs to be displayed to the + * user, or until a page redirect is required. Otherwise, tasks will be + * attempted until the installation is finished. + * + * @param $install_state + * An array of information about the current installation state. This is + * passed along to each task, so it can be modified if necessary. + * @return + * HTML output from the last completed task. + */ +function install_run_tasks(&$install_state) { + do { + // Obtain a list of tasks to perform. The list of tasks itself can be + // dynamic (e.g., some might be defined by the installation profile, + // which is not necessarily known until the earlier tasks have run), + // so we regenerate the remaining tasks based on the installation state, + // each time through the loop. + $tasks_to_perform = install_tasks_to_perform($install_state); + // Run the first task on the list. + reset($tasks_to_perform); + $task_name = key($tasks_to_perform); + $task = array_shift($tasks_to_perform); + $install_state['active_task'] = $task_name; + $original_parameters = $install_state['parameters']; + $output = install_run_task($task, $install_state); + $install_state['parameters_changed'] = ($install_state['parameters'] != $original_parameters); + // Store this task as having been performed during the current request, + // and save it to the database as completed, if we need to and if the + // database is in a state that allows us to do so. Also mark the + // installation as 'done' when we have run out of tasks. + if (!$install_state['task_not_complete']) { + $install_state['tasks_performed'][] = $task_name; + $install_state['installation_finished'] = empty($tasks_to_perform); + if ($install_state['database_tables_exist'] && ($task['run'] == INSTALL_TASK_RUN_IF_NOT_COMPLETED || $install_state['installation_finished'])) { + drupal_install_initialize_database(); + variable_set('install_task', $install_state['installation_finished'] ? 'done' : $task_name); + } + } + // Stop when there are no tasks left. In the case of an interactive + // installation, also stop if we have some output to send to the browser, + // the URL parameters have changed, or an end to the page request was + // specifically called for. + $finished = empty($tasks_to_perform) || ($install_state['interactive'] && (isset($output) || $install_state['parameters_changed'] || $install_state['stop_page_request'])); + } while (!$finished); + return $output; +} + +/** + * Run an individual installation task. + * + * @param $task + * An array of information about the task to be run. + * @param $install_state + * An array of information about the current installation state. This is + * passed in by reference so that it can be modified by the task. + * @return + * The output of the task function, if there is any. + */ +function install_run_task($task, &$install_state) { + $function = $task['function']; + + if ($task['type'] == 'form') { + require_once DRUPAL_ROOT . '/includes/form.inc'; + if ($install_state['interactive']) { + // For interactive forms, build the form and ensure that it will not + // redirect, since the installer handles its own redirection only after + // marking the form submission task complete. + $form_state = array( + 'args' => array($install_state), + 'no_redirect' => TRUE, + ); + $form = drupal_build_form($function, $form_state); + // If a successful form submission did not occur, the form needs to be + // rendered, which means the task is not complete yet. + if (empty($form_state['executed'])) { + $install_state['task_not_complete'] = TRUE; + return drupal_render($form); + } + // Otherwise, return nothing so the next task will run in the same + // request. + return; + } + else { + // For non-interactive forms, submit the form programmatically with the + // values taken from the installation state. Throw an exception if any + // errors were encountered. + $form_state = array('values' => !empty($install_state['forms'][$function]) ? $install_state['forms'][$function] : array()); + drupal_form_submit($function, $form_state, $install_state); + $errors = form_get_errors(); + if (!empty($errors)) { + throw new Exception(implode("\n", $errors)); + } + } } + elseif ($task['type'] == 'batch') { + // Start a new batch based on the task function, if one is not running + // already. + $current_batch = variable_get('install_current_batch'); + if (!$install_state['interactive'] || !$current_batch) { + $batch = $function($install_state); + if (empty($batch)) { + // If the task did some processing and decided no batch was necessary, + // there is nothing more to do here. + return; + } + batch_set($batch); + // For interactive batches, we need to store the fact that this batch + // task is currently running. Otherwise, we need to make sure the batch + // will complete in one page request. + if ($install_state['interactive']) { + variable_set('install_current_batch', $function); + } + else { + $batch =& batch_get(); + $batch['progressive'] = FALSE; + } + // Process the batch. For progressive batches, this will redirect. + // Otherwise, the batch will complete. + batch_process(install_redirect_url($install_state), install_full_redirect_url($install_state)); + } + // If we are in the middle of processing this batch, keep sending back + // any output from the batch process, until the task is complete. + elseif ($current_batch == $function) { + include_once DRUPAL_ROOT . '/includes/batch.inc'; + $output = _batch_page(); + // The task is complete when we try to access the batch page and receive + // FALSE in return, since this means we are at a URL where we are no + // longer requesting a batch ID. + if ($output === FALSE) { + // Return nothing so the next task will run in the same request. + variable_del('install_current_batch'); + return; + } + else { + // We need to force the page request to end if the task is not + // complete, since the batch API sometimes prints JSON output + // rather than returning a themed page. + $install_state['task_not_complete'] = $install_state['stop_page_request'] = TRUE; + return $output; + } + } + } - // Locale selection - if (!empty($_GET['locale'])) { - $install_locale = preg_replace('/[^a-zA-Z_0-9\-]/', '', $_GET['locale']); + else { + // For normal tasks, just return the function result, whatever it is. + return $function($install_state); } - elseif (($install_locale = install_select_locale($profile)) !== FALSE) { - install_goto("install.php?profile=$profile&locale=$install_locale"); +} + +/** + * Return a list of tasks to perform during the current installation request. + * + * Note that the list of tasks can change based on the installation state as + * the page request evolves (for example, if an installation profile hasn't + * been selected yet, we don't yet know which profile tasks need to be run). + * + * @param $install_state + * An array of information about the current installation state. + * @return + * A list of tasks to be performed, with associated metadata. + */ +function install_tasks_to_perform($install_state) { + // Start with a list of all currently available tasks. + $tasks = install_tasks($install_state); + foreach ($tasks as $name => $task) { + // Remove any tasks that were already performed or that never should run. + // Also, if we started this page request with an indication of the last + // task that was completed, skip that task and all those that come before + // it, unless they are marked as always needing to run. + if ($task['run'] == INSTALL_TASK_SKIP || in_array($name, $install_state['tasks_performed']) || (!empty($install_state['completed_task']) && empty($completed_task_found) && $task['run'] != INSTALL_TASK_RUN_IF_REACHED)) { + unset($tasks[$name]); + } + if (!empty($install_state['completed_task']) && $name == $install_state['completed_task']) { + $completed_task_found = TRUE; + } } + return $tasks; +} - // Load the profile. - require_once DRUPAL_ROOT . "/profiles/$profile/$profile.profile"; - $info = install_profile_info($profile, $install_locale); +/** + * Return a list of all tasks the installer currently knows about. + * + * This function will return tasks regardless of whether or not they are + * intended to run on the current page request. However, the list can change + * based on the installation state (for example, if an installation profile + * hasn't been selected yet, we don't yet know which profile tasks will be + * available). + * + * @param $install_state + * An array of information about the current installation state. + * @return + * A list of tasks, with associated metadata. + */ +function install_tasks($install_state) { + // Determine whether translation import tasks will need to be performed. + $needs_translations = count($install_state['locales']) > 1 && !empty($install_state['parameters']['locale']) && $install_state['parameters']['locale'] != 'en'; - // Tasks come after the database is set up - if (!$task) { - global $db_url; + // Start with the core installation tasks that run before handing control + // to the install profile. + $tasks = array( + 'install_select_profile' => array( + 'display_name' => st('Choose profile'), + 'display' => count($install_state['profiles']) != 1, + 'run' => INSTALL_TASK_RUN_IF_REACHED, + ), + 'install_select_locale' => array( + 'display_name' => st('Choose language'), + 'run' => INSTALL_TASK_RUN_IF_REACHED, + ), + 'install_load_profile' => array( + 'run' => INSTALL_TASK_RUN_IF_REACHED, + ), + 'install_verify_requirements' => array( + 'display_name' => st('Verify requirements'), + ), + 'install_settings_form' => array( + 'display_name' => st('Set up database'), + 'type' => 'form', + 'run' => $install_state['settings_verified'] ? INSTALL_TASK_SKIP : INSTALL_TASK_RUN_IF_NOT_COMPLETED, + ), + 'install_system_module' => array( + ), + 'install_bootstrap_full' => array( + 'run' => INSTALL_TASK_RUN_IF_REACHED, + ), + 'install_profile_modules' => array( + 'display_name' => count($install_state['profiles']) == 1 ? st('Install site') : st('Install profile'), + 'type' => 'batch', + ), + 'install_import_locales' => array( + 'display_name' => st('Set up translations'), + 'display' => $needs_translations, + 'type' => 'batch', + 'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP, + ), + 'install_configure_form' => array( + 'display_name' => st('Configure site'), + 'type' => 'form', + ), + ); - if (!$verify && !empty($db_url)) { - // Do not install over a configured settings.php. - install_already_done_error(); + // Now add any tasks defined by the installation profile. + if (!empty($install_state['parameters']['profile'])) { + $function = $install_state['parameters']['profile'] . '_profile_tasks'; + if (function_exists($function)) { + $result = $function($install_state); + if (is_array($result)) { + $tasks += $result; + } } + } + + // Finish by adding the remaining core tasks. + $tasks += array( + 'install_import_locales_remaining' => array( + 'display_name' => st('Finish translations'), + 'display' => $needs_translations, + 'type' => 'batch', + 'run' => $needs_translations ? INSTALL_TASK_RUN_IF_NOT_COMPLETED : INSTALL_TASK_SKIP, + ), + 'install_finished' => array( + 'display_name' => st('Finished'), + ), + ); + + // Fill in default parameters for each task before returning the list. + foreach ($tasks as $task_name => &$task) { + $task += array( + 'display_name' => NULL, + 'display' => !empty($task['display_name']), + 'type' => 'normal', + 'run' => INSTALL_TASK_RUN_IF_NOT_COMPLETED, + 'function' => $task_name, + ); + } + return $tasks; +} +/** + * Return a list of tasks that should be displayed to the end user. + * + * The output of this function is a list suitable for sending to + * theme_task_list(). + * + * @param $install_state + * An array of information about the current installation state. + * @return + * A list of tasks, with keys equal to the machine-readable task name and + * values equal to the name that should be displayed. + * + * @see theme_task_list() + */ +function install_tasks_to_display($install_state) { + $displayed_tasks = array(); + foreach (install_tasks($install_state) as $name => $task) { + if ($task['display']) { + $displayed_tasks[$name] = $task['display_name']; + } + } + return $displayed_tasks; +} + +/** + * Return the URL that should be redirected to during an installation request. + * + * The output of this function is suitable for sending to install_goto(). + * + * @param $install_state + * An array of information about the current installation state. + * @return + * The URL to redirect to. + * + * @see install_full_redirect_url() + */ +function install_redirect_url($install_state) { + return 'install.php?' . drupal_query_string_encode($install_state['parameters']); +} + +/** + * Return the complete URL that should be redirected to during an installation + * request. + * + * @param $install_state + * An array of information about the current installation state. + * @return + * The complete URL to redirect to. + * + * @see install_redirect_url() + */ +function install_full_redirect_url($install_state) { + global $base_url; + return $base_url . '/' . install_redirect_url($install_state); +} + +/** + * Display themed installer output and end the page request. + * + * Installation tasks should use drupal_set_title() to set the desired page + * title, but otherwise this function takes care of theming the overall page + * output during every step of the installation. + * + * @param $output + * The content to display on the main part of the page. + * @param $install_state + * An array of information about the current installation state. + */ +function install_display_output($output, $install_state) { + drupal_page_header(); + // Only show the task list if there is an active task; otherwise, the page + // request has ended before tasks have even been started, so there is nothing + // meaningful to show. + if (isset($install_state['active_task'])) { + // Let the theming function know when every step of the installation has + // been completed. + $active_task = $install_state['installation_finished'] ? NULL : $install_state['active_task']; + drupal_add_region_content('left', theme_task_list(install_tasks_to_display($install_state), $active_task)); + } + print theme($install_state['database_tables_exist'] ? 'maintenance_page' : 'install_page', $output); + exit; +} + +/** + * Installation task; verify the requirements for installing Drupal. + * + * @param $install_state + * An array of information about the current installation state. + * @return + * A themed status report, or an exception if there are requirement errors. + * Otherwise, no output is returned, so that the next task can be run + * in the same page request. + */ +function install_verify_requirements(&$install_state) { // Check the installation requirements for Drupal and this profile. - $requirements = install_check_requirements($profile, $verify); + $requirements = install_check_requirements($install_state); // Verify existence of all required modules. - $requirements += drupal_verify_profile($profile, $install_locale); + $requirements += drupal_verify_profile($install_state); // Check the severity of the requirements reported. $severity = drupal_requirements_severity($requirements); if ($severity == REQUIREMENT_ERROR) { - install_task_list('requirements'); - drupal_set_title(st('Requirements problem')); - $status_report = theme('status_report', $requirements); - $status_report .= st('Please check the error messages and try again.', array('!url' => request_uri())); - print theme('install_page', $status_report); - 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); + if ($install_state['interactive']) { + drupal_set_title(st('Requirements problem')); + $status_report = theme('status_report', $requirements); + $status_report .= st('Please check the error messages and try again.', array('!url' => request_uri())); + return $status_report; + } + else { + // Throw an exception showing all unmet requirements. + $failures = array(); + foreach ($requirements as $requirement) { + if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_ERROR) { + $failures[] = $requirement['title'] . ': ' . $requirement['value'] . "\n\n" . $requirement['description']; + } + } + throw new Exception(implode("\n\n", $failures)); + } } +} +/** + * Installation task; install the Drupal system module. + * + * @param $install_state + * An array of information about the current installation state. + */ +function install_system_module(&$install_state) { // 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. - $modules = $info['dependencies']; + // Save the list of other modules to install for the upcoming tasks. + // variable_set() can be used now that system.module is installed and + // Drupal is bootstrapped. + $modules = $install_state['profile_info']['dependencies']; variable_set('install_profile_modules', array_diff($modules, array('system'))); - } - - // The database is set up, turn to further tasks. - install_tasks($profile, $task); + $install_state['database_tables_exist'] = TRUE; } /** - * Verify if Drupal is installed. + * Verify and return the last installation task that was completed. + * + * @return + * The last completed task, if there is one. An exception is thrown if Drupal + * is already installed. */ -function install_verify_drupal() { - // Read the variable manually using the @ so we don't trigger an error if it fails. +function install_verify_completed_task() { try { if ($result = db_query("SELECT value FROM {variable} WHERE name = '%s'", 'install_task')) { - return unserialize(db_result($result)); + $task = unserialize(db_result($result)); } } + // Do not trigger an error if the database query fails, since the database + // might not be set up yet. catch (Exception $e) { } + if (isset($task)) { + if ($task == 'done') { + throw new Exception(install_already_done_error()); + } + return $task; + } } /** @@ -183,16 +770,11 @@ function install_verify_settings() { // Verify existing settings (if any). if (!empty($databases)) { - // We need this because we want to run form_get_errors. - include_once DRUPAL_ROOT . '/includes/form.inc'; - $database = $databases['default']['default']; drupal_static_reset('conf_path'); $settings_file = './' . conf_path(FALSE) . '/settings.php'; - - $form_state = array(); - _install_settings_form_validate($database, $settings_file, $form_state); - if (!form_get_errors()) { + $errors = install_database_errors($database, $settings_file); + if (empty($errors)) { return TRUE; } } @@ -200,37 +782,33 @@ function install_verify_settings() { } /** - * Configure and rewrite settings.php. + * Installation task; define a form to configure and rewrite settings.php. + * + * @param $form_state + * An associative array containing the current state of the form. + * @param $install_state + * An array of information about the current installation state. + * @return + * The form API definition for the database configuration form. */ -function install_change_settings($profile = 'default', $install_locale = '') { +function install_settings_form(&$form_state, &$install_state) { global $databases, $db_prefix; + $profile = $install_state['parameters']['profile']; + $install_locale = $install_state['parameters']['locale']; drupal_static_reset('conf_path'); $conf_path = './' . conf_path(FALSE); $settings_file = $conf_path . '/settings.php'; $database = isset($databases['default']['default']) ? $databases['default']['default'] : array(); - // We always need this because we want to run form_get_errors. - include_once DRUPAL_ROOT . '/includes/form.inc'; - install_task_list('database'); - - $output = drupal_render(drupal_get_form('install_settings_form', $profile, $install_locale, $settings_file, $database)); 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, $database) { $drivers = drupal_detect_database_types(); if (!$drivers) { - $form['no_drivers'] = array( - '#markup' => 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 Drupal supports.', array('@drupal-databases' => 'http://drupal.org/node/270#database')), - ); + // There is no point submitting the form if there are no database drivers + // at all, so throw an exception here. + throw new Exception(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 Drupal supports.', array('@drupal-databases' => 'http://drupal.org/node/270#database'))); } else { $form['basic_options'] = array( @@ -326,8 +904,6 @@ function install_settings_form(&$form_st $form['errors'] = array(); $form['settings_file'] = array('#type' => 'value', '#value' => $settings_file); $form['_database'] = array('#type' => 'value'); - $form['#action'] = "install.php?profile=$profile" . ($install_locale ? "&locale=$install_locale" : ''); - $form['#redirect'] = FALSE; } return $form; } @@ -336,34 +912,35 @@ function install_settings_form(&$form_st * Form API validate for install_settings form. */ function install_settings_form_validate($form, &$form_state) { - _install_settings_form_validate($form_state['values'], $form_state['values']['settings_file'], $form_state, $form); + form_set_value($form['_database'], $form_state['values'], $form_state); + $errors = install_database_errors($form_state['values'], $form_state['values']['settings_file']); + foreach ($errors as $name => $message) { + form_set_error($name, $message); + } } /** - * Helper function for install_settings_validate. + * Check a database connection and return any errors. */ -function _install_settings_form_validate($database, $settings_file, &$form_state, $form = NULL) { +function install_database_errors($database, $settings_file) { global $databases; + $errors = array(); // Verify the table prefix if (!empty($database['db_prefix']) && is_string($database['db_prefix']) && !preg_match('/^[A-Za-z0-9_.]+$/', $database['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' => $database['db_prefix'])), 'error'); + $errors['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' => $database['db_prefix'])); } if (!empty($database['port']) && !is_numeric($database['port'])) { - form_set_error('db_port', st('Database port must be a number.')); + $errors['db_port'] = st('Database port must be a number.'); } // Check database type $database_types = drupal_detect_database_types(); $driver = $database['driver']; if (!isset($database_types[$driver])) { - form_set_error('driver', st("In your %settings_file file you have configured @drupal to use a %driver server, however your PHP installation currently does not support this database type.", array('%settings_file' => $settings_file, '@drupal' => drupal_install_profile_name(), '%driver' => $database['driver']))); + $errors['driver'] = st("In your %settings_file file you have configured @drupal to use a %driver server, however your PHP installation currently does not support this database type.", array('%settings_file' => $settings_file, '@drupal' => drupal_install_profile_name(), '%driver' => $database['driver'])); } else { - if (isset($form)) { - form_set_value($form['_database'], $database, $form_state); - } - // Run tasks associated with the database type. Any errors are caught in the // calling function $databases['default']['default'] = $database; @@ -371,16 +948,20 @@ function _install_settings_form_validate db_run_tasks($database['driver']); } catch (DatabaseTaskException $e) { - form_set_error('db_type', $e->getMessage()); + // These are generic errors, so we do not have any specific key of the + // database connection array to attach them to; therefore, we just put + // them in the error array with standard numeric keys. + $errors[] = $e->getMessage(); } } + return $errors; } /** * Form API submit for install_settings form. */ function install_settings_form_submit($form, &$form_state) { - global $profile, $install_locale; + global $install_state; $database = array_intersect_key($form_state['values']['_database'], array_flip(array('driver', 'database', 'username', 'password', 'host', 'port'))); // Update global settings array and save @@ -393,9 +974,12 @@ function install_settings_form_submit($f 'required' => TRUE, ); drupal_rewrite_settings($settings); - - // Continue to install profile step - install_goto("install.php?profile=$profile" . ($install_locale ? "&locale=$install_locale" : '')); + // Indicate that the settings file has been verified, and check the database + // for the last completed task, now that we have a valid connection. This + // last step is important since we want to trigger an error if the new + // database already has Drupal installed. + $install_state['settings_verified'] = TRUE; + $install_state['completed_task'] = install_verify_completed_task(); } /** @@ -406,37 +990,66 @@ function install_find_profiles() { } /** - * Allow admin to select which profile to install. + * Installation task; allow the site administrator to select which profile to + * install. * + * @param $install_state + * An array of information about the current installation state. The chosen + * profile will be added here, if it was not already selected previously, as + * will a list of all available profiles. * @return - * The selected profile. - */ -function install_select_profile() { - include_once DRUPAL_ROOT . '/includes/form.inc'; + * For interactive installations, a form allowing the profile to be selected, + * if the user has a choice that needs to be made. Otherwise, an exception is + * thrown if a profile cannot be chosen automatically. + */ +function install_select_profile(&$install_state) { + $install_state['profiles'] += install_find_profiles(); + if (empty($install_state['parameters']['profile'])) { + // Try to find a profile. + $profile = _install_select_profile($install_state['profiles']); + if (empty($profile)) { + // We still don't have a profile, so display a form for selecting one. + // Only do this in the case of interactive installations, since this is + // not a real form with submit handlers (the database isn't even set up + // yet), rather just a convenience method for setting parameters in the + // URL. + if ($install_state['interactive']) { + include_once DRUPAL_ROOT . '/includes/form.inc'; + drupal_set_title(st('Select an installation profile')); + return drupal_render(drupal_get_form('install_select_profile_form', $install_state['profiles'])); + } + else { + throw new Exception(install_no_profile_error()); + } + } + else { + $install_state['parameters']['profile'] = $profile; + } + } +} - $profiles = install_find_profiles(); +/** + * Helper function for automatically selecting an installation profile from a + * list or from a selection passed in via $_POST. + */ +function _install_select_profile($profiles) { + if (sizeof($profiles) == 0) { + throw new Exception(install_no_profile_error()); + } // Don't need to choose profile if only one available. if (sizeof($profiles) == 1) { $profile = array_pop($profiles); - require_once $profile->filepath; return $profile->name; } - elseif (sizeof($profiles) > 1) { + else { foreach ($profiles as $profile) { if (!empty($_POST['profile']) && ($_POST['profile'] == $profile->name)) { return $profile->name; } } - - install_task_list('profile-select'); - - drupal_set_title(st('Select an installation profile')); - print theme('install_page', drupal_render(drupal_get_form('install_select_profile_form', $profiles))); - exit; } } - /** * Form API array definition for the profile selection form. * @@ -491,27 +1104,33 @@ function install_find_locales($profilena } /** - * Allow admin to select which locale to use for the current profile. + * Installation task; allow the site administrator to select which locale to + * use for the current profile. * + * @param $install_state + * An array of information about the current installation state. The chosen + * locale will be added here, if it was not already selected previously, as + * will a list of all available locales. * @return - * The selected language. + * For interactive installations, a form or other page output allowing the + * locale to be selected or providing information about locale selection, if + * a locale has not been chosen. Otherwise, an exception is thrown if a + * locale cannot be chosen automatically. */ -function install_select_locale($profilename) { - include_once DRUPAL_ROOT . '/includes/file.inc'; - include_once DRUPAL_ROOT . '/includes/form.inc'; - +function install_select_locale(&$install_state) { // Find all available locales. + $profilename = $install_state['parameters']['profile']; $locales = install_find_locales($profilename); - - // If only the built-in (English) language is available, - // and we are using the default profile, inform the user - // that the installer can be localized. Otherwise we assume - // the user know what he is doing. + $install_state['locales'] += $locales; + if (empty($install_state['parameters']['locale'])) { + // If only the built-in (English) language is available, and we are using the + // default profile and performing an interactive installation, inform the + // user that the installer can be localized. Otherwise we assume the user + // knows what he is doing. if (count($locales) == 1) { - if ($profilename == 'default') { - install_task_list('locale-select'); + if ($profilename == 'default' && $install_state['interactive']) { drupal_set_title(st('Choose language')); - if (!empty($_GET['localize'])) { + if (!empty($install_state['parameters']['localize'])) { $output = '

' . 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:') . '

'; $output .= '