give an error when trying to enable a nonexistent plugin
[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
17fca61d 278echo $IND . "PHP extensions OK.<br />\n";
d1ae9d4c 279
8f186a2a 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
d0184454 284 * scripts analyze 8bit strings byte after byte or use 8bit strings in regexp tests.
9211bcef 285 * Setting can be controlled in php.ini (php 4.2.0), webserver config (php 4.2.0)
8f186a2a 286 * and .htaccess files (php 4.3.5).
287 */
288if (function_exists('mb_internal_encoding') &&
9211bcef 289 check_php_version(4,2,0) &&
8f186a2a 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}
d1ae9d4c 295
99c1c0d6 296/**
297 * Do not use SquirrelMail with magic_quotes_* on.
298 */
299if ( 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
dc528046 310if (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}
99c1c0d6 321
d1ae9d4c 322/* checking paths */
323
324echo "Checking paths...<br />\n";
325
326if(!file_exists($data_dir)) {
d0184454 327 // data_dir is not that important in db_setups.
ccbde363 328 if (!empty($prefs_dsn)) {
d0184454 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 }
91e0dccc 334}
d0184454 335// don't check if errors
336if(!isset($data_dir_error) && !is_dir($data_dir)) {
ccbde363 337 if (!empty($prefs_dsn)) {
d0184454 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 }
91e0dccc 343}
d4eaadbe 344// datadir should be executable - but no clean way to test on that
d0184454 345if(!isset($data_dir_error) && !is_writable($data_dir)) {
ccbde363 346 if (!empty($prefs_dsn)) {
d0184454 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 }
d1ae9d4c 352}
353
d0184454 354if (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}
d1ae9d4c 360
361if($data_dir == $attachment_dir) {
362 echo $IND . "Attachment dir is the same as data dir.<br />\n";
d0184454 363 if (isset($data_dir_error)) {
364 do_err($data_dir_error);
365 }
d1ae9d4c 366} else {
367 if(!file_exists($attachment_dir)) {
368 do_err("Attachment dir ($attachment_dir) does not exist!");
91e0dccc 369 }
d1ae9d4c 370 if (!is_dir($attachment_dir)) {
371 do_err("Attachment dir ($attachment_dir) is not a directory!");
91e0dccc 372 }
d1ae9d4c 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
646b17e0 380echo "Checking plugins...<br />\n";
381
d1ae9d4c 382/* check plugins and themes */
99a44bdc 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
f084f987 386$bad_plugins = array(
0880efc9 387 'attachment_common', // Integrated into SquirrelMail 1.2 core
eb7bd9b7 388 'auto_prune_sent', // Obsolete: See Proon Automatic Folder Pruning plugin
0880efc9 389 'compose_new_window', // Integrated into SquirrelMail 1.4 core
390 'delete_move_next', // Integrated into SquirrelMail 1.5 core
eb7bd9b7 391 'disk_quota', // Obsolete: See Check Quota plugin
0880efc9 392 'email_priority', // Integrated into SquirrelMail 1.2 core
eb7bd9b7 393 'emoticons', // Obsolete: See HTML Mail plugin
0880efc9 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
eb7bd9b7 397 'hancock', // Not Working: See Random Signature Taglines plugin
0880efc9 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
eb7bd9b7 403 'procfilter', // Obsolete: See Server Side Filter plugin
0880efc9 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
eb7bd9b7 409 'sql_squirrel_logger', // Obsolete: See Squirrel Logger plugin
410 'tmda', // Obsolete: See TMDA Tools plugin
411 'vacation', // Obsolete: See Vacation Local plugin
0880efc9 412 'view_as_html', // Integrated into SquirrelMail 1.5.1 core
413 'xmailer' // Integrated into SquirrelMail 1.2 core
f084f987 414 );
3a196538 415
5b53b7e0 416if (isset($plugins[0])) {
417 foreach($plugins as $plugin) {
418 if(!file_exists(SM_PATH .'plugins/'.$plugin)) {
f084f987 419 do_err('You have enabled the <i>'.$plugin.'</i> plugin, but I cannot find it.', FALSE);
5b53b7e0 420 } elseif (!is_readable(SM_PATH .'plugins/'.$plugin.'/setup.php')) {
f084f987 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 }
d1ae9d4c 425 }
69792446 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)) {
c13b8d16 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);
69792446 439 do_err($plugin_load_error);
440 }
dc528046 441 /**
56f9bb83 442 * Print plugin versions
443 */
56f9bb83 444 echo $IND . "Plugin versions...<br />\n";
445 foreach ($plugins as $name) {
d95b10b3 446 $plugin_version = get_plugin_version($name);
daa0c5b8 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";
2cbaf68d 449
dc528046 450 // check if this plugin has any other plugin
2cbaf68d 451 // dependencies and if they are satisfied
452 //
453 $failed_dependencies = check_plugin_dependencies($name);
f258865c 454 if ($failed_dependencies === SQ_INCOMPATIBLE) {
03a69f57 455 do_err($name . ' is NOT COMPATIBLE with this version of SquirrelMail', FALSE);
456 }
457 else if (is_array($failed_dependencies)) {
2cbaf68d 458 $missing_plugins = '';
fc6228e4 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') . ')';
2cbaf68d 461 }
462 do_err($name . ' is missing some dependencies: ' . trim($missing_plugins, ', '), FALSE);
463 }
464
56f9bb83 465 }
69792446 466 /**
dc528046 467 * This hook was added in 1.5.2 and 1.4.10. Each plugins should print an error
6e515418 468 * message and return TRUE if there are any errors in its setup/configuration.
69792446 469 */
62fb877b 470 $plugin_err = boolean_hook_function('configtest', $null, 1);
69792446 471 if($plugin_err) {
472 do_err('Some plugin tests failed.');
473 } else {
474 echo $IND . "Plugins OK.<br />\n";
475 }
5b53b7e0 476} else {
477 echo $IND . "Plugins are not enabled in config.<br />\n";
d1ae9d4c 478}
d1ae9d4c 479foreach($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
487echo $IND . "Themes OK.<br />\n";
488
07337c9b 489if ( $squirrelmail_default_language != 'en_US' ) {
490 $loc_path = SM_PATH .'locale/'.$squirrelmail_default_language.'/LC_MESSAGES/squirrelmail.mo';
491 if( ! file_exists( $loc_path ) ) {
f8a1ed5a 492 do_err('You have set <i>' . $squirrelmail_default_language .
f084f987 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);
07337c9b 496 } elseif ( ! is_readable( $loc_path ) ) {
f8a1ed5a 497 do_err('You have set <i>' . $squirrelmail_default_language .
f084f987 498 '</i> as your default language, but I cannot read this translation (file '.
499 'in <tt>' . $loc_path . '</tt> unreadable).', FALSE);
07337c9b 500 } else {
501 echo $IND . "Default language OK.<br />\n";
502 }
503} else {
504 echo $IND . "Default language OK.<br />\n";
505}
506
74530cf4 507echo $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";
23649466 510
a15f9d93 511/* check minimal requirements for other security options */
d1ae9d4c 512
a15f9d93 513/* imaps or ssmtp */
514if($use_smtp_tls == 1 || $use_imap_tls == 1) {
d1ae9d4c 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}
a15f9d93 522/* starttls extensions */
1c4f110f 523if($use_smtp_tls === 2 || $use_imap_tls === 2) {
a15f9d93 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 */
529if ($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 */
d1ae9d4c 536
537echo "Checking outgoing mail service....<br />\n";
538
539if($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)!");
91e0dccc 543 }
d1ae9d4c 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 {
a15f9d93 550 $stream = fsockopen( ($use_smtp_tls==1?'tls://':'').$smtpServerAddress, $smtpPort,
f084f987 551 $errorNumber, $errorString);
d1ae9d4c 552 if(!$stream) {
553 do_err("Error connecting to SMTP server \"$smtpServerAddress:$smtpPort\".".
f084f987 554 "Server error: ($errorNumber) ".htmlspecialchars($errorString));
d1ae9d4c 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) {
9c941728 560 do_err("Error connecting to SMTP server. Server error: ".
f084f987 561 htmlspecialchars($smtpline));
d1ae9d4c 562 }
563
a15f9d93 564 /* smtp starttls checks */
1c4f110f 565 if ($use_smtp_tls===2) {
a15f9d93 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)||
f084f987 575 preg_match("/^250(-|\s)(\S*)\s+/",$line,$match)) {
a15f9d93 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 {
dc528046 588 //
a15f9d93 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
d1ae9d4c 614 fputs($stream, 'QUIT');
615 fclose($stream);
9c941728 616 echo $IND . 'SMTP server OK (<tt><small>'.
f084f987 617 trim(htmlspecialchars($smtpline))."</small></tt>)<br />\n";
d1ae9d4c 618
619 /* POP before SMTP */
620 if($pop_before_smtp) {
621 $stream = fsockopen($smtpServerAddress, 110, $err_no, $err_str);
622 if (!$stream) {
9c941728 623 do_err("Error connecting to POP Server ($smtpServerAddress:110) "
f084f987 624 . $err_no . ' : ' . htmlspecialchars($err_str));
d1ae9d4c 625 }
626
627 $tmp = fgets($stream, 1024);
628 if (substr($tmp, 0, 3) != '+OK') {
629 do_err("Error connecting to POP Server ($smtpServerAddress:110)"
f084f987 630 . ' '.htmlspecialchars($tmp));
d1ae9d4c 631 }
632 fputs($stream, 'QUIT');
633 fclose($stream);
634 echo $IND . "POP-before-SMTP OK.<br />\n";
635 }
636}
637
df758744 638/**
639 * Check the IMAP server
640 */
d1ae9d4c 641echo "Checking IMAP service....<br />\n";
642
df758744 643/** Can we open a connection? */
a15f9d93 644$stream = fsockopen( ($use_imap_tls==1?'tls://':'').$imapServerAddress, $imapPort,
f084f987 645 $errorNumber, $errorString);
d1ae9d4c 646if(!$stream) {
70b71161 647 do_err("Error connecting to IMAP server \"$imapServerAddress:$imapPort\".".
f084f987 648 "Server error: ($errorNumber) ".
649 htmlspecialchars($errorString));
d1ae9d4c 650}
651
df758744 652/** Is the first response 'OK'? */
d1ae9d4c 653$imapline = fgets($stream, 1024);
654if(substr($imapline, 0,4) != '* OK') {
f084f987 655 do_err('Error connecting to IMAP server. Server error: '.
656 htmlspecialchars($imapline));
d1ae9d4c 657}
658
df758744 659echo $IND . 'IMAP server ready (<tt><small>'.
9c941728 660 htmlspecialchars(trim($imapline))."</small></tt>)<br />\n";
d1ae9d4c 661
df758744 662/** Check capabilities */
663fputs($stream, "A001 CAPABILITY\r\n");
a15f9d93 664$capline = '';
665while ($line=fgets($stream, 1024)){
f084f987 666 if (preg_match("/A001.*/",$line)) {
667 break;
668 } else {
669 $capline.=$line;
670 }
a15f9d93 671}
672
673/* don't display capabilities before STARTTLS */
1c4f110f 674if ($use_imap_tls===2 && stristr($capline, 'STARTTLS') === false) {
a15f9d93 675 do_err('Your server doesn\'t support STARTTLS.');
1c4f110f 676} elseif($use_imap_tls===2) {
a15f9d93 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: '
f084f987 682 .htmlspecialchars($starttls_line);
a15f9d93 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}
df758744 701
702echo $IND . 'Capabilities: <tt>'.htmlspecialchars($capline)."</tt><br />\n";
703
704if($imap_auth_mech == 'login' && stristr($capline, 'LOGINDISABLED') !== FALSE) {
705 do_err('Your server doesn\'t allow plaintext logins. '.
f084f987 706 'Try enabling another authentication mechanism like CRAM-MD5, DIGEST-MD5 or TLS-encryption '.
707 'in the SquirrelMail configuration.', FALSE);
df758744 708}
df758744 709
ceb7ad3c 710if (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
0fa9bde7 722/* add warning about IMAP delivery */
723if (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
df758744 731/** OK, close connection */
a15f9d93 732fputs($stream, "A004 LOGOUT\r\n");
df758744 733fclose($stream);
734
17fca61d 735echo "Checking internationalization (i18n) settings...<br />\n";
0ed3bdc3 736echo "$IND gettext - ";
737if (function_exists('gettext')) {
8f186a2a 738 echo 'Gettext functions are available.'
739 .' On some systems you must have appropriate system locales compiled.'
740 ."<br />\n";
fd72907b 741
742 /* optional setlocale() tests. Should work only on glibc systems. */
743 if (sqgetGlobalVar('testlocales',$testlocales,SQ_GET)) {
867fed37 744 include_once(SM_PATH . 'include/languages.php');
fd72907b 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 */
0ed3bdc3 787} else {
8f186a2a 788 echo 'Gettext functions are unavailable.'
789 .' SquirrelMail will use slower internal gettext functions.'
790 ."<br />\n";
0ed3bdc3 791}
792echo "$IND mbstring - ";
793if (function_exists('mb_detect_encoding')) {
794 echo "Mbstring functions are available.<br />\n";
795} else {
8f186a2a 796 echo 'Mbstring functions are unavailable.'
797 ." Japanese translation won't work.<br />\n";
0ed3bdc3 798}
799echo "$IND recode - ";
800if (function_exists('recode')) {
801 echo "Recode functions are available.<br />\n";
ba17b6c7 802} elseif (isset($use_php_recode) && $use_php_recode) {
0ed3bdc3 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}
808echo "$IND iconv - ";
809if (function_exists('iconv')) {
810 echo "Iconv functions are available.<br />\n";
ba17b6c7 811} elseif (isset($use_php_iconv) && $use_php_iconv) {
0ed3bdc3 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}
867fed37 817// same test as in include/init.php + date_default_timezone_set check
0ed3bdc3 818echo "$IND timezone - ";
867fed37 819if ( (!ini_get('safe_mode')) || function_exists('date_default_timezone_set') ||
f084f987 820 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
821 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars')) ) {
fd72907b 822 echo "Webmail users can change their time zone settings. \n";
0ed3bdc3 823} else {
fd72907b 824 echo "Webmail users can't change their time zone settings. \n";
4764a7ff 825}
fd72907b 826if (isset($_ENV['TZ'])) {
827 echo 'Default time zone is '.htmlspecialchars($_ENV['TZ']);
828} else {
829 echo 'Current time zone is '.date('T');
830}
831echo ".<br />\n";
d18703d3 832
4764a7ff 833// Pear DB tests
d18703d3 834echo "Checking database functions...<br />\n";
835if($addrbook_dsn || $prefs_dsn || $addrbook_global_dsn) {
134e4174 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(
f084f987 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 );
134e4174 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) {
ba17b6c7 867 $aDsn = explode(':', $dsn);
868 $dbtype = array_shift($aDsn);
134e4174 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)) .
f084f987 877 ' in ' .$type .' DSN.');
134e4174 878 }
879 $dbh->disconnect();
880 echo "$IND$type database connect successful.<br />\n";
881
882 } else {
ba17b6c7 883 do_err($dbtype.' database support not present!');
d18703d3 884 }
134e4174 885 }
886 } else {
8f186a2a 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>?'
dc528046 889 .' The include path is now: "<tt>' . ini_get('include_path') . '</tt>".';
8f186a2a 890 do_err($db_error);
134e4174 891 }
4764a7ff 892} else {
d18703d3 893 echo $IND."not using database functionality.<br />\n";
0ed3bdc3 894}
7562c55b 895
896// LDAP DB tests
897echo "Checking LDAP functions...<br />\n";
898if( empty($ldap_server) ) {
134e4174 899 echo $IND."not using LDAP functionality.<br />\n";
7562c55b 900} else {
d0184454 901 if ( !function_exists('ldap_connect') ) {
7562c55b 902 do_err('Required LDAP support is not available.');
903 } else {
134e4174 904 echo "$IND LDAP support present.<br />\n";
7562c55b 905 foreach ( $ldap_server as $param ) {
906
d0184454 907 $linkid = @ldap_connect($param['host'], (empty($param['port']) ? 389 : $param['port']) );
7562c55b 908
909 if ( $linkid ) {
f084f987 910 echo "$IND LDAP connect to ".$param['host']." successful: ".$linkid."<br />\n";
91e0dccc 911
7562c55b 912 if ( !empty($param['protocol']) &&
f084f987 913 !ldap_set_option($linkid, LDAP_OPT_PROTOCOL_VERSION, $param['protocol']) ) {
7562c55b 914 do_err('Unable to set LDAP protocol');
91e0dccc 915 }
7562c55b 916
917 if ( empty($param['binddn']) ) {
d0184454 918 $bind = @ldap_bind($linkid);
7562c55b 919 } else {
d0184454 920 $bind = @ldap_bind($param['binddn'], $param['bindpw']);
7562c55b 921 }
922
923 if ( $bind ) {
924 echo "$IND LDAP Bind Successful <br />";
925 } else {
926 do_err('Unable to Bind to LDAP Server');
927 }
91e0dccc 928
d0184454 929 @ldap_close($linkid);
7562c55b 930 } else {
931 do_err('Connection to LDAP failed');
932 }
933 }
934 }
935}
a2b193bc 936
3a196538 937echo '<hr width="75%" align="center">';
938echo '<h2 align="center">Summary</h2>';
939$footer = '<hr width="75%" align="center">';
940if ($warnings) {
f084f987 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;
3a196538 943} else {
f084f987 944 print <<< EOF
d1ae9d4c 945<p>Congratulations, your SquirrelMail setup looks fine to me!</p>
946
13721b47 947<p><a href="login.php">Login now</a></p>
d1ae9d4c 948
949</body>
3a196538 950</html>
951EOF;
f084f987 952 echo $footer;
3a196538 953}