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