Adding a "short_open_tag" configuration test.
[squirrelmail.git] / src / configtest.php
1 <?php
2
3 /**
4 * SquirrelMail configtest script
5 *
6 * @copyright &copy; 2003-2007 The SquirrelMail Project Team
7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
8 * @version $Id$
9 * @package squirrelmail
10 * @subpackage config
11 */
12
13 /************************************************************
14 * NOTE: you do not need to change this script! *
15 * If it throws errors you need to adjust your config. *
16 ************************************************************/
17
18 /** This is the configtest page */
19 define('PAGE_NAME', 'configtest');
20
21 // This script could really use some restructuring as it has grown quite rapidly
22 // but is not very 'clean'. Feel free to get some structure into this thing.
23
24 /** force verbose error reporting and turn on display of errors */
25 error_reporting(E_ALL);
26 ini_set('display_errors',1);
27
28 /** Blockcopy from init.php. Cleans globals. */
29 if ((bool) ini_get('register_globals') &&
30 strtolower(ini_get('register_globals'))!='off') {
31 /**
32 * Remove all globals that are not reserved by PHP
33 * 'value' and 'key' are used by foreach. Don't unset them inside foreach.
34 */
35 foreach ($GLOBALS as $key => $value) {
36 switch($key) {
37 case 'HTTP_POST_VARS':
38 case '_POST':
39 case 'HTTP_GET_VARS':
40 case '_GET':
41 case 'HTTP_COOKIE_VARS':
42 case '_COOKIE':
43 case 'HTTP_SERVER_VARS':
44 case '_SERVER':
45 case 'HTTP_ENV_VARS':
46 case '_ENV':
47 case 'HTTP_POST_FILES':
48 case '_FILES':
49 case '_REQUEST':
50 case 'HTTP_SESSION_VARS':
51 case '_SESSION':
52 case 'GLOBALS':
53 case 'key':
54 case 'value':
55 break;
56 default:
57 unset($GLOBALS[$key]);
58 }
59 }
60 // Unset variables used in foreach
61 unset($GLOBALS['key']);
62 unset($GLOBALS['value']);
63 }
64
65
66 /**
67 * Displays error messages and warnings
68 * @param string $str message
69 * @param boolean $fatal fatal error or only warning
70 */
71 function do_err($str, $fatal = TRUE) {
72 global $IND, $warnings;
73 $level = $fatal ? 'FATAL ERROR:' : 'WARNING:';
74 echo '<p>'.$IND.'<font color="red"><b>' . $level . '</b></font> ' .$str. "</p>\n";
75 if($fatal) {
76 echo '</body></html>';
77 exit;
78 } else {
79 $warnings++;
80 }
81 }
82
83 ob_implicit_flush();
84 /** @ignore */
85 define('SM_PATH', '../');
86 /** load minimal function set */
87 require(SM_PATH . 'include/constants.php');
88 require(SM_PATH . 'functions/global.php');
89 require(SM_PATH . 'functions/strings.php');
90 $SQM_INTERNAL_VERSION = explode('.', SM_VERSION, 3);
91 $SQM_INTERNAL_VERSION[2] = intval($SQM_INTERNAL_VERSION[2]);
92
93 /** set default value in order to block remote access */
94 $allow_remote_configtest=false;
95
96 /** Load all configuration files before output begins */
97
98 /* load default configuration */
99 require(SM_PATH . 'config/config_default.php');
100 /* reset arrays in default configuration */
101 $ldap_server = array();
102 $plugins = array();
103 $fontsets = array();
104 $theme = array();
105 $theme[0]['PATH'] = SM_PATH . 'themes/default_theme.php';
106 $theme[0]['NAME'] = 'Default';
107 $aTemplateSet = array();
108 $aTemplateSet[0]['ID'] = 'default';
109 $aTemplateSet[0]['NAME'] = 'Default';
110 /* load site configuration */
111 if (file_exists(SM_PATH . 'config/config.php')) {
112 require(SM_PATH . 'config/config.php');
113 }
114 /* load local configuration overrides */
115 if (file_exists(SM_PATH . 'config/config_local.php')) {
116 require(SM_PATH . 'config/config_local.php');
117 }
118
119 /** Load plugins */
120 global $disable_plugins;
121 $squirrelmail_plugin_hooks = array();
122 if (!$disable_plugins && file_exists(SM_PATH . 'config/plugin_hooks.php')) {
123 require(SM_PATH . 'config/plugin_hooks.php');
124 }
125
126 /** Warning counter */
127 $warnings = 0;
128
129 /** indent */
130 $IND = str_repeat('&nbsp;',4);
131
132 /**
133 * get_location starts session and must be run before output is started.
134 */
135 $test_location = get_location();
136
137 ?><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
138 "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
139 <html>
140 <head>
141 <meta name="robots" content="noindex,nofollow">
142 <title>SquirrelMail configtest</title>
143 </head>
144 <body>
145 <h1>SquirrelMail configtest</h1>
146
147 <p>This script will try to check some aspects of your SquirrelMail configuration
148 and point you to errors whereever it can find them. You need to go run <tt>conf.pl</tt>
149 in the <tt>config/</tt> directory first before you run this script.</p>
150
151 <?php
152
153 $included = array_map('basename', get_included_files() );
154 if(!in_array('config.php', $included)) {
155 if(!file_exists(SM_PATH . 'config/config.php')) {
156 do_err('Config file '.SM_PATH . 'config/config.php does not exist!<br />'.
157 'You need to run <tt>conf.pl</tt> first.');
158 }
159 do_err('Could not read '.SM_PATH.'config/config.php! Check file permissions.');
160 }
161 if(!in_array('strings.php', $included)) {
162 do_err('Could not include '.SM_PATH.'functions/strings.php!<br />'.
163 'Check permissions on that file.');
164 }
165
166 /* Block remote use of script */
167 if (! $allow_remote_configtest) {
168 sqGetGlobalVar('REMOTE_ADDR',$client_ip,SQ_SERVER);
169 sqGetGlobalVar('SERVER_ADDR',$server_ip,SQ_SERVER);
170
171 if ((! isset($client_ip) || $client_ip!='127.0.0.1') &&
172 (! isset($client_ip) || ! isset($server_ip) || $client_ip!=$server_ip)) {
173 do_err('Enable "Allow remote configtest" option in squirrelmail configuration in order to use this script.');
174 }
175 }
176
177 echo "<p><table>\n<tr><td>SquirrelMail version:</td><td><b>" . SM_VERSION . "</b></td></tr>\n" .
178 '<tr><td>Config file version:</td><td><b>' . $config_version . "</b></td></tr>\n" .
179 '<tr><td>Config file last modified:</td><td><b>' .
180 date ('d F Y H:i:s', filemtime(SM_PATH . 'config/config.php')) .
181 "</b></td></tr>\n</table>\n</p>\n\n";
182
183 /* check $config_version */
184 if ($config_version!='1.5.0') {
185 do_err('Configuration file version does not match required version. Please update your configuration file.');
186 }
187
188
189 /* checking PHP specs */
190
191 echo "Checking PHP configuration...<br />\n";
192
193 if(!check_php_version(4,1,0)) {
194 do_err('Insufficient PHP version: '. PHP_VERSION . '! Minimum required: 4.1.0');
195 }
196
197 echo $IND . 'PHP version ' . PHP_VERSION . ' OK. (You have: ' . phpversion() . ". Minimum: 4.1.0)<br />\n";
198
199 echo $IND . 'display_errors: ' . ini_get('display_errors') . "<br />\n";
200
201 echo $IND . 'error_reporting: ' . ini_get('error_reporting') . "<br />\n";
202
203 $safe_mode = ini_get('safe_mode');
204 if ($safe_mode) {
205 echo $IND . 'safe_mode: ' . $safe_mode;
206 if (empty($prefs_dsn) || empty($addrbook_dsn))
207 echo ' (<font color="red">double check data and attachment directory ownership, etc!</font>)';
208 if (!empty($addrbook_dsn) || !empty($prefs_dsn) || !empty($addrbook_global_dsn))
209 echo ' (<font color="red">does PHP have access to database interface?</font>)';
210 echo "<br />\n";
211 $safe_mode_exec_dir = ini_get('safe_mode_exec_dir');
212 echo $IND . 'safe_mode_exec_dir: ' . $safe_mode_exec_dir . "<br />\n";
213 }
214
215 /* register_globals check: test for boolean false and any string that is not equal to 'off' */
216
217 if ((bool) ini_get('register_globals') &&
218 strtolower(ini_get('register_globals'))!='off') {
219 do_err('You have register_globals turned on. This is not an error, but it CAN be a security hazard. Consider turning register_globals off.', false);
220 }
221
222
223 /* variables_order check */
224
225 // FIXME(?): Hmm, how do we distinguish between when an ini setting is
226 // not available (ini_set() returns empty string) and when
227 // the administrator set the value to an empty string? The
228 // latter is sure to be highly rare, so for now, just assume
229 // that empty value means the setting isn't even available
230 // (could also check PHP version when this setting was implemented)
231 // although, we'll also warn the user if it is empty, with
232 // a non-fatal error
233 $variables_order = strtoupper(ini_get('variables_order'));
234 if (empty($variables_order))
235 do_err('Your variables_order setting seems to be empty. Make sure it is undefined in any PHP ini files, .htaccess files, etc. and not specifically set to an empty value or SquirrelMail may not function correctly', false);
236 else if (strpos($variables_order, 'G') === FALSE
237 || strpos($variables_order, 'P') === FALSE
238 || strpos($variables_order, 'C') === FALSE
239 || strpos($variables_order, 'S') === FALSE) {
240 do_err('Your variables_order setting is insufficient for SquirrelMail to function. It needs at least "GPCS", but you have it set to "' . htmlspecialchars($variables_order) . '"', true);
241 } else {
242 echo $IND . "variables_order OK: $variables_order.<br />\n";
243 }
244
245
246 /* gpc_order check (removed from PHP as of v5.0) */
247
248 if (!check_php_version(5)) {
249 // FIXME(?): Hmm, how do we distinguish between when an ini setting is
250 // not available (ini_set() returns empty string) and when
251 // the administrator set the value to an empty string? The
252 // latter is sure to be highly rare, so for now, just assume
253 // that empty value means the setting isn't even available
254 // (could also check PHP version when this setting was implemented)
255 // although, we'll also warn the user if it is empty, with
256 // a non-fatal error
257 $gpc_order = strtoupper(ini_get('gpc_order'));
258 if (empty($gpc_order))
259 do_err('Your gpc_order setting seems to be empty. Make sure it is undefined in any PHP ini files, .htaccess files, etc. and not specifically set to an empty value or SquirrelMail may not function correctly', false);
260 else if (strpos($gpc_order, 'G') === FALSE
261 || strpos($gpc_order, 'P') === FALSE
262 || strpos($gpc_order, 'C') === FALSE) {
263 do_err('Your gpc_order setting is insufficient for SquirrelMail to function. It needs to be set to "GPC", but you have it set to "' . htmlspecialchars($gpc_order) . '"', true);
264 } else {
265 echo $IND . "gpc_order OK: $gpc_order.<br />\n";
266 }
267 }
268
269
270 /* check PHP extensions */
271
272 $php_exts = array('session','pcre');
273 $diff = array_diff($php_exts, get_loaded_extensions());
274 if(count($diff)) {
275 do_err('Required PHP extensions missing: '.implode(', ',$diff) );
276 }
277
278 echo $IND . "PHP extensions OK.<br />\n";
279
280 /* dangerous php settings */
281 /**
282 * mbstring.func_overload allows to replace original string and regexp functions
283 * with their equivalents from php mbstring extension. It causes problems when
284 * scripts analyze 8bit strings byte after byte or use 8bit strings in regexp tests.
285 * Setting can be controlled in php.ini (php 4.2.0), webserver config (php 4.2.0)
286 * and .htaccess files (php 4.3.5).
287 */
288 if (function_exists('mb_internal_encoding') &&
289 check_php_version(4,2,0) &&
290 (int)ini_get('mbstring.func_overload')!=0) {
291 $mb_error='You have enabled mbstring overloading.'
292 .' It can cause problems with SquirrelMail scripts that rely on single byte string functions.';
293 do_err($mb_error);
294 }
295
296 /**
297 * Do not use SquirrelMail with magic_quotes_* on.
298 */
299 if ( get_magic_quotes_runtime() || get_magic_quotes_gpc() ||
300 ( (bool) ini_get('magic_quotes_sybase') && ini_get('magic_quotes_sybase') != 'off' )
301 ) {
302 $magic_quotes_warning='You have enabled any one of <tt>magic_quotes_runtime</tt>, '
303 .'<tt>magic_quotes_gpc</tt> or <tt>magic_quotes_sybase</tt> in your PHP '
304 .'configuration. We recommend all those settings to be off. SquirrelMail '
305 .'may work with them on, but when experiencing stray backslashes in your mail '
306 .'or other strange behaviour, it may be advisable to turn them off.';
307 do_err($magic_quotes_warning,false);
308 }
309
310 if (ini_get('short_open_tag') == 0) {
311 $short_open_tag_warning = 'You have configured PHP not to allow short tags '
312 . '(<tt>short_open_tag=off</tt>). This shouldn\'t be a problem with '
313 . 'SquirrelMail or any plugin coded coded according to the '
314 . 'SquirrelMail Coding Guidelines, but if you experience problems with '
315 . 'PHP code being displayed in some of the pages and changing setting '
316 . 'to "on" solves the problem, please file a bug report against the '
317 . 'failing plugin. The correct contact information is most likely '
318 . 'to be found in the plugin documentation.';
319 do_err($short_open_tag_warning, false);
320 }
321
322 /* checking paths */
323
324 echo "Checking paths...<br />\n";
325
326 if(!file_exists($data_dir)) {
327 // data_dir is not that important in db_setups.
328 if (!empty($prefs_dsn)) {
329 $data_dir_error = "Data dir ($data_dir) does not exist!\n";
330 echo $IND .'<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
331 } else {
332 do_err("Data dir ($data_dir) does not exist!");
333 }
334 }
335 // don't check if errors
336 if(!isset($data_dir_error) && !is_dir($data_dir)) {
337 if (!empty($prefs_dsn)) {
338 $data_dir_error = "Data dir ($data_dir) is not a directory!\n";
339 echo $IND . '<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
340 } else {
341 do_err("Data dir ($data_dir) is not a directory!");
342 }
343 }
344 // datadir should be executable - but no clean way to test on that
345 if(!isset($data_dir_error) && !is_writable($data_dir)) {
346 if (!empty($prefs_dsn)) {
347 $data_dir_error = "Data dir ($data_dir) is not writable!\n";
348 echo $IND . '<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
349 } else {
350 do_err("Data dir ($data_dir) is not writable!");
351 }
352 }
353
354 if (isset($data_dir_error)) {
355 echo " Some plugins might need access to data directory.<br />\n";
356 } else {
357 // todo_ornot: actually write something and read it back.
358 echo $IND . "Data dir OK.<br />\n";
359 }
360
361 if($data_dir == $attachment_dir) {
362 echo $IND . "Attachment dir is the same as data dir.<br />\n";
363 if (isset($data_dir_error)) {
364 do_err($data_dir_error);
365 }
366 } else {
367 if(!file_exists($attachment_dir)) {
368 do_err("Attachment dir ($attachment_dir) does not exist!");
369 }
370 if (!is_dir($attachment_dir)) {
371 do_err("Attachment dir ($attachment_dir) is not a directory!");
372 }
373 if (!is_writable($attachment_dir)) {
374 do_err("I cannot write to attachment dir ($attachment_dir)!");
375 }
376 echo $IND . "Attachment dir OK.<br />\n";
377 }
378
379
380 echo "Checking plugins...<br />\n";
381
382 /* check plugins and themes */
383 //FIXME: check requirements given in plugin _info() function, such
384 // as required PHP extensions, Pear packages, other plugins, SM version, etc
385 // see development docs for list of returned info from that function
386 $bad_plugins = array(
387 'attachment_common', // Integrated into SquirrelMail 1.2 core
388 'auto_prune_sent', // Obsolete: See Proon Automatic Folder Pruning plugin
389 'compose_new_window', // Integrated into SquirrelMail 1.4 core
390 'delete_move_next', // Integrated into SquirrelMail 1.5 core
391 'disk_quota', // Obsolete: See Check Quota plugin
392 'email_priority', // Integrated into SquirrelMail 1.2 core
393 'emoticons', // Obsolete: See HTML Mail plugin
394 'focus_change', // Integrated into SquirrelMail 1.2 core
395 'folder_settings', // Integrated into SquirrelMail 1.5.1 core
396 'global_sql_addressbook', // Integrated into SquirrelMail 1.4 core
397 'hancock', // Not Working: See Random Signature Taglines plugin
398 'msg_flags', // Integrated into SquirrelMail 1.5.1 core
399 'message_source', // Added to SquirrelMail 1.4 Core Plugins (message_details)
400 'motd', // Integrated into SquirrelMail 1.2 core
401 'paginator', // Integrated into SquirrelMail 1.2 core
402 'printer_friendly', // Integrated into SquirrelMail 1.2 core
403 'procfilter', // Obsolete: See Server Side Filter plugin
404 'redhat_php_cgi_fix', // Integrated into SquirrelMail 1.1.1 core
405 'send_to_semicolon', // Integrated into SquirrelMail 1.4.1 core
406 'spamassassin', // Not working beyond SquirrelMail 1.2.7: See Spamassassin SpamFilter (Frontend) v2 plugin
407 'sqcalendar', // Added to SquirrelMail 1.2 Core Plugins (calendar)
408 'sqclock', // Integrated into SquirrelMail 1.2 core
409 'sql_squirrel_logger', // Obsolete: See Squirrel Logger plugin
410 'tmda', // Obsolete: See TMDA Tools plugin
411 'vacation', // Obsolete: See Vacation Local plugin
412 'view_as_html', // Integrated into SquirrelMail 1.5.1 core
413 'xmailer' // Integrated into SquirrelMail 1.2 core
414 );
415
416 if (isset($plugins[0])) {
417 foreach($plugins as $plugin) {
418 if(!file_exists(SM_PATH .'plugins/'.$plugin)) {
419 do_err('You have enabled the <i>'.$plugin.'</i> plugin, but I cannot find it.', FALSE);
420 } elseif (!is_readable(SM_PATH .'plugins/'.$plugin.'/setup.php')) {
421 do_err('You have enabled the <i>'.$plugin.'</i> plugin, but I cannot read its setup.php file.', FALSE);
422 } elseif (in_array($plugin, $bad_plugins)) {
423 do_err('You have enabled the <i>'.$plugin.'</i> plugin, which causes problems with this version of SquirrelMail. Please check the ReleaseNotes or other documentation for more information.', false);
424 }
425 }
426 // load plugin functions
427 include_once(SM_PATH . 'functions/plugin.php');
428 // turn on output buffering in order to prevent output of new lines
429 ob_start();
430 foreach ($plugins as $name) {
431 use_plugin($name);
432 }
433 // get output and remove whitespace
434 $output = trim(ob_get_contents());
435 ob_end_clean();
436 // if plugins output more than newlines and spacing, stop script execution.
437 if (!empty($output)) {
438 $plugin_load_error = 'Some output is produced when plugins are loaded. Usually this means there is an error in one of the plugin setup or configuration files. The output was: '.htmlspecialchars($output);
439 do_err($plugin_load_error);
440 }
441 /**
442 * Print plugin versions
443 */
444 echo $IND . "Plugin versions...<br />\n";
445 foreach ($plugins as $name) {
446 $plugin_version = get_plugin_version($name);
447 $english_name = get_plugin_requirement($name, 'english_name');
448 echo $IND . $IND . (empty($english_name) ? $name . ' ' : $english_name . ' (' . $name . ') ') . (empty($plugin_version) ? '??' : $plugin_version) . "<br />\n";
449
450 // check if this plugin has any other plugin
451 // dependencies and if they are satisfied
452 //
453 $failed_dependencies = check_plugin_dependencies($name);
454 if ($failed_dependencies === SQ_INCOMPATIBLE) {
455 do_err($name . ' is NOT COMPATIBLE with this version of SquirrelMail', FALSE);
456 }
457 else if (is_array($failed_dependencies)) {
458 $missing_plugins = '';
459 foreach ($failed_dependencies as $depend_name => $depend_requirements) {
460 $missing_plugins .= ', ' . $depend_name . ' (version ' . $depend_requirements['version'] . ', ' . ($depend_requirements['activate'] ? 'must be activated' : 'need not be activated') . ')';
461 }
462 do_err($name . ' is missing some dependencies: ' . trim($missing_plugins, ', '), FALSE);
463 }
464
465 }
466 /**
467 * This hook was added in 1.5.2 and 1.4.10. Each plugins should print an error
468 * message and return TRUE if there are any errors in its setup/configuration.
469 */
470 $plugin_err = boolean_hook_function('configtest', $null, 1);
471 if($plugin_err) {
472 do_err('Some plugin tests failed.');
473 } else {
474 echo $IND . "Plugins OK.<br />\n";
475 }
476 } else {
477 echo $IND . "Plugins are not enabled in config.<br />\n";
478 }
479 foreach($theme as $thm) {
480 if(!file_exists($thm['PATH'])) {
481 do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot find it ('.$thm['PATH'].').', FALSE);
482 } elseif(!is_readable($thm['PATH'])) {
483 do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot read it ('.$thm['PATH'].').', FALSE);
484 }
485 }
486
487 echo $IND . "Themes OK.<br />\n";
488
489 if ( $squirrelmail_default_language != 'en_US' ) {
490 $loc_path = SM_PATH .'locale/'.$squirrelmail_default_language.'/LC_MESSAGES/squirrelmail.mo';
491 if( ! file_exists( $loc_path ) ) {
492 do_err('You have set <i>' . $squirrelmail_default_language .
493 '</i> as your default language, but I cannot find this translation (should be '.
494 'in <tt>' . $loc_path . '</tt>). Please note that you have to download translations '.
495 'separately from the main SquirrelMail package.', FALSE);
496 } elseif ( ! is_readable( $loc_path ) ) {
497 do_err('You have set <i>' . $squirrelmail_default_language .
498 '</i> as your default language, but I cannot read this translation (file '.
499 'in <tt>' . $loc_path . '</tt> unreadable).', FALSE);
500 } else {
501 echo $IND . "Default language OK.<br />\n";
502 }
503 } else {
504 echo $IND . "Default language OK.<br />\n";
505 }
506
507 echo $IND . "Base URL detected as: <tt>" . htmlspecialchars($test_location) .
508 "</tt> (location base " . (empty($config_location_base) ? 'autodetected' : 'set to <tt>' .
509 htmlspecialchars($config_location_base)."</tt>") . ")<br />\n";
510
511 /* check minimal requirements for other security options */
512
513 /* imaps or ssmtp */
514 if($use_smtp_tls == 1 || $use_imap_tls == 1) {
515 if(!check_php_version(4,3,0)) {
516 do_err('You need at least PHP 4.3.0 for SMTP/IMAP TLS!');
517 }
518 if(!extension_loaded('openssl')) {
519 do_err('You need the openssl PHP extension to use SMTP/IMAP TLS!');
520 }
521 }
522 /* starttls extensions */
523 if($use_smtp_tls === 2 || $use_imap_tls === 2) {
524 if (! function_exists('stream_socket_enable_crypto')) {
525 do_err('If you want to use STARTTLS extension, you need stream_socket_enable_crypto() function from PHP 5.1.0 and newer.');
526 }
527 }
528 /* digest-md5 */
529 if ($smtp_auth_mech=='digest-md5' || $imap_auth_mech =='digest-md5') {
530 if (!extension_loaded('xml')) {
531 do_err('You need the PHP XML extension to use Digest-MD5 authentication!');
532 }
533 }
534
535 /* check outgoing mail */
536
537 echo "Checking outgoing mail service....<br />\n";
538
539 if($useSendmail) {
540 // is_executable also checks for existance, but we want to be as precise as possible with the errors
541 if(!file_exists($sendmail_path)) {
542 do_err("Location of sendmail program incorrect ($sendmail_path)!");
543 }
544 if(!is_executable($sendmail_path)) {
545 do_err("I cannot execute the sendmail program ($sendmail_path)!");
546 }
547
548 echo $IND . "sendmail OK<br />\n";
549 } else {
550 $stream = fsockopen( ($use_smtp_tls==1?'tls://':'').$smtpServerAddress, $smtpPort,
551 $errorNumber, $errorString);
552 if(!$stream) {
553 do_err("Error connecting to SMTP server \"$smtpServerAddress:$smtpPort\".".
554 "Server error: ($errorNumber) ".htmlspecialchars($errorString));
555 }
556
557 // check for SMTP code; should be 2xx to allow us access
558 $smtpline = fgets($stream, 1024);
559 if(((int) $smtpline{0}) > 3) {
560 do_err("Error connecting to SMTP server. Server error: ".
561 htmlspecialchars($smtpline));
562 }
563
564 /* smtp starttls checks */
565 if ($use_smtp_tls===2) {
566 // if something breaks, script should close smtp connection on exit.
567
568 // say helo
569 fwrite($stream,"EHLO $client_ip\r\n");
570
571 $ehlo=array();
572 $ehlo_error = false;
573 while ($line=fgets($stream, 1024)){
574 if (preg_match("/^250(-|\s)(\S*)\s+(\S.*)/",$line,$match)||
575 preg_match("/^250(-|\s)(\S*)\s+/",$line,$match)) {
576 if (!isset($match[3])) {
577 // simple one word extension
578 $ehlo[strtoupper($match[2])]='';
579 } else {
580 // ehlo-keyword + ehlo-param
581 $ehlo[strtoupper($match[2])]=trim($match[3]);
582 }
583 if ($match[1]==' ') {
584 $ret = $line;
585 break;
586 }
587 } else {
588 //
589 $ehlo_error = true;
590 $ehlo[]=$line;
591 break;
592 }
593 }
594 if ($ehlo_error) {
595 do_err('SMTP EHLO failed. You need ESMTP support for SMTP STARTTLS');
596 } elseif (!array_key_exists('STARTTLS',$ehlo)) {
597 do_err('STARTTLS support is not declared by SMTP server.');
598 }
599
600 fwrite($stream,"STARTTLS\r\n");
601 $starttls_response=fgets($stream, 1024);
602 if ($starttls_response[0]!=2) {
603 $starttls_cmd_err = 'SMTP STARTTLS failed. Server replied: '
604 .htmlspecialchars($starttls_response);
605 do_err($starttls_cmd_err);
606 } elseif(! stream_socket_enable_crypto($stream,true,STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
607 do_err('Failed to enable encryption on SMTP STARTTLS connection.');
608 } else {
609 echo $IND . "SMTP STARTTLS extension looks OK.<br />\n";
610 }
611 // According to RFC we should second ehlo call here.
612 }
613
614 fputs($stream, 'QUIT');
615 fclose($stream);
616 echo $IND . 'SMTP server OK (<tt><small>'.
617 trim(htmlspecialchars($smtpline))."</small></tt>)<br />\n";
618
619 /* POP before SMTP */
620 if($pop_before_smtp) {
621 $stream = fsockopen($smtpServerAddress, 110, $err_no, $err_str);
622 if (!$stream) {
623 do_err("Error connecting to POP Server ($smtpServerAddress:110) "
624 . $err_no . ' : ' . htmlspecialchars($err_str));
625 }
626
627 $tmp = fgets($stream, 1024);
628 if (substr($tmp, 0, 3) != '+OK') {
629 do_err("Error connecting to POP Server ($smtpServerAddress:110)"
630 . ' '.htmlspecialchars($tmp));
631 }
632 fputs($stream, 'QUIT');
633 fclose($stream);
634 echo $IND . "POP-before-SMTP OK.<br />\n";
635 }
636 }
637
638 /**
639 * Check the IMAP server
640 */
641 echo "Checking IMAP service....<br />\n";
642
643 /** Can we open a connection? */
644 $stream = fsockopen( ($use_imap_tls==1?'tls://':'').$imapServerAddress, $imapPort,
645 $errorNumber, $errorString);
646 if(!$stream) {
647 do_err("Error connecting to IMAP server \"$imapServerAddress:$imapPort\".".
648 "Server error: ($errorNumber) ".
649 htmlspecialchars($errorString));
650 }
651
652 /** Is the first response 'OK'? */
653 $imapline = fgets($stream, 1024);
654 if(substr($imapline, 0,4) != '* OK') {
655 do_err('Error connecting to IMAP server. Server error: '.
656 htmlspecialchars($imapline));
657 }
658
659 echo $IND . 'IMAP server ready (<tt><small>'.
660 htmlspecialchars(trim($imapline))."</small></tt>)<br />\n";
661
662 /** Check capabilities */
663 fputs($stream, "A001 CAPABILITY\r\n");
664 $capline = '';
665 while ($line=fgets($stream, 1024)){
666 if (preg_match("/A001.*/",$line)) {
667 break;
668 } else {
669 $capline.=$line;
670 }
671 }
672
673 /* don't display capabilities before STARTTLS */
674 if ($use_imap_tls===2 && stristr($capline, 'STARTTLS') === false) {
675 do_err('Your server doesn\'t support STARTTLS.');
676 } elseif($use_imap_tls===2) {
677 /* try starting starttls */
678 fwrite($stream,"A002 STARTTLS\r\n");
679 $starttls_line=fgets($stream, 1024);
680 if (! preg_match("/^A002 OK.*/i",$starttls_line)) {
681 $imap_starttls_err = 'IMAP STARTTLS failed. Server replied: '
682 .htmlspecialchars($starttls_line);
683 do_err($imap_starttls_err);
684 } elseif (! stream_socket_enable_crypto($stream,true,STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
685 do_err('Failed to enable encryption on IMAP connection.');
686 } else {
687 echo $IND . "IMAP STARTTLS extension looks OK.<br />\n";
688 }
689
690 // get new capability line
691 fwrite($stream,"A003 CAPABILITY\r\n");
692 $capline='';
693 while ($line=fgets($stream, 1024)){
694 if (preg_match("/A003.*/",$line)) {
695 break;
696 } else {
697 $capline.=$line;
698 }
699 }
700 }
701
702 echo $IND . 'Capabilities: <tt>'.htmlspecialchars($capline)."</tt><br />\n";
703
704 if($imap_auth_mech == 'login' && stristr($capline, 'LOGINDISABLED') !== FALSE) {
705 do_err('Your server doesn\'t allow plaintext logins. '.
706 'Try enabling another authentication mechanism like CRAM-MD5, DIGEST-MD5 or TLS-encryption '.
707 'in the SquirrelMail configuration.', FALSE);
708 }
709
710 if (stristr($capline, 'XMAGICTRASH') !== false) {
711 $magic_trash = 'It looks like IMAP_MOVE_EXPUNGE_TO_TRASH option is turned on '
712 .'in your Courier IMAP configuration. Courier does not provide tools that '
713 .'allow to detect folder used for Trash or commands are not documented. '
714 .'SquirrelMail can\'t detect special trash folder. SquirrelMail manages '
715 .'all message deletion or move operations internally and '
716 .'IMAP_MOVE_EXPUNGE_TO_TRASH option can cause errors in message and '
717 .'folder management operations. Please turn off IMAP_MOVE_EXPUNGE_TO_TRASH '
718 .'option in Courier imapd configuration.';
719 do_err($magic_trash,false);
720 }
721
722 /* add warning about IMAP delivery */
723 if (stristr($capline, 'XCOURIEROUTBOX') !== false) {
724 $courier_outbox = 'OUTBOX setting is enabled in your Courier imapd '
725 .'configuration. SquirrelMail uses standard SMTP protocol or sendmail '
726 .'binary to send emails. Courier IMAP delivery method is not supported'
727 .' and can create duplicate email messages.';
728 do_err($courier_outbox,false);
729 }
730
731 /** OK, close connection */
732 fputs($stream, "A004 LOGOUT\r\n");
733 fclose($stream);
734
735 echo "Checking internationalization (i18n) settings...<br />\n";
736 echo "$IND gettext - ";
737 if (function_exists('gettext')) {
738 echo 'Gettext functions are available.'
739 .' On some systems you must have appropriate system locales compiled.'
740 ."<br />\n";
741
742 /* optional setlocale() tests. Should work only on glibc systems. */
743 if (sqgetGlobalVar('testlocales',$testlocales,SQ_GET)) {
744 include_once(SM_PATH . 'include/languages.php');
745 echo $IND . $IND . 'Testing translations:<br>';
746 foreach ($languages as $lang_code => $lang_data) {
747 /* don't test aliases */
748 if (isset($lang_data['NAME'])) {
749 /* locale can be $lang_code or $lang_data['LOCALE'] */
750 if (isset($lang_data['LOCALE'])) {
751 $setlocale = $lang_data['LOCALE'];
752 } else {
753 $setlocale = $lang_code;
754 }
755 /* prepare information about tested locales */
756 if (is_array($setlocale)) {
757 $display_locale = implode(', ',$setlocale);
758 $locale_count = count($setlocale);
759 } else {
760 $display_locale = $setlocale;
761 $locale_count = 1;
762 }
763 $tested_locales_msg = 'Tested '.htmlspecialchars($display_locale).' '
764 .($locale_count>1 ? 'locales':'locale'). '.';
765
766 echo $IND . $IND .$IND . $lang_data['NAME'].' (' .$lang_code. ') - ';
767 $retlocale = sq_setlocale(LC_ALL,$setlocale);
768 if (is_bool($retlocale)) {
769 echo '<font color="red">unsupported</font>. ';
770 echo $tested_locales_msg;
771 } else {
772 echo 'supported. '
773 .$tested_locales_msg
774 .' setlocale() returned "'.htmlspecialchars($retlocale).'"';
775 }
776 echo "<br />\n";
777 }
778 }
779 echo $IND . $IND . '<a href="configtest.php">Don\'t test translations</a>';
780 } else {
781 echo $IND . $IND . '<a href="configtest.php?testlocales=1">Test translations</a>. '
782 .'This test is not accurate and might work only on some systems.'
783 ."\n";
784 }
785 echo "<br />\n";
786 /* end of translation tests */
787 } else {
788 echo 'Gettext functions are unavailable.'
789 .' SquirrelMail will use slower internal gettext functions.'
790 ."<br />\n";
791 }
792 echo "$IND mbstring - ";
793 if (function_exists('mb_detect_encoding')) {
794 echo "Mbstring functions are available.<br />\n";
795 } else {
796 echo 'Mbstring functions are unavailable.'
797 ." Japanese translation won't work.<br />\n";
798 }
799 echo "$IND recode - ";
800 if (function_exists('recode')) {
801 echo "Recode functions are available.<br />\n";
802 } elseif (isset($use_php_recode) && $use_php_recode) {
803 echo "Recode functions are unavailable.<br />\n";
804 do_err('Your configuration requires recode support, but recode support is missing.');
805 } else {
806 echo "Recode functions are unavailable.<br />\n";
807 }
808 echo "$IND iconv - ";
809 if (function_exists('iconv')) {
810 echo "Iconv functions are available.<br />\n";
811 } elseif (isset($use_php_iconv) && $use_php_iconv) {
812 echo "Iconv functions are unavailable.<br />\n";
813 do_err('Your configuration requires iconv support, but iconv support is missing.');
814 } else {
815 echo "Iconv functions are unavailable.<br />\n";
816 }
817 // same test as in include/init.php + date_default_timezone_set check
818 echo "$IND timezone - ";
819 if ( (!ini_get('safe_mode')) || function_exists('date_default_timezone_set') ||
820 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
821 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars')) ) {
822 echo "Webmail users can change their time zone settings. \n";
823 } else {
824 echo "Webmail users can't change their time zone settings. \n";
825 }
826 if (isset($_ENV['TZ'])) {
827 echo 'Default time zone is '.htmlspecialchars($_ENV['TZ']);
828 } else {
829 echo 'Current time zone is '.date('T');
830 }
831 echo ".<br />\n";
832
833 // Pear DB tests
834 echo "Checking database functions...<br />\n";
835 if($addrbook_dsn || $prefs_dsn || $addrbook_global_dsn) {
836 @include_once('DB.php');
837 if (class_exists('DB')) {
838 echo "$IND PHP Pear DB support is present.<br />\n";
839 $db_functions=array(
840 'dbase' => 'dbase_open',
841 'fbsql' => 'fbsql_connect',
842 'interbase' => 'ibase_connect',
843 'informix' => 'ifx_connect',
844 'msql' => 'msql_connect',
845 'mssql' => 'mssql_connect',
846 'mysql' => 'mysql_connect',
847 'mysqli' => 'mysqli_connect',
848 'oci8' => 'ocilogon',
849 'odbc' => 'odbc_connect',
850 'pgsql' => 'pg_connect',
851 'sqlite' => 'sqlite_open',
852 'sybase' => 'sybase_connect'
853 );
854
855 $dsns = array();
856 if($prefs_dsn) {
857 $dsns['preferences'] = $prefs_dsn;
858 }
859 if($addrbook_dsn) {
860 $dsns['addressbook'] = $addrbook_dsn;
861 }
862 if($addrbook_global_dsn) {
863 $dsns['global addressbook'] = $addrbook_global_dsn;
864 }
865
866 foreach($dsns as $type => $dsn) {
867 $aDsn = explode(':', $dsn);
868 $dbtype = array_shift($aDsn);
869 if(isset($db_functions[$dbtype]) && function_exists($db_functions[$dbtype])) {
870 echo "$IND$dbtype database support present.<br />\n";
871
872 // now, test this interface:
873
874 $dbh = DB::connect($dsn, true);
875 if (DB::isError($dbh)) {
876 do_err('Database error: '. htmlspecialchars(DB::errorMessage($dbh)) .
877 ' in ' .$type .' DSN.');
878 }
879 $dbh->disconnect();
880 echo "$IND$type database connect successful.<br />\n";
881
882 } else {
883 do_err($dbtype.' database support not present!');
884 }
885 }
886 } else {
887 $db_error='Required PHP PEAR DB support is not available.'
888 .' Is PEAR installed and is the include path set correctly to find <tt>DB.php</tt>?'
889 .' The include path is now: "<tt>' . ini_get('include_path') . '</tt>".';
890 do_err($db_error);
891 }
892 } else {
893 echo $IND."not using database functionality.<br />\n";
894 }
895
896 // LDAP DB tests
897 echo "Checking LDAP functions...<br />\n";
898 if( empty($ldap_server) ) {
899 echo $IND."not using LDAP functionality.<br />\n";
900 } else {
901 if ( !function_exists('ldap_connect') ) {
902 do_err('Required LDAP support is not available.');
903 } else {
904 echo "$IND LDAP support present.<br />\n";
905 foreach ( $ldap_server as $param ) {
906
907 $linkid = @ldap_connect($param['host'], (empty($param['port']) ? 389 : $param['port']) );
908
909 if ( $linkid ) {
910 echo "$IND LDAP connect to ".$param['host']." successful: ".$linkid."<br />\n";
911
912 if ( !empty($param['protocol']) &&
913 !ldap_set_option($linkid, LDAP_OPT_PROTOCOL_VERSION, $param['protocol']) ) {
914 do_err('Unable to set LDAP protocol');
915 }
916
917 if ( empty($param['binddn']) ) {
918 $bind = @ldap_bind($linkid);
919 } else {
920 $bind = @ldap_bind($param['binddn'], $param['bindpw']);
921 }
922
923 if ( $bind ) {
924 echo "$IND LDAP Bind Successful <br />";
925 } else {
926 do_err('Unable to Bind to LDAP Server');
927 }
928
929 @ldap_close($linkid);
930 } else {
931 do_err('Connection to LDAP failed');
932 }
933 }
934 }
935 }
936
937 echo '<hr width="75%" align="center">';
938 echo '<h2 align="center">Summary</h2>';
939 $footer = '<hr width="75%" align="center">';
940 if ($warnings) {
941 echo '<p>No fatal errors were found, but there was at least 1 warning. Please check the flagged issue(s) carefully, as correcting them may prevent erratic, undefined, or incorrect behavior (or flat out breakage).</p>';
942 echo $footer;
943 } else {
944 print <<< EOF
945 <p>Congratulations, your SquirrelMail setup looks fine to me!</p>
946
947 <p><a href="login.php">Login now</a></p>
948
949 </body>
950 </html>
951 EOF;
952 echo $footer;
953 }