diagnoser.lib.php 16 KB

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