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