diagnoser.lib.php 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. /**
  4. *
  5. * * Class that is responsible for generating diagnostic information about the system
  6. *
  7. *
  8. * @package chamilo.diagnoser
  9. * @author Ivan Tcholakov, 2008, initiall proposal and sample code.
  10. * @author spou595, 2009, implementation for Chamilo 2.x
  11. * @author Julio Montoya <gugli100@gmail.com>, 2010, port to chamilo 1.8.7, Some fixes
  12. *
  13. */
  14. /**
  15. * Diagnoser class
  16. * @package chamilo.diagnoser
  17. */
  18. class Diagnoser
  19. {
  20. /**
  21. * The status's
  22. */
  23. const STATUS_OK = 1;
  24. const STATUS_WARNING = 2;
  25. const STATUS_ERROR = 3;
  26. const STATUS_INFORMATION = 4;
  27. function __construct() {
  28. }
  29. function show_html() {
  30. $sections = array('chamilo', 'php', 'mysql', 'webserver');
  31. if (!in_array($_GET['section'], $sections)) {
  32. $current_section = 'chamilo';
  33. } else {
  34. $current_section = $_GET['section'];
  35. }
  36. $html = '<div class="tabbable"><ul class="nav nav-tabs">';
  37. foreach ($sections as $section) {
  38. if ($current_section == $section) {
  39. $html .= '<li class="active">';
  40. } else {
  41. $html .= '<li>';
  42. }
  43. $params['section'] = $section;
  44. $html .='<a href="system_status.php?section='.$section.'">'.get_lang($section).'</a></li>';
  45. }
  46. $html .= '</ul><div class="tab-pane">';
  47. $data = call_user_func(array($this, 'get_' . $current_section . '_data'));
  48. echo $html;
  49. $table = new SortableTableFromArray($data, 1, 100);
  50. $table->set_header(0,'', false);
  51. $table->set_header(1,get_lang('Section'), false);
  52. $table->set_header(2,get_lang('Setting'), false);
  53. $table->set_header(3,get_lang('Current'), false);
  54. $table->set_header(4,get_lang('Expected'), false);
  55. $table->set_header(5,get_lang('Comment'), false);
  56. $table->display();
  57. echo '</div></div>';
  58. }
  59. /**
  60. * Functions to get the data for the chamilo diagnostics
  61. * @return array of data
  62. */
  63. function get_chamilo_data() {
  64. $array = array();
  65. $writable_folders = array('archive', 'courses', 'home', 'main/upload/users/', 'main/default_course_document/images/');
  66. foreach ($writable_folders as $index => $folder) {
  67. $writable = is_writable(api_get_path(SYS_PATH) . $folder);
  68. $status = $writable ? self :: STATUS_OK : self :: STATUS_ERROR;
  69. $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'));
  70. }
  71. $exists = file_exists(api_get_path(SYS_CODE_PATH).'install');
  72. $status = $exists ? self :: STATUS_WARNING : self :: STATUS_OK;
  73. $array[] = $this->build_setting($status, '[FILES]', get_lang('DirectoryExists') . ': /install', 'http://be2.php.net/file_exists', $exists, 0, 'yes_no', get_lang('DirectoryShouldBeRemoved'));
  74. return $array;
  75. }
  76. /**
  77. * Functions to get the data for the php diagnostics
  78. * @return array of data
  79. */
  80. function get_php_data() {
  81. $array = array();
  82. // General Functions
  83. $version = phpversion();
  84. $status = $version > REQUIRED_PHP_VERSION ? self :: STATUS_OK : self :: STATUS_ERROR;
  85. $array[] = $this->build_setting($status, '[PHP]', 'phpversion()', 'http://www.php.net/manual/en/function.phpversion.php', phpversion(), '>= '.REQUIRED_PHP_VERSION, null, get_lang('PHPVersionInfo'));
  86. $setting = ini_get('output_buffering');
  87. $req_setting = 1;
  88. $status = $setting >= $req_setting ? self :: STATUS_OK : self :: STATUS_ERROR;
  89. $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'));
  90. $setting = ini_get('file_uploads');
  91. $req_setting = 1;
  92. $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_ERROR;
  93. $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'));
  94. $setting = ini_get('magic_quotes_runtime');
  95. $req_setting = 0;
  96. $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_ERROR;
  97. $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'));
  98. $setting = ini_get('safe_mode');
  99. $req_setting = 0;
  100. $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
  101. $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'));
  102. $setting = ini_get('register_globals');
  103. $req_setting = 0;
  104. $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_ERROR;
  105. $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'));
  106. $setting = ini_get('short_open_tag');
  107. $req_setting = 0;
  108. $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
  109. $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'));
  110. $setting = ini_get('magic_quotes_gpc');
  111. $req_setting = 0;
  112. $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_ERROR;
  113. $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'));
  114. $setting = ini_get('display_errors');
  115. $req_setting = 0;
  116. $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
  117. $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'));
  118. $setting = ini_get('default_charset');
  119. if ($setting == '')
  120. $setting = null;
  121. $req_setting = null;
  122. $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_ERROR;
  123. $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'));
  124. $setting = ini_get('max_execution_time');
  125. $req_setting = '300 (' . get_lang('minimum') . ')';
  126. $status = $setting >= 300 ? self :: STATUS_OK : self :: STATUS_WARNING;
  127. $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'));
  128. $setting = ini_get('max_input_time');
  129. $req_setting = '300 (' . get_lang('minimum') . ')';
  130. $status = $setting >= 300 ? self :: STATUS_OK : self :: STATUS_WARNING;
  131. $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'));
  132. $setting = ini_get('memory_limit');
  133. $req_setting = '>= '.REQUIRED_MIN_MEMORY_LIMIT.'M';
  134. $status = self :: STATUS_ERROR;
  135. if ((float)$setting >= REQUIRED_MIN_MEMORY_LIMIT)
  136. $status = self :: STATUS_OK;
  137. $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'));
  138. $setting = ini_get('post_max_size');
  139. $req_setting = '>= '.REQUIRED_MIN_POST_MAX_SIZE.'M';
  140. $status = self :: STATUS_ERROR;
  141. if ((float)$setting >= REQUIRED_MIN_POST_MAX_SIZE)
  142. $status = self :: STATUS_OK;
  143. $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'));
  144. $setting = ini_get('upload_max_filesize');
  145. $req_setting = '>= '.REQUIRED_MIN_UPLOAD_MAX_FILESIZE.'M';
  146. $status = self :: STATUS_ERROR;
  147. if ((float)$setting >= REQUIRED_UPLOAD_MAX_FILESIZE)
  148. $status = self :: STATUS_OK;
  149. $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'));
  150. $setting = ini_get('variables_order');
  151. $req_setting = 'GPCS';
  152. $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_ERROR;
  153. $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'));
  154. $setting = ini_get('session.gc_maxlifetime');
  155. $req_setting = '4320';
  156. $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
  157. $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'));
  158. if (api_check_browscap()){$setting = true;}else{$setting=false;}
  159. $req_setting = true;
  160. $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
  161. $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'));
  162. //Extensions
  163. $extensions = array('gd' => array('link'=>'http://www.php.net/gd', 'expected' => 1, 'comment' => get_lang('ExtensionMustBeLoaded')),
  164. 'mysql' => array('link'=>'http://www.php.net/mysql', 'expected' => 1, 'comment' => get_lang('ExtensionMustBeLoaded')),
  165. 'pcre' => array('link'=>'http://www.php.net/pcre', 'expected' => 1, 'comment' => get_lang('ExtensionMustBeLoaded')),
  166. 'session' => array('link'=>'http://www.php.net/session', 'expected' => 1, 'comment' => get_lang('ExtensionMustBeLoaded')),
  167. 'standard' => array('link'=>'http://www.php.net/spl', 'expected' => 1, 'comment' => get_lang('ExtensionMustBeLoaded')),
  168. 'zlib' => array('link'=>'http://www.php.net/zlib', 'expected' => 1, 'comment' => get_lang('ExtensionMustBeLoaded')),
  169. 'xsl' => array('link'=>'http://be2.php.net/xsl', 'expected' => 2, 'comment' => get_lang('ExtensionShouldBeLoaded')),
  170. 'curl' => array('link'=>'http://www.php.net/curl', 'expected' => 2, 'comment' => get_lang('ExtensionShouldBeLoaded')),
  171. );
  172. foreach ($extensions as $extension => $data) {
  173. $url = $data['link'];
  174. $expected_value = $data['expected'];
  175. $comment = $data['comment'];
  176. $loaded = extension_loaded($extension);
  177. $status = $loaded ? self :: STATUS_OK : self :: STATUS_ERROR;
  178. $array[] = $this->build_setting($status, '[EXTENSION]', get_lang('LoadedExtension') . ': ' . $extension, $url, $loaded, $expected_value, 'yes_no_optional', $comment);
  179. }
  180. return $array;
  181. }
  182. /**
  183. * Functions to get the data for the mysql diagnostics
  184. * @return array of data
  185. */
  186. function get_mysql_data() {
  187. $array = array();
  188. // A note: Maybe it would be better if all "MySQL"-like variable names and words on the page to be replaced with "Database"-like ones.
  189. $array[] = $this->build_setting(self :: STATUS_INFORMATION, '[MySQL]', 'mysql_get_host_info()', 'http://www.php.net/manual/en/function.mysql-get-host-info.php', Database::get_host_info(), null, null, get_lang('MysqlHostInfo'));
  190. $array[] = $this->build_setting(self :: STATUS_INFORMATION, '[MySQL]', 'mysql_get_server_info()', 'http://www.php.net/manual/en/function.mysql-get-server-info.php', Database::get_server_info(), null, null, get_lang('MysqlServerInfo'));
  191. $array[] = $this->build_setting(self :: STATUS_INFORMATION, '[MySQL]', 'mysql_get_proto_info()', 'http://www.php.net/manual/en/function.mysql-get-proto-info.php', Database::get_proto_info(), null, null, get_lang('MysqlProtoInfo'));
  192. $array[] = $this->build_setting(self :: STATUS_INFORMATION, '[MySQL]', 'mysql_get_client_info()', 'http://www.php.net/manual/en/function.mysql-get-client-info.php', Database::get_client_info(), null, null, get_lang('MysqlClientInfo'));
  193. return $array;
  194. }
  195. /**
  196. * Functions to get the data for the webserver diagnostics
  197. * @return array of data
  198. */
  199. function get_webserver_data() {
  200. $array = array();
  201. $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'));
  202. $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'));
  203. $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'));
  204. $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'));
  205. $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'));
  206. $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'));
  207. /*$path = $this->manager->get_url(array('section' => Request :: get('section')));
  208. $request = $_SERVER["REQUEST_URI"];
  209. $status = $request != $path ? self :: STATUS_ERROR : self :: STATUS_OK;
  210. $array[] = $this->build_setting($status, '[SERVER]', '$_SERVER["REQUEST_URI"]', 'http://be.php.net/reserved.variables.server', $request, $path, null, get_lang('RequestURIInfo'));
  211. */
  212. $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'));
  213. $array[] = $this->build_setting(self :: STATUS_INFORMATION, '[SERVER]', 'php_uname()', 'http://be2.php.net/php_uname', php_uname(), null, null, get_lang('UnameInfo'));
  214. return $array;
  215. }
  216. /**
  217. * Additional functions needed for fast integration
  218. */
  219. function build_setting($status, $section, $title, $url, $current_value, $expected_value, $formatter, $comment, $img_path = null) {
  220. switch ($status) {
  221. case self :: STATUS_OK :
  222. $img = 'bullet_green.gif';
  223. break;
  224. case self :: STATUS_WARNING :
  225. $img = 'bullet_orange.gif';
  226. break;
  227. case self :: STATUS_ERROR :
  228. $img = 'bullet_red.gif';
  229. break;
  230. case self :: STATUS_INFORMATION :
  231. $img = 'bullet_blue.gif';
  232. break;
  233. }
  234. if (! $img_path) {
  235. $img_path = api_get_path(WEB_IMG_PATH);
  236. }
  237. $image = '<img src="' . $img_path . $img . '" alt="' . $status . '" />';
  238. $url = $this->get_link($title, $url);
  239. $formatted_current_value = $current_value;
  240. $formatted_expected_value = $expected_value;
  241. if ($formatter) {
  242. if (method_exists($this, 'format_' . $formatter)) {
  243. $formatted_current_value = call_user_func(array($this, 'format_' . $formatter), $current_value);
  244. $formatted_expected_value = call_user_func(array($this, 'format_' . $formatter), $expected_value);
  245. }
  246. }
  247. return array($image, $section, $url, $formatted_current_value, $formatted_expected_value, $comment);
  248. }
  249. /**
  250. * Create a link with a url and a title
  251. * @param $title
  252. * @param $url
  253. * @return string the url
  254. */
  255. function get_link($title, $url) {
  256. return '<a href="' . $url . '" target="about:bank">' . $title . '</a>';
  257. }
  258. function format_yes_no_optional($value) {
  259. $return = '';
  260. switch($value) {
  261. case 0:
  262. $return = get_lang('No');
  263. break;
  264. case 1:
  265. $return = get_lang('Yes');
  266. break;
  267. case 2:
  268. $return = get_lang('Optional');
  269. break;
  270. }
  271. return $return;
  272. }
  273. function format_yes_no($value) {
  274. return $value ? get_lang('Yes') : get_lang('No');
  275. }
  276. function format_on_off($value) {
  277. $value = intval($value);
  278. if ($value > 1) {
  279. // Greater than 1 values are shown "as-is", they may be interpreted as "On" later.
  280. return $value;
  281. }
  282. // These are the values 'On' and 'Off' used in the php-ini file. Translation (get_lang()) is not needed here.
  283. return $value ? 'On' : 'Off';
  284. }
  285. }