Commit dd4f143d authored by Steven Wittens's avatar Steven Wittens

#75002: Install-time and run-time requirements checking + status report page

parent 246334f3
......@@ -4,7 +4,9 @@ Drupal x.x.x, xxxx-xx-xx (development version)
------------------------
- completely retooled the administration page
* /admin now contains an administration page which may be themed
* added a status report page with detailed PHP/MySQL information
- added web-based installer which can:
* check installation requirements
* automatically generate the database configuration file
* install pre-made 'install profiles' or distributions
* import the database structure with automatic table prefixing
......
......@@ -781,3 +781,15 @@ function drupal_maintenance_theme() {
drupal_add_css(drupal_get_path('module', 'system') .'/system.css', 'core');
$theme = '';
}
/**
* Return the name of the localisation function. Use in code that needs to
* run both during installation and normal operation.
*/
function get_t() {
static $t;
if (is_null($t)) {
$t = function_exists('install_main') ? 'st' : 't';
}
return $t;
}
......@@ -11,6 +11,28 @@
* @{
*/
/**
* Report database status.
*/
function db_status_report($phase) {
$t = get_t();
$info = mysql_get_server_info();
$form['mysql'] = array(
'title' => $t('MySQL database'),
'value' => ($phase == 'runtime') ? l($info, 'admin/logs/status/sql') : $info,
);
// Extract version number
list($version) = explode('-', $info);
if (version_compare($version, DRUPAL_MINIMUM_MYSQL) < 0) {
$form['mysql']['severity'] = REQUIREMENT_ERROR;
$form['mysql']['description'] = $t('Your MySQL Server is too old. Drupal requires at least MySQL %version.', array('%version' => DRUPAL_MINIMUM_MYSQL));
}
return $form;
}
/**
* Initialize a database connection.
*
......
......@@ -15,6 +15,27 @@
* @{
*/
/**
* Report database status.
*/
function db_status_report() {
$t = get_t();
$info = mysqli_get_server_info($connection);
$form['mysql'] = array(
'title' => $t('MySQL database'),
'value' => ($phase == 'runtime') ? l($info, 'admin/logs/status/sql') : $info,
);
// Extract version number
list($version) = explode('-', mysqli_get_server_info($connection));
if (version_compare($version, DRUPAL_MINIMUM_MYSQL) < 0) {
$form['mysql']['severity'] = REQUIREMENT_ERROR;
$form['mysql']['description'] = $t('Your MySQL Server is too old. Drupal requires at least MySQL %version.', array('%version' => DRUPAL_MINIMUM_MYSQL));
}
return $form;
}
/**
* Initialise a database connection.
*
......
......@@ -11,6 +11,31 @@
* @{
*/
/**
* Report database status.
*/
function db_status_report() {
$t = get_t().dli;
$form['pgsql'] = array();
if (function_exists('pg_version')) {
$version = pg_version();
if (version_compare($version['server'], DRUPAL_MINIMUM_PGSQL) < 0) {
$form['pgsql']['severity'] = REQUIREMENT_ERROR;
$form['pgsql']['description'] = $t('Your PostgreSQL Server is too old. Drupal requires at least PostgreSQL %version.', array('%version' => DRUPAL_MINIMUM_PGSQL));
}
}
else {
$version = array('server' => t('Unknown'));
}
$form['pgsql']['title'] = $t('PostgreSQL database');
$form['pgsql']['value'] = $version['server'];
return $form;
}
/**
* Initialize a database connection.
*
......
......@@ -4,11 +4,9 @@
define('SCHEMA_UNINSTALLED', -1);
define('SCHEMA_INSTALLED', 0);
define('DRUPAL_MINIMUM_PHP', '4.3.3');
define('DRUPAL_MINIMUM_MEMORY', '8M');
define('DRUPAL_MINIMUM_MYSQL', '3.23.17'); // If using MySQL
define('DRUPAL_MINIMUM_PGSQL', '7.3'); // If using PostgreSQL
define('DRUPAL_MINIMUM_APACHE', '1.3'); // If using Apache
define('REQUIREMENT_OK', 0);
define('REQUIREMENT_WARNING', 1);
define('REQUIREMENT_ERROR', 2);
define('FILE_EXIST', 1);
define('FILE_READABLE', 2);
......@@ -128,7 +126,7 @@ function drupal_detect_baseurl($file = 'install.php') {
$proto = $_SERVER['HTTPS'] ? 'https://' : 'http://';
$host = $_SERVER['SERVER_NAME'];
$port = ($_SERVER['SERVER_PORT'] == 80 ? '' : ':'. $_SERVER['SERVER_PORT']);
$uri = str_replace("?profile=$profile", '', $_SERVER['REQUEST_URI']);
$uri = preg_replace("/\?.*/", '', $_SERVER['REQUEST_URI']);
$dir = str_replace("/$file", '', $uri);
return "$proto$host$port$dir";
......@@ -602,3 +600,74 @@ function _st(&$value, $key) {
case '!':
}
}
/**
* Check a profile's requirements.
*
* @param profile
* Name of profile to check.
*/
function drupal_check_profile($profile) {
include_once './includes/file.inc';
$profile_file = "./profiles/$profile/$profile.profile";
if (!isset($profile) || !file_exists($profile_file)) {
install_no_profile_error();
}
require_once($profile_file);
// Get a list of modules required by this profile.
$function = $profile .'_profile_modules';
$module_list = array_unique(array_merge(array('system'), $function()));
// Get a list of all .install files.
$installs = drupal_get_install_files($module_list);
// Collect requirement testing results
$requirements = array();
foreach ($installs as $install) {
require_once $install->filename;
$requirements = array_merge($requirements, module_invoke($install->name, 'requirements', 'install'));
}
return $requirements;
}
/**
* Extract highest severity from requirements array.
*/
function drupal_requirements_severity(&$requirements) {
$severity = REQUIREMENT_OK;
foreach ($requirements as $requirement) {
if (isset($requirement['severity'])) {
$severity = max($severity, $requirement['severity']);
}
}
return $severity;
}
/**
* Check a module's requirements.
*/
function drupal_check_module($module) {
// Include install file
$install = drupal_get_install_files(array($module));
if (isset($install[$module])) {
require_once $install[$module]->filename;
// Check requirements
$requirements = module_invoke($module, 'requirements', 'install');
if (is_array($requirements) && drupal_requirements_severity($requirements) == REQUIREMENT_ERROR) {
// Print any error messages
foreach ($requirements as $requirement) {
if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_ERROR) {
drupal_set_message($requirement['description'] .' ('. t('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) .')', 'error');
}
}
return FALSE;
}
}
return TRUE;
}
......@@ -450,16 +450,16 @@ function theme_install_page($content) {
$output .= theme('status_messages', 'error');
}
$output .= "\n<!-- begin content -->\n";
$output .= $content;
$output .= "\n<!-- end content -->\n";
if (isset($messages['status'])) {
$warnings = count($messages['status']) > 1 ? 'warnings' : 'warning';
$output .= "<h4>The following installation $warnings should be carefully reviewed, but in most cases may be safely ignored:</h4>";
$output .= theme('status_messages', 'status');
}
$output .= "\n<!-- begin content -->\n";
$output .= $content;
$output .= "\n<!-- end content -->\n";
$output .= '</body></html>';
return $output;
......
......@@ -9,7 +9,7 @@
* Wrapper around _unicode_check().
*/
function unicode_check() {
$GLOBALS['multibyte'] = _unicode_check();
list($GLOBALS['multibyte']) = _unicode_check();
}
/**
......@@ -23,68 +23,70 @@ function unicode_check() {
* @param $errors
* Whether to report any fatal errors with form_set_error().
*/
function _unicode_check($errors = FALSE) {
function _unicode_check() {
// Ensure translations don't break at install time
$t = get_t();
// Set the standard C locale to ensure consistent, ASCII-only string handling.
setlocale(LC_CTYPE, 'C');
// Check for outdated PCRE library
// Note: we check if U+E2 is in the range U+E0 - U+E1. This test returns TRUE on old PCRE versions.
if (preg_match('/[à-á]/u', 'â')) {
if ($errors) {
form_set_error('unicode', t('The PCRE library in your PHP installation is outdated. This will cause problems when handling Unicode text. If you are running PHP 4.3.3 or higher, make sure you are using the PCRE library supplied by PHP. Please refer to the <a href="@url">PHP PCRE documentation</a> for more information.', array('@url' => 'http://www.php.net/pcre')));
}
return UNICODE_ERROR;
return array(UNICODE_ERROR, $t('The PCRE library in your PHP installation is outdated. This will cause problems when handling Unicode text. If you are running PHP 4.3.3 or higher, make sure you are using the PCRE library supplied by PHP. Please refer to the <a href="@url">PHP PCRE documentation</a> for more information.', array('@url' => 'http://www.php.net/pcre')), REQUIREMENT_ERROR);
}
// Check for mbstring extension
if (!function_exists('mb_strlen')) {
return UNICODE_SINGLEBYTE;
return array(UNICODE_SINGLEBYTE, $t('Operations on Unicode strings are emulated on a best-effort basis. Install the <a href="@url">PHP mbstring extension</a> for improved Unicode support.', array('@url' => 'http://www.php.net/mbstring')), REQUIREMENT_WARNING);
}
// Check mbstring configuration
if (ini_get('mbstring.func_overload') != 0) {
if ($errors) {
form_set_error('unicode', t('Multibyte string function overloading in PHP is active and must be disabled. Check the php.ini <em>mbstring.func_overload</em> setting. Please refer to the <a href="@url">PHP mbstring documentation</a> for more information.', array('@url' => 'http://www.php.net/mbstring')));
}
return UNICODE_ERROR;
return array(UNICODE_ERROR, $t('Multibyte string function overloading in PHP is active and must be disabled. Check the php.ini <em>mbstring.func_overload</em> setting. Please refer to the <a href="@url">PHP mbstring documentation</a> for more information.', array('@url' => 'http://www.php.net/mbstring')), REQUIREMENT_ERROR);
}
if (ini_get('mbstring.encoding_translation') != 0) {
if ($errors) {
form_set_error('unicode', t('Multibyte string input conversion in PHP is active and must be disabled. Check the php.ini <em>mbstring.encoding_translation</em> setting. Please refer to the <a href="@url">PHP mbstring documentation</a> for more information.', array('@url' => 'http://www.php.net/mbstring')));
}
return UNICODE_ERROR;
return array(UNICODE_ERROR, $t('Multibyte string input conversion in PHP is active and must be disabled. Check the php.ini <em>mbstring.encoding_translation</em> setting. Please refer to the <a href="@url">PHP mbstring documentation</a> for more information.', array('@url' => 'http://www.php.net/mbstring')), REQUIREMENT_ERROR);
}
if (ini_get('mbstring.http_input') != 'pass') {
if ($errors) {
form_set_error('unicode', t('Multibyte string input conversion in PHP is active and must be disabled. Check the php.ini <em>mbstring.http_input</em> setting. Please refer to the <a href="@url">PHP mbstring documentation</a> for more information.', array('@url' => 'http://www.php.net/mbstring')));
}
return UNICODE_ERROR;
return array(UNICODE_ERROR, $t('Multibyte string input conversion in PHP is active and must be disabled. Check the php.ini <em>mbstring.http_input</em> setting. Please refer to the <a href="@url">PHP mbstring documentation</a> for more information.', array('@url' => 'http://www.php.net/mbstring')), REQUIREMENT_ERROR);
}
if (ini_get('mbstring.http_output') != 'pass') {
if ($errors) {
form_set_error('unicode', t('Multibyte string output conversion in PHP is active and must be disabled. Check the php.ini <em>mbstring.http_output</em> setting. Please refer to the <a href="@url">PHP mbstring documentation</a> for more information.', array('@url' => 'http://www.php.net/mbstring')));
}
return UNICODE_ERROR;
return array(UNICODE_ERROR, $t('Multibyte string output conversion in PHP is active and must be disabled. Check the php.ini <em>mbstring.http_output</em> setting. Please refer to the <a href="@url">PHP mbstring documentation</a> for more information.', array('@url' => 'http://www.php.net/mbstring')), REQUIREMENT_ERROR);
}
// Set appropriate configuration
mb_internal_encoding('utf-8');
mb_language('uni');
return UNICODE_MULTIBYTE;
return array(UNICODE_MULTIBYTE);
}
/**
* Return the required Unicode status and errors for admin/settings.
* Return Unicode library status and errors.
*/
function unicode_settings() {
$status = _unicode_check(TRUE);
$options = array(UNICODE_SINGLEBYTE => t('Standard PHP: operations on Unicode strings are emulated on a best-effort basis. Install the <a href="@url">PHP mbstring extension</a> for improved Unicode support.', array('@url' => 'http://www.php.net/mbstring')),
UNICODE_MULTIBYTE => t('Multi-byte: operations on Unicode strings are supported through the <a href="@url">PHP mbstring extension</a>.', array('@url' => 'http://www.php.net/mbstring')),
UNICODE_ERROR => t('Invalid: the current configuration is incompatible with Drupal.'));
$form['settings'] = array('#type' => 'item', '#title' => t('String handling method'), '#value' => $options[$status]);
return $form;
function unicode_requirements() {
// Ensure translations don't break at install time
$t = function_exists('install_main') ? 'st' : 't';
$libraries = array(
UNICODE_SINGLEBYTE => $t('Standard PHP'),
UNICODE_MULTIBYTE => $t('PHP Mbstring Extension'),
UNICODE_ERROR => $t('Error'),
);
list($library, $description, $severity) = _unicode_check();
$requirements['unicode'] = array(
'title' => $t('Unicode library'),
'value' => $libraries[$library],
);
if ($description) {
$requirements['unicode']['description'] = $description;
$requirements['unicode']['severity'] = $severity;
}
return $requirements;
}
/**
* Prepare a new XML parser.
*
......
......@@ -28,7 +28,6 @@ function install_main() {
// Establish a connection to the database.
require_once './includes/database.inc';
db_set_active();
// Check if Drupal is installed.
if (install_verify_drupal()) {
install_already_done_error();
......@@ -70,6 +69,9 @@ function install_main() {
install_change_settings();
}
// Check the installation requirements for Drupal and this profile.
install_check_requirements($profile);
// Perform actual installation defined in the profile.
$modules = drupal_verify_profile($profile, $install_locale);
drupal_install_profile($profile, $modules);
......@@ -513,4 +515,27 @@ function install_complete($profile) {
print theme('maintenance_page', $output);
}
/**
* Page to check installation requirements and report any errors.
*/
function install_check_requirements($profile) {
$requirements = drupal_check_profile($profile);
$severity = drupal_requirements_severity($requirements);
// If there are issues, report them.
if ($severity == REQUIREMENT_ERROR) {
drupal_maintenance_theme();
foreach ($requirements as $requirement) {
if (isset($requirement['severity']) && $requirement['severity'] == REQUIREMENT_ERROR) {
drupal_set_message($requirement['description'] .' ('. st('Currently using !item !version', array('!item' => $requirement['title'], '!version' => $requirement['value'])) .')', 'error');
}
}
drupal_set_title('Incompatible environment');
print theme('install_page', '');
exit;
}
}
install_main();
......@@ -36,3 +36,25 @@ div.admin .expert-link {
margin-right: 1em;
padding-right: 4px;
}
/**
* Formatting for status report
*/
table.system-status-report th {
border-bottom: 1px solid #ccc;
}
table.system-status-report th, table.system-status-report tr.merge-up td {
padding-left: 30px;
}
table.system-status-report th {
background-repeat: no-repeat;
background-position: 5px 50%;
padding-top: 6px;
padding-bottom: 6px;
}
table.system-status-report tr.error th {
background-image: url('../../misc/watchdog-error.png');
}
table.system-status-report tr.warning th {
background-image: url('../../misc/watchdog-warning.png');
}
......@@ -36,7 +36,20 @@ thead th {
display: inline;
}
.error {
color: red;
color: #f00;
}
div.error {
border: 1px solid #d77;
}
div.error, tr.error {
background: #fcc;
color: #200;
}
div.warning, tr.warning {
background: #ffd;
}
div.ok, tr.ok {
background: #dfd;
}
.ok {
color: green;
......@@ -76,6 +89,12 @@ tr.odd .form-item, tr.even .form-item {
margin-bottom: 0;
white-space: nowrap;
}
tr.merge-down, tr.merge-down td, tr.merge-down th {
border-bottom-width: 0 !important;
}
tr.merge-up, tr.merge-up td, tr.merge-up th {
border-top-width: 0 !important;
}
.form-item input.error, .form-item textarea.error {
border: 2px solid red;
}
......@@ -103,9 +122,6 @@ tr.odd .form-item, tr.even .form-item {
.nowrap {
white-space: nowrap;
}
.ok {
color: #080;
}
#pager {
clear: both;
text-align: center;
......
<?php
// $Id$
define('DRUPAL_MINIMUM_PHP', '4.3.3');
define('DRUPAL_MINIMUM_MYSQL', '3.23.17'); // If using MySQL
define('DRUPAL_MINIMUM_PGSQL', '7.3'); // If using PostgreSQL
define('DRUPAL_MINIMUM_APACHE', '1.3'); // If using Apache
/**
* Test and report Drupal installation requirements.
*/
function system_requirements($phase) {
$requirements = array();
// Ensure translations don't break at install time
$t = function_exists('t') ? 't' : 'st';
// Report Drupal version
if ($phase == 'runtime') {
$requirements['drupal'] = array(
'title' => $t('Drupal'),
'value' => VERSION,
);
}
// Test web server
$requirements['webserver'] = array(
'title' => $t('Web server'),
);
// Use server info string, if present.
if (isset($_SERVER['SERVER_SOFTWARE'])) {
$requirements['webserver']['value'] = $_SERVER['SERVER_SOFTWARE'];
list($server, $version) = split('[ /]', $_SERVER['SERVER_SOFTWARE']);
switch ($server) {
case 'Apache':
if (version_compare($version, DRUPAL_MINIMUM_APACHE) < 0) {
$requirements['webserver']['description'] = $t('Your Apache server is too old. Drupal requires at least Apache %version.', array('%version' => DRUPAL_MINIMUM_APACHE));
$requirements['webserver']['severity'] = REQUIREMENT_ERROR;
}
break;
default:
$requirements['webserver']['description'] = $t('The web server you\'re using has not been tested with Drupal and might not work properly.');
$requirements['webserver']['severity'] = REQUIREMENT_WARNING;
break;
}
}
else {
$requirements['webserver']['value'] = $t('Unknown');
$requirements['webserver']['description'] = $t('Unable to determine your web server type. Drupal might not work properly.');
$requirements['webserver']['severity'] = REQUIREMENT_WARNING;
}
// Test PHP version
$requirements['php'] = array(
'title' => $t('PHP'),
'value' => ($phase == 'runtime') ? l(phpversion(), 'admin/logs/status/php') : phpversion(),
);
if (version_compare(phpversion(), DRUPAL_MINIMUM_PHP) < 0) {
$requirements['php']['description'] = $t('Your PHP installation is too old. Drupal requires at least PHP %version.', array('%version' => DRUPAL_MINIMUM_PHP));
$requirements['php']['severity'] = REQUIREMENT_ERROR;
}
// Test DB version
global $db_type;
if (function_exists('db_status_report')) {
$requirements += db_status_report($phase);
}
// Test settings.php file writability
if ($phase == 'runtime') {
if (!drupal_verify_install_file(conf_path() .'/settings.php', FILE_EXIST|FILE_READABLE|FILE_NOT_WRITABLE)) {
$requirements['settings.php'] = array(
'value' => $t('Not protected'),
'severity' => REQUIREMENT_ERROR,
'description' => $t('The file %file is not protected from modifications and poses a security risk. You must change the file\'s permissions to be non-writable.', array('%file' => conf_path() .'/settings.php')),
);
}
else {
$requirements['settings.php'] = array(
'value' => $t('Protected'),
);
}
$requirements['settings.php']['title'] = $t('Configuration file');
}
// Report cron status
if ($phase == 'runtime') {
$cron_last = variable_get('cron_last', NULL);
if (is_numeric($cron_last)) {
$requirements['cron']['value'] = $t('Last run !time ago', array('!time' => format_interval(time() - $cron_last)));
}
else {
$requirements['cron'] = array(
'description' => $t('Cron has not run. It appears cron jobs have not been setup on your system. Please check the help pages for <a href="@url">configuring cron jobs</a>.', array('@url' => 'http://drupal.org/cron')),
'severity' => REQUIREMENT_ERROR,
'value' => $t('Never run'),
);
}
$requirements['cron']['description'] .= ' '. t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/logs/status/run-cron')));
$requirements['cron']['title'] = $t('Cron maintenance tasks');
}
// Test Unicode library
include_once './includes/unicode.inc';
$requirements = array_merge($requirements, unicode_requirements());
return $requirements;
}
/**
* Implementation of hook_install().
*/
......
......@@ -27,7 +27,7 @@ function system_help($section) {
<li><a href="@cron-status">view</a> whether or not cron is running on your site.</li>
<li>run cron <a href="@cron-manually">manually</a>.</li>
</ul>
', array('@file-cron' => 'cron.php', '@external-http-drupal-org-cron' => 'http://drupal.org/cron', '@cron-status' => url('admin/settings/cron-status'), '@cron-manually' => url('admin/settings/cron-status/cron'), '@admin-settings' => url('admin/settings/page-caching')));
', array('@file-cron' => 'cron.php', '@external-http-drupal-org-cron' => 'http://drupal.org/cron', '@cron-status' => url('admin/logs/status'), '@cron-manually' => url('admin/logs/status/run-cron'), '@admin-settings' => url('admin/settings/page-caching')));
$output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@system">System page</a>.', array('@system' => 'http://drupal.org/handbook/modules/system/')) .'</p>';
return $output;
case 'admin':
......@@ -45,6 +45,8 @@ function system_help($section) {
case 'admin/settings/modules':
return t('<p>Modules are plugins for Drupal that extend its core functionality. Here you can select which modules are enabled. Click on the name of the module in the navigation menu for their individual configuration pages. Once a module is enabled, new <a href="@permissions">permissions</a> might be made available. Modules can automatically be temporarily disabled to reduce server load when your site becomes extremely busy by enabling the throttle.module and checking throttle. The auto-throttle functionality must be enabled on the <a href="@throttle">throttle configuration page</a> after having enabled the throttle module.</p>
<p>It is important that <a href="@update-php">update.php</a> is run every time a module is updated to a newer version.</p>', array('@permissions' => url('admin/user/access'), '@throttle' => url('admin/settings/throttle'), '@update-php' => $base_url .'/update.php'));
case 'admin/logs/status':
return t('<p>Here you can find a short overview of your Drupal site\'s parameters as well as any problems detected with your installation. It is useful for example to copy/paste this information when you need support.</p>');
}
}
......@@ -233,28 +235,49 @@ function system_menu($may_cache) {
'callback' => 'drupal_get_form',
'callback arguments' => array('system_date_time_settings'));
$items[] = array(
'path' => 'admin/settings/site-status',
'title' => t('site status'),
'path' => 'admin/settings/site-maintenance',
'title' => t('site maintenance'),
'description' => t('Take the site off-line for maintenance or bring it back online.'),
'callback' => 'drupal_get_form',
'callback arguments' => array('system_site_status_settings'));
$items[] = array(
'path' => 'admin/settings/unicode',