Chamilo is a learning management system focused on ease of use and accessibility
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
chamilo-lms/main/inc/lib/diagnoser.lib.php

868 lines
27 KiB

<?php
/* For licensing terms, see /license.txt */
/**
* Class Diagnoser
* Class that is responsible for generating diagnostic information about the system.
*
* @package chamilo.diagnoser
*
* @author Ivan Tcholakov, 2008, initial proposal and sample code.
* @author spou595, 2009, implementation for Chamilo 2.x
* @author Julio Montoya <gugli100@gmail.com>, 2010, port to chamilo 1.8.7, Some fixes
*/
class Diagnoser
{
const STATUS_OK = 1;
const STATUS_WARNING = 2;
const STATUS_ERROR = 3;
const STATUS_INFORMATION = 4;
/**
* Contructor.
*/
public function __construct()
{
}
/**
* Show html table.
*/
public function show_html()
{
$sections = [
'chamilo' => [
'lang' => 'Chamilo',
'info' => 'State of Chamilo requirements',
],
'php' => [
'lang' => 'PHP',
'info' => 'State of PHP settings on the server',
],
'database' => [
'lang' => 'Database',
'info' => 'Configuration settings of the database server. To check the database consistency after an upgrade, if you have access to the command line, you can use "php bin/doctrine.php orm:schema-tool:update --dump-sql". This will print a list of database changes that should be applied to your system in order to get the right structure. Index name changes can be ignored. Use "--force" instead of "--dump" to try and execute them in order.',
],
'webserver' => [
'lang' => get_lang('WebServer'),
'info' => 'Information about your webserver\'s configuration ',
],
'paths' => [
'lang' => 'Paths',
'info' => 'The following paths are called by their constant throughout Chamilo\'s code using the api_get_path() function. Here is a list of these paths and what they would be translated to on this portal.',
],
];
$currentSection = isset($_GET['section']) ? $_GET['section'] : '';
if (!in_array(trim($currentSection), array_keys($sections))) {
$currentSection = 'chamilo';
}
$html = '<div class="tabbable"><ul class="nav nav-tabs">';
foreach ($sections as $section => $details) {
if ($currentSection === $section) {
$html .= '<li class="active">';
} else {
$html .= '<li>';
}
$params['section'] = $section;
$html .= '<a href="system_status.php?section='.$section.'">'.$details['lang'].'</a></li>';
}
$html .= '</ul><div class="tab-pane">';
$data = call_user_func([$this, 'get_'.$currentSection.'_data']);
echo $html;
if ($currentSection != 'paths') {
echo '<br />';
echo Display::return_message($sections[$currentSection]['info'], 'normal');
$table = new SortableTableFromArray($data, 1, 100);
$table->set_header(0, '', false);
$table->set_header(1, get_lang('Section'), false);
$table->set_header(2, get_lang('Setting'), false);
$table->set_header(3, get_lang('Current'), false);
$table->set_header(4, get_lang('Expected'), false);
$table->set_header(5, get_lang('Comment'), false);
$table->display();
} else {
echo '<br />';
echo Display::return_message($sections[$currentSection]['info'], 'normal');
$headers = $data['headers'];
$results = $data['data'];
$table = new HTML_Table(['class' => 'data_table']);
$column = 0;
foreach ($headers as $header) {
$table->setHeaderContents(0, $column, $header);
$column++;
}
$row = 1;
foreach ($results as $index => $rowData) {
$table->setCellContents(
$row,
0,
$rowData
);
$table->setCellContents(
$row,
1,
$index
);
$row++;
}
echo $table->display();
}
echo '</div></div>';
}
/**
* @return array
*/
public function get_paths_data()
{
global $paths;
$list = $paths[api_get_path(WEB_PATH)];
$list['url_append'] = api_get_configuration_value('url_append');
asort($list);
return [
'headers' => ['Path', 'constant'],
'data' => $list,
];
}
/**
* Functions to get the data for the chamilo diagnostics.
*
* @return array of data
*/
public function get_chamilo_data()
{
$array = [];
$writable_folders = [
api_get_path(SYS_APP_PATH).'cache',
api_get_path(SYS_COURSE_PATH),
api_get_path(SYS_APP_PATH).'home',
api_get_path(SYS_APP_PATH).'upload/users/',
api_get_path(SYS_PATH).'main/default_course_document/images/',
];
foreach ($writable_folders as $index => $folder) {
$writable = is_writable($folder);
$status = $writable ? self::STATUS_OK : self::STATUS_ERROR;
$array[] = $this->build_setting(
$status,
'[FILES]',
get_lang('IsWritable').': '.$folder,
'http://be2.php.net/manual/en/function.is-writable.php',
$writable,
1,
'yes_no',
get_lang('DirectoryMustBeWritable')
);
}
$exists = file_exists(api_get_path(SYS_CODE_PATH).'install');
$status = $exists ? self::STATUS_WARNING : self::STATUS_OK;
$array[] = $this->build_setting(
$status,
'[FILES]',
get_lang('DirectoryExists').': /install',
'http://be2.php.net/file_exists',
$exists,
0,
'yes_no',
get_lang('DirectoryShouldBeRemoved')
);
$app_version = api_get_setting('chamilo_database_version');
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[DB]',
'chamilo_database_version',
'#',
$app_version,
0,
null,
'Chamilo DB version'
);
$access_url_id = api_get_current_access_url_id();
if ($access_url_id === 1) {
global $_configuration;
$message2 = '';
if ($access_url_id === 1) {
if (api_is_windows_os()) {
$message2 .= get_lang('SpaceUsedOnSystemCannotBeMeasuredOnWindows');
} else {
$dir = api_get_path(SYS_PATH);
$du = exec('du -sh '.$dir, $err);
list($size, $none) = explode("\t", $du);
$limit = 0;
if (isset($_configuration[$access_url_id])) {
if (isset($_configuration[$access_url_id]['hosting_limit_disk_space'])) {
$limit = $_configuration[$access_url_id]['hosting_limit_disk_space'];
}
}
$message2 .= sprintf(get_lang('TotalSpaceUsedByPortalXLimitIsYMB'), $size, $limit);
}
}
$array[] = $this->build_setting(
self::STATUS_OK,
'[FILES]',
'hosting_limit_disk_space',
'#',
$size,
0,
null,
$message2
);
}
return $array;
}
/**
* Functions to get the data for the php diagnostics.
*
* @return array of data
*/
public function get_php_data()
{
$array = [];
// General Functions
$version = phpversion();
$status = $version > REQUIRED_PHP_VERSION ? self::STATUS_OK : self::STATUS_ERROR;
$array[] = $this->build_setting(
$status,
'[PHP]',
'phpversion()',
'http://www.php.net/manual/en/function.phpversion.php',
phpversion(),
'>= '.REQUIRED_PHP_VERSION,
null,
get_lang('PHPVersionInfo')
);
$setting = ini_get('output_buffering');
$req_setting = 1;
$status = $setting >= $req_setting ? self::STATUS_OK : self::STATUS_ERROR;
$array[] = $this->build_setting(
$status,
'[INI]',
'output_buffering',
'http://www.php.net/manual/en/outcontrol.configuration.php#ini.output-buffering',
$setting,
$req_setting,
'on_off',
get_lang('OutputBufferingInfo')
);
$setting = ini_get('file_uploads');
$req_setting = 1;
$status = $setting == $req_setting ? self::STATUS_OK : self::STATUS_ERROR;
$array[] = $this->build_setting(
$status,
'[INI]',
'file_uploads',
'http://www.php.net/manual/en/ini.core.php#ini.file-uploads',
$setting,
$req_setting,
'on_off',
get_lang('FileUploadsInfo')
);
$setting = ini_get('magic_quotes_runtime');
$req_setting = 0;
$status = $setting == $req_setting ? self::STATUS_OK : self::STATUS_ERROR;
$array[] = $this->build_setting(
$status,
'[INI]',
'magic_quotes_runtime',
'http://www.php.net/manual/en/ini.core.php#ini.magic-quotes-runtime',
$setting,
$req_setting,
'on_off',
get_lang('MagicQuotesRuntimeInfo')
);
$setting = ini_get('safe_mode');
$req_setting = 0;
$status = $setting == $req_setting ? self::STATUS_OK : self::STATUS_WARNING;
$array[] = $this->build_setting(
$status,
'[INI]',
'safe_mode',
'http://www.php.net/manual/en/ini.core.php#ini.safe-mode',
$setting,
$req_setting,
'on_off',
get_lang('SafeModeInfo')
);
$setting = ini_get('register_globals');
$req_setting = 0;
$status = $setting == $req_setting ? self::STATUS_OK : self::STATUS_ERROR;
$array[] = $this->build_setting(
$status,
'[INI]',
'register_globals',
'http://www.php.net/manual/en/ini.core.php#ini.register-globals',
$setting,
$req_setting,
'on_off',
get_lang('RegisterGlobalsInfo')
);
$setting = ini_get('short_open_tag');
$req_setting = 0;
$status = $setting == $req_setting ? self::STATUS_OK : self::STATUS_WARNING;
$array[] = $this->build_setting(
$status,
'[INI]',
'short_open_tag',
'http://www.php.net/manual/en/ini.core.php#ini.short-open-tag',
$setting,
$req_setting,
'on_off',
get_lang('ShortOpenTagInfo')
);
$setting = ini_get('magic_quotes_gpc');
$req_setting = 0;
$status = $setting == $req_setting ? self::STATUS_OK : self::STATUS_ERROR;
$array[] = $this->build_setting(
$status,
'[INI]',
'magic_quotes_gpc',
'http://www.php.net/manual/en/ini.core.php#ini.magic_quotes_gpc',
$setting,
$req_setting,
'on_off',
get_lang('MagicQuotesGpcInfo')
);
$setting = ini_get('display_errors');
$req_setting = 0;
$status = $setting == $req_setting ? self::STATUS_OK : self::STATUS_WARNING;
$array[] = $this->build_setting(
$status,
'[INI]',
'display_errors',
'http://www.php.net/manual/en/ini.core.php#ini.display_errors',
$setting,
$req_setting,
'on_off',
get_lang('DisplayErrorsInfo')
);
$setting = ini_get('default_charset');
if ($setting == '') {
$setting = null;
}
$req_setting = 'UTF-8';
$status = $setting == $req_setting ? self::STATUS_OK : self::STATUS_ERROR;
$array[] = $this->build_setting(
$status,
'[INI]',
'default_charset',
'http://www.php.net/manual/en/ini.core.php#ini.default-charset',
$setting,
$req_setting,
null,
get_lang('DefaultCharsetInfo')
);
$setting = ini_get('max_execution_time');
$req_setting = '300 ('.get_lang('Minimum').')';
$status = $setting >= 300 ? self::STATUS_OK : self::STATUS_WARNING;
$array[] = $this->build_setting(
$status,
'[INI]',
'max_execution_time',
'http://www.php.net/manual/en/ini.core.php#ini.max-execution-time',
$setting,
$req_setting,
null,
get_lang('MaxExecutionTimeInfo')
);
$setting = ini_get('max_input_time');
$req_setting = '300 ('.get_lang('Minimum').')';
$status = $setting >= 300 ? self::STATUS_OK : self::STATUS_WARNING;
$array[] = $this->build_setting(
$status,
'[INI]',
'max_input_time',
'http://www.php.net/manual/en/ini.core.php#ini.max-input-time',
$setting,
$req_setting,
null,
get_lang('MaxInputTimeInfo')
);
$setting = ini_get('memory_limit');
$req_setting = '>= '.REQUIRED_MIN_MEMORY_LIMIT.'M';
$status = self::STATUS_ERROR;
if ((float) $setting >= REQUIRED_MIN_MEMORY_LIMIT) {
$status = self::STATUS_OK;
}
$array[] = $this->build_setting(
$status,
'[INI]',
'memory_limit',
'http://www.php.net/manual/en/ini.core.php#ini.memory-limit',
$setting,
$req_setting,
null,
get_lang('MemoryLimitInfo')
);
$setting = ini_get('post_max_size');
$req_setting = '>= '.REQUIRED_MIN_POST_MAX_SIZE.'M';
$status = self::STATUS_ERROR;
if ((float) $setting >= REQUIRED_MIN_POST_MAX_SIZE) {
$status = self::STATUS_OK;
}
$array[] = $this->build_setting(
$status,
'[INI]',
'post_max_size',
'http://www.php.net/manual/en/ini.core.php#ini.post-max-size',
$setting,
$req_setting,
null,
get_lang('PostMaxSizeInfo')
);
$setting = ini_get('upload_max_filesize');
$req_setting = '>= '.REQUIRED_MIN_UPLOAD_MAX_FILESIZE.'M';
$status = self::STATUS_ERROR;
if ((float) $setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE) {
$status = self::STATUS_OK;
}
$array[] = $this->build_setting(
$status,
'[INI]',
'upload_max_filesize',
'http://www.php.net/manual/en/ini.core.php#ini.upload_max_filesize',
$setting,
$req_setting,
null,
get_lang('UploadMaxFilesizeInfo')
);
$setting = ini_get('upload_tmp_dir');
$status = self::STATUS_OK;
$array[] = $this->build_setting(
$status,
'[INI]',
'upload_tmp_dir',
'http://www.php.net/manual/en/ini.core.php#ini.upload_tmp_dir',
$setting,
'',
null,
get_lang('UploadTmpDirInfo')
);
$setting = ini_get('variables_order');
$req_setting = 'GPCS';
$status = $setting == $req_setting ? self::STATUS_OK : self::STATUS_ERROR;
$array[] = $this->build_setting(
$status,
'[INI]',
'variables_order',
'http://www.php.net/manual/en/ini.core.php#ini.variables-order',
$setting,
$req_setting,
null,
get_lang('VariablesOrderInfo')
);
$setting = ini_get('session.gc_maxlifetime');
$req_setting = '4320';
$status = $setting == $req_setting ? self::STATUS_OK : self::STATUS_WARNING;
$array[] = $this->build_setting(
$status,
'[SESSION]',
'session.gc_maxlifetime',
'http://www.php.net/manual/en/ini.core.php#session.gc-maxlifetime',
$setting,
$req_setting,
null,
get_lang('SessionGCMaxLifetimeInfo')
);
if (api_check_browscap()) {
$setting = true;
} else {
$setting = false;
}
$req_setting = true;
$status = $setting == $req_setting ? self::STATUS_OK : self::STATUS_WARNING;
$array[] = $this->build_setting(
$status,
'[INI]',
'browscap',
'http://www.php.net/manual/en/misc.configuration.php#ini.browscap',
$setting,
$req_setting,
'on_off',
get_lang('BrowscapInfo')
);
// Extensions
$extensions = [
'gd' => [
'link' => 'http://www.php.net/gd',
'expected' => 1,
'comment' => get_lang('ExtensionMustBeLoaded'),
],
'pdo_mysql' => [
'link' => 'http://php.net/manual/en/ref.pdo-mysql.php',
'expected' => 1,
'comment' => get_lang('ExtensionMustBeLoaded'),
],
'pcre' => [
'link' => 'http://www.php.net/pcre',
'expected' => 1,
'comment' => get_lang('ExtensionMustBeLoaded'),
],
'session' => [
'link' => 'http://www.php.net/session',
'expected' => 1,
'comment' => get_lang('ExtensionMustBeLoaded'),
],
'standard' => [
'link' => 'http://www.php.net/spl',
'expected' => 1,
'comment' => get_lang('ExtensionMustBeLoaded'),
],
'zlib' => [
'link' => 'http://www.php.net/zlib',
'expected' => 1,
'comment' => get_lang('ExtensionMustBeLoaded'),
],
'xsl' => [
'link' => 'http://be2.php.net/xsl',
'expected' => 2,
'comment' => get_lang('ExtensionShouldBeLoaded'),
],
'curl' => [
'link' => 'http://www.php.net/curl',
'expected' => 2,
'comment' => get_lang('ExtensionShouldBeLoaded'),
],
'Zend OPcache' => [
'link' => 'http://www.php.net/opcache',
'expected' => 2,
'comment' => get_lang('ExtensionShouldBeLoaded'),
],
'apcu' => [
'link' => 'http://www.php.net/apcu',
'expected' => 2,
'comment' => get_lang('ExtensionShouldBeLoaded'),
],
];
foreach ($extensions as $extension => $data) {
$url = $data['link'];
$expected_value = $data['expected'];
$comment = $data['comment'];
$loaded = extension_loaded($extension);
$status = $loaded ? self::STATUS_OK : self::STATUS_ERROR;
$array[] = $this->build_setting(
$status,
'[EXTENSION]',
get_lang('LoadedExtension').': '.$extension,
$url,
$loaded,
$expected_value,
'yes_no_optional',
$comment
);
}
return $array;
}
/**
* Functions to get the data for the mysql diagnostics.
*
* @return array of data
*/
public function get_database_data()
{
$array = [];
$em = Database::getManager();
$connection = $em->getConnection();
$host = $connection->getHost();
$db = $connection->getDatabase();
$port = $connection->getPort();
$driver = $connection->getDriver()->getName();
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[Database]',
'driver',
'',
$driver,
null,
null,
get_lang('Driver')
);
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[Database]',
'host',
'',
$host,
null,
null,
get_lang('MysqlHostInfo')
);
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[Database]',
'port',
'',
$port,
null,
null,
get_lang('Port')
);
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[Database]',
'Database name',
'',
$db,
null,
null,
get_lang('Name')
);
return $array;
}
/**
* Functions to get the data for the webserver diagnostics.
*
* @return array of data
*/
public function get_webserver_data()
{
$array = [];
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[SERVER]',
'$_SERVER["SERVER_NAME"]',
'http://be.php.net/reserved.variables.server',
$_SERVER["SERVER_NAME"],
null,
null,
get_lang('ServerNameInfo')
);
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[SERVER]',
'$_SERVER["SERVER_ADDR"]',
'http://be.php.net/reserved.variables.server',
$_SERVER["SERVER_ADDR"],
null,
null,
get_lang('ServerAddessInfo')
);
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[SERVER]',
'$_SERVER["SERVER_PORT"]',
'http://be.php.net/reserved.variables.server',
$_SERVER["SERVER_PORT"],
null,
null,
get_lang('ServerPortInfo')
);
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[SERVER]',
'$_SERVER["SERVER_SOFTWARE"]',
'http://be.php.net/reserved.variables.server',
$_SERVER["SERVER_SOFTWARE"],
null,
null,
get_lang('ServerSoftwareInfo')
);
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[SERVER]',
'$_SERVER["REMOTE_ADDR"]',
'http://be.php.net/reserved.variables.server',
$_SERVER["REMOTE_ADDR"],
null,
null,
get_lang('ServerRemoteInfo')
);
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[SERVER]',
'$_SERVER["HTTP_USER_AGENT"]',
'http://be.php.net/reserved.variables.server',
$_SERVER["HTTP_USER_AGENT"],
null,
null,
get_lang('ServerUserAgentInfo')
);
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[SERVER]',
'$_SERVER["SERVER_PROTOCOL"]',
'http://be.php.net/reserved.variables.server',
$_SERVER["SERVER_PROTOCOL"],
null,
null,
get_lang('ServerProtocolInfo')
);
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[SERVER]',
'php_uname()',
'http://be2.php.net/php_uname',
php_uname(),
null,
null,
get_lang('UnameInfo')
);
$array[] = $this->build_setting(
self::STATUS_INFORMATION,
'[SERVER]',
'$_SERVER["HTTP_X_FORWARDED_FOR"]',
'http://be.php.net/reserved.variables.server',
(!empty($_SERVER["HTTP_X_FORWARDED_FOR"]) ? $_SERVER["HTTP_X_FORWARDED_FOR"] : ''),
null,
null,
get_lang('ServerXForwardedForInfo')
);
return $array;
}
/**
* Additional functions needed for fast integration.
*/
public function build_setting(
$status,
$section,
$title,
$url,
$current_value,
$expected_value,
$formatter,
$comment
) {
switch ($status) {
case self::STATUS_OK:
$img = 'bullet_green.png';
break;
case self::STATUS_WARNING:
$img = 'bullet_orange.png';
break;
case self::STATUS_ERROR:
$img = 'bullet_red.png';
break;
case self::STATUS_INFORMATION:
$img = 'bullet_blue.png';
break;
}
$image = Display::return_icon($img, $status);
$url = $this->get_link($title, $url);
$formatted_current_value = $current_value;
$formatted_expected_value = $expected_value;
if ($formatter) {
if (method_exists($this, 'format_'.$formatter)) {
$formatted_current_value = call_user_func([$this, 'format_'.$formatter], $current_value);
$formatted_expected_value = call_user_func([$this, 'format_'.$formatter], $expected_value);
}
}
return [$image, $section, $url, $formatted_current_value, $formatted_expected_value, $comment];
}
/**
* Create a link with a url and a title.
*
* @param $title
* @param $url
*
* @return string the url
*/
public function get_link($title, $url)
{
return '<a href="'.$url.'" target="about:bank">'.$title.'</a>';
}
/**
* @param int $value
*
* @return string
*/
public function format_yes_no_optional($value)
{
$return = '';
switch ($value) {
case 0:
$return = get_lang('No');
break;
case 1:
$return = get_lang('Yes');
break;
case 2:
$return = get_lang('Optional');
break;
}
return $return;
}
/**
* @param $value
*
* @return string
*/
public function format_yes_no($value)
{
return $value ? get_lang('Yes') : get_lang('No');
}
/**
* @param int $value
*
* @return string
*/
public function format_on_off($value)
{
$value = intval($value);
if ($value > 1) {
// Greater than 1 values are shown "as-is", they may be interpreted as "On" later.
return $value;
}
// These are the values 'On' and 'Off' used in the php-ini file. Translation (get_lang()) is not needed here.
return $value ? 'On' : 'Off';
}
}