Trimming whitespace
[squirrelmail.git] / src / configtest.php
CommitLineData
d1ae9d4c 1<?php
134e4174 2
30967a1e 3/**
d1ae9d4c 4 * SquirrelMail configtest script
5 *
6c84ba1e 6 * Copyright (c) 2003-2005 The SquirrelMail Project Team
d1ae9d4c 7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
30967a1e 9 * @version $Id$
10 * @package squirrelmail
11 * @subpackage config
d1ae9d4c 12 */
13
14/************************************************************
15 * NOTE: you do not need to change this script! *
16 * If it throws errors you need to adjust your config. *
17 ************************************************************/
18
df758744 19// This script could really use some restructuring as it has grown quite rapidly
20// but is not very 'clean'. Feel free to get some structure into this thing.
21
5b53b7e0 22function do_err($str, $exit = TRUE) {
d18703d3 23 global $IND;
24 echo '<p>'.$IND.'<font color="red"><b>ERROR:</b></font> ' .$str. "</p>\n";
5b53b7e0 25 if($exit) {
26 echo '</body></html>';
27 exit;
28 }
29}
30
31$IND = str_repeat('&nbsp;',4);
32
33ob_implicit_flush();
30967a1e 34/** @ignore */
5b53b7e0 35define('SM_PATH', '../');
36
d0184454 37/* set default value in order to block remote access to script */
38$allow_remote_configtest=false;
39
5b53b7e0 40/*
91e0dccc 41 * Load config before output begins. functions/strings.php depends on
5b53b7e0 42 * functions/globals.php. functions/global.php needs to be run before
91e0dccc 43 * any html output starts. If config.php is missing, error will be displayed
5b53b7e0 44 * later.
45 */
46if (file_exists(SM_PATH . 'config/config.php')) {
47 include(SM_PATH . 'config/config.php');
48 include(SM_PATH . 'functions/strings.php');
49}
d1ae9d4c 50?><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
51<html>
52<head>
f9f738dc 53 <meta name="robots" content="noindex,nofollow">
d1ae9d4c 54 <title>SquirrelMail configtest</title>
55</head>
56<body>
57<h1>SquirrelMail configtest</h1>
58
59<p>This script will try to check some aspects of your SquirrelMail configuration
60and point you to errors whereever it can find them. You need to go run <tt>conf.pl</tt>
d18703d3 61in the <tt>config/</tt> directory first before you run this script.</p>
d1ae9d4c 62
63<?php
64
d1ae9d4c 65$included = array_map('basename', get_included_files() );
66if(!in_array('config.php', $included)) {
67 if(!file_exists(SM_PATH . 'config/config.php')) {
68 do_err('Config file '.SM_PATH . 'config/config.php does not exist!<br />'.
69 'You need to run <tt>conf.pl</tt> first.');
70 }
71 do_err('Could not read '.SM_PATH.'config/config.php! Check file permissions.');
72}
73if(!in_array('strings.php', $included)) {
74 do_err('Could not include '.SM_PATH.'functions/strings.php!<br />'.
75 'Check permissions on that file.');
76}
77
d0184454 78/* Block remote use of script */
79if (! $allow_remote_configtest) {
80 sqGetGlobalVar('REMOTE_ADDR',$client_ip,SQ_SERVER);
81 if (! isset($client_ip) || $client_ip!='127.0.0.1') {
82 do_err('Enable "Allow remote configtest" option in squirrelmail configuration in order to use this script.');
83 }
84}
d1ae9d4c 85/* checking PHP specs */
86
17fca61d 87echo "<p><table>\n<tr><td>SquirrelMail version:</td><td><b>" . $version . "</b></td></tr>\n" .
88 '<tr><td>Config file version:</td><td><b>' . $config_version . "</b></td></tr>\n" .
91e0dccc 89 '<tr><td>Config file last modified:</td><td><b>' .
17fca61d 90 date ('d F Y H:i:s', filemtime(SM_PATH . 'config/config.php')) .
91 "</b></td></tr>\n</table>\n</p>\n\n";
d1ae9d4c 92
93echo "Checking PHP configuration...<br />\n";
94
abd74f7d 95if(!check_php_version(4,1,0)) {
96 do_err('Insufficient PHP version: '. PHP_VERSION . '! Minimum required: 4.1.0');
d1ae9d4c 97}
98
17fca61d 99echo $IND . 'PHP version ' . PHP_VERSION . " OK.<br />\n";
d1ae9d4c 100
101$php_exts = array('session','pcre');
102$diff = array_diff($php_exts, get_loaded_extensions());
103if(count($diff)) {
104 do_err('Required PHP extensions missing: '.implode(', ',$diff) );
105}
106
17fca61d 107echo $IND . "PHP extensions OK.<br />\n";
d1ae9d4c 108
8f186a2a 109/* dangerous php settings */
110/**
111 * mbstring.func_overload allows to replace original string and regexp functions
112 * with their equivalents from php mbstring extension. It causes problems when
d0184454 113 * scripts analyze 8bit strings byte after byte or use 8bit strings in regexp tests.
9211bcef 114 * Setting can be controlled in php.ini (php 4.2.0), webserver config (php 4.2.0)
8f186a2a 115 * and .htaccess files (php 4.3.5).
116 */
117if (function_exists('mb_internal_encoding') &&
9211bcef 118 check_php_version(4,2,0) &&
8f186a2a 119 (int)ini_get('mbstring.func_overload')!=0) {
120 $mb_error='You have enabled mbstring overloading.'
121 .' It can cause problems with SquirrelMail scripts that rely on single byte string functions.';
122 do_err($mb_error);
123}
d1ae9d4c 124
125/* checking paths */
126
127echo "Checking paths...<br />\n";
128
129if(!file_exists($data_dir)) {
d0184454 130 // data_dir is not that important in db_setups.
131 if (isset($prefs_dsn) && ! empty($prefs_dsn)) {
132 $data_dir_error = "Data dir ($data_dir) does not exist!\n";
133 echo $IND .'<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
134 } else {
135 do_err("Data dir ($data_dir) does not exist!");
136 }
91e0dccc 137}
d0184454 138// don't check if errors
139if(!isset($data_dir_error) && !is_dir($data_dir)) {
140 if (isset($prefs_dsn) && ! empty($prefs_dsn)) {
141 $data_dir_error = "Data dir ($data_dir) is not a directory!\n";
142 echo $IND . '<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
143 } else {
144 do_err("Data dir ($data_dir) is not a directory!");
145 }
91e0dccc 146}
d4eaadbe 147// datadir should be executable - but no clean way to test on that
d0184454 148if(!isset($data_dir_error) && !is_writable($data_dir)) {
149 if (isset($prefs_dsn) && ! empty($prefs_dsn)) {
150 $data_dir_error = "Data dir ($data_dir) is not writable!\n";
151 echo $IND . '<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
152 } else {
153 do_err("Data dir ($data_dir) is not writable!");
154 }
d1ae9d4c 155}
156
d0184454 157if (isset($data_dir_error)) {
158 echo " Some plugins might need access to data directory.<br />\n";
159} else {
160 // todo_ornot: actually write something and read it back.
161 echo $IND . "Data dir OK.<br />\n";
162}
d1ae9d4c 163
164if($data_dir == $attachment_dir) {
165 echo $IND . "Attachment dir is the same as data dir.<br />\n";
d0184454 166 if (isset($data_dir_error)) {
167 do_err($data_dir_error);
168 }
d1ae9d4c 169} else {
170 if(!file_exists($attachment_dir)) {
171 do_err("Attachment dir ($attachment_dir) does not exist!");
91e0dccc 172 }
d1ae9d4c 173 if (!is_dir($attachment_dir)) {
174 do_err("Attachment dir ($attachment_dir) is not a directory!");
91e0dccc 175 }
d1ae9d4c 176 if (!is_writable($attachment_dir)) {
177 do_err("I cannot write to attachment dir ($attachment_dir)!");
178 }
179 echo $IND . "Attachment dir OK.<br />\n";
180}
181
182
183/* check plugins and themes */
5b53b7e0 184if (isset($plugins[0])) {
185 foreach($plugins as $plugin) {
186 if(!file_exists(SM_PATH .'plugins/'.$plugin)) {
187 do_err('You have enabled the <i>'.$plugin.'</i> plugin but I cannot find it.', FALSE);
188 } elseif (!is_readable(SM_PATH .'plugins/'.$plugin.'/setup.php')) {
189 do_err('You have enabled the <i>'.$plugin.'</i> plugin but I cannot read its setup.php file.', FALSE);
190 }
d1ae9d4c 191 }
5b53b7e0 192 echo $IND . "Plugins OK.<br />\n";
193} else {
194 echo $IND . "Plugins are not enabled in config.<br />\n";
d1ae9d4c 195}
d1ae9d4c 196foreach($theme as $thm) {
197 if(!file_exists($thm['PATH'])) {
198 do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot find it ('.$thm['PATH'].').', FALSE);
199 } elseif(!is_readable($thm['PATH'])) {
200 do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot read it ('.$thm['PATH'].').', FALSE);
201 }
202}
203
204echo $IND . "Themes OK.<br />\n";
205
07337c9b 206if ( $squirrelmail_default_language != 'en_US' ) {
207 $loc_path = SM_PATH .'locale/'.$squirrelmail_default_language.'/LC_MESSAGES/squirrelmail.mo';
208 if( ! file_exists( $loc_path ) ) {
209 do_err('You have set <i>' . $squirrelmail_default_language .
210 '</i> as your default language, but I cannot find this translation (should be '.
211 'in <tt>' . $loc_path . '</tt>). Please note that you have to download translations '.
212 'separately from the main SquirrelMail package.', FALSE);
213 } elseif ( ! is_readable( $loc_path ) ) {
214 do_err('You have set <i>' . $squirrelmail_default_language .
215 '</i> as your default language, but I cannot read this translation (file '.
216 'in <tt>' . $loc_path . '</tt> unreadable).', FALSE);
217 } else {
218 echo $IND . "Default language OK.<br />\n";
219 }
220} else {
221 echo $IND . "Default language OK.<br />\n";
222}
223
23649466 224echo $IND . "Base URL detected as: <tt>" . htmlspecialchars(get_location()) . "</tt><br />\n";
225
d1ae9d4c 226
227/* check outgoing mail */
228
229if($use_smtp_tls || $use_imap_tls) {
230 if(!check_php_version(4,3,0)) {
231 do_err('You need at least PHP 4.3.0 for SMTP/IMAP TLS!');
232 }
233 if(!extension_loaded('openssl')) {
234 do_err('You need the openssl PHP extension to use SMTP/IMAP TLS!');
235 }
236}
237
238echo "Checking outgoing mail service....<br />\n";
239
240if($useSendmail) {
241 // is_executable also checks for existance, but we want to be as precise as possible with the errors
242 if(!file_exists($sendmail_path)) {
243 do_err("Location of sendmail program incorrect ($sendmail_path)!");
91e0dccc 244 }
d1ae9d4c 245 if(!is_executable($sendmail_path)) {
246 do_err("I cannot execute the sendmail program ($sendmail_path)!");
247 }
248
249 echo $IND . "sendmail OK<br />\n";
250} else {
251 $stream = fsockopen( ($use_smtp_tls?'tls://':'').$smtpServerAddress, $smtpPort,
252 $errorNumber, $errorString);
253 if(!$stream) {
254 do_err("Error connecting to SMTP server \"$smtpServerAddress:$smtpPort\".".
9c941728 255 "Server error: ($errorNumber) ".htmlspecialchars($errorString));
d1ae9d4c 256 }
257
258 // check for SMTP code; should be 2xx to allow us access
259 $smtpline = fgets($stream, 1024);
260 if(((int) $smtpline{0}) > 3) {
9c941728 261 do_err("Error connecting to SMTP server. Server error: ".
134e4174 262 htmlspecialchars($smtpline));
d1ae9d4c 263 }
264
265 fputs($stream, 'QUIT');
266 fclose($stream);
9c941728 267 echo $IND . 'SMTP server OK (<tt><small>'.
268 trim(htmlspecialchars($smtpline))."</small></tt>)<br />\n";
d1ae9d4c 269
270 /* POP before SMTP */
271 if($pop_before_smtp) {
272 $stream = fsockopen($smtpServerAddress, 110, $err_no, $err_str);
273 if (!$stream) {
9c941728 274 do_err("Error connecting to POP Server ($smtpServerAddress:110) "
275 . $err_no . ' : ' . htmlspecialchars($err_str));
d1ae9d4c 276 }
277
278 $tmp = fgets($stream, 1024);
279 if (substr($tmp, 0, 3) != '+OK') {
280 do_err("Error connecting to POP Server ($smtpServerAddress:110)"
9c941728 281 . ' '.htmlspecialchars($tmp));
d1ae9d4c 282 }
283 fputs($stream, 'QUIT');
284 fclose($stream);
285 echo $IND . "POP-before-SMTP OK.<br />\n";
286 }
287}
288
df758744 289/**
290 * Check the IMAP server
291 */
d1ae9d4c 292echo "Checking IMAP service....<br />\n";
293
df758744 294/** Can we open a connection? */
d1ae9d4c 295$stream = fsockopen( ($use_imap_tls?'tls://':'').$imapServerAddress, $imapPort,
296 $errorNumber, $errorString);
297if(!$stream) {
70b71161 298 do_err("Error connecting to IMAP server \"$imapServerAddress:$imapPort\".".
9c941728 299 "Server error: ($errorNumber) ".
134e4174 300 htmlspecialchars($errorString));
d1ae9d4c 301}
302
df758744 303/** Is the first response 'OK'? */
d1ae9d4c 304$imapline = fgets($stream, 1024);
305if(substr($imapline, 0,4) != '* OK') {
9c941728 306 do_err('Error connecting to IMAP server. Server error: '.
307 htmlspecialchars($imapline));
d1ae9d4c 308}
309
df758744 310echo $IND . 'IMAP server ready (<tt><small>'.
9c941728 311 htmlspecialchars(trim($imapline))."</small></tt>)<br />\n";
d1ae9d4c 312
df758744 313/** Check capabilities */
314fputs($stream, "A001 CAPABILITY\r\n");
315$capline = fgets($stream, 1024);
316
317echo $IND . 'Capabilities: <tt>'.htmlspecialchars($capline)."</tt><br />\n";
318
319if($imap_auth_mech == 'login' && stristr($capline, 'LOGINDISABLED') !== FALSE) {
320 do_err('Your server doesn\'t allow plaintext logins. '.
321 'Try enabling another authentication mechanism like CRAM-MD5, DIGEST-MD5 or TLS-encryption '.
322 'in the SquirrelMail configuration.', FALSE);
323}
324if($use_imap_tls && stristr($capline, 'STARTTLS') === FALSE) {
325 do_err('You have enabled TLS encryption in the config, but the server does not '.
326 'report STARTTLS capability. TLS is probably not supported.', FALSE);
327}
328
329/** OK, close connection */
330fputs($stream, "A002 LOGOUT\r\n");
331fclose($stream);
332
17fca61d 333echo "Checking internationalization (i18n) settings...<br />\n";
0ed3bdc3 334echo "$IND gettext - ";
335if (function_exists('gettext')) {
8f186a2a 336 echo 'Gettext functions are available.'
337 .' On some systems you must have appropriate system locales compiled.'
338 ."<br />\n";
0ed3bdc3 339} else {
8f186a2a 340 echo 'Gettext functions are unavailable.'
341 .' SquirrelMail will use slower internal gettext functions.'
342 ."<br />\n";
0ed3bdc3 343}
344echo "$IND mbstring - ";
345if (function_exists('mb_detect_encoding')) {
346 echo "Mbstring functions are available.<br />\n";
347} else {
8f186a2a 348 echo 'Mbstring functions are unavailable.'
349 ." Japanese translation won't work.<br />\n";
0ed3bdc3 350}
351echo "$IND recode - ";
352if (function_exists('recode')) {
353 echo "Recode functions are available.<br />\n";
354} elseif ($use_php_recode) {
355 echo "Recode functions are unavailable.<br />\n";
356 do_err('Your configuration requires recode support, but recode support is missing.');
357} else {
358 echo "Recode functions are unavailable.<br />\n";
359}
360echo "$IND iconv - ";
361if (function_exists('iconv')) {
362 echo "Iconv functions are available.<br />\n";
363} elseif ($use_php_iconv) {
364 echo "Iconv functions are unavailable.<br />\n";
365 do_err('Your configuration requires iconv support, but iconv support is missing.');
366} else {
367 echo "Iconv functions are unavailable.<br />\n";
368}
369// same test as in include/validate.php
370echo "$IND timezone - ";
371if ( (!ini_get('safe_mode')) ||
372 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
373 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars')) ) {
134e4174 374 echo "Webmail users can change their time zone settings.<br />\n";
0ed3bdc3 375} else {
4764a7ff 376 echo "Webmail users can't change their time zone settings.<br />\n";
377}
378
d18703d3 379
4764a7ff 380// Pear DB tests
d18703d3 381echo "Checking database functions...<br />\n";
382if($addrbook_dsn || $prefs_dsn || $addrbook_global_dsn) {
134e4174 383 @include_once('DB.php');
384 if (class_exists('DB')) {
385 echo "$IND PHP Pear DB support is present.<br />\n";
386 $db_functions=array(
91e0dccc 387 'dbase' => 'dbase_open',
388 'fbsql' => 'fbsql_connect',
389 'interbase' => 'ibase_connect',
134e4174 390 'informix' => 'ifx_connect',
391 'msql' => 'msql_connect',
392 'mssql' => 'mssql_connect',
393 'mysql' => 'mysql_connect',
394 'mysqli' => 'mysqli_connect',
395 'oci8' => 'ocilogon',
396 'odbc' => 'odbc_connect',
7ed4c524 397 'pgsql' => 'pg_connect',
134e4174 398 'sqlite' => 'sqlite_open',
399 'sybase' => 'sybase_connect'
400 );
401
402 $dsns = array();
403 if($prefs_dsn) {
404 $dsns['preferences'] = $prefs_dsn;
405 }
406 if($addrbook_dsn) {
407 $dsns['addressbook'] = $addrbook_dsn;
408 }
409 if($addrbook_global_dsn) {
410 $dsns['global addressbook'] = $addrbook_global_dsn;
411 }
412
413 foreach($dsns as $type => $dsn) {
414 $dbtype = array_shift(explode(':', $dsn));
415 if(isset($db_functions[$dbtype]) && function_exists($db_functions[$dbtype])) {
416 echo "$IND$dbtype database support present.<br />\n";
417
418 // now, test this interface:
419
420 $dbh = DB::connect($dsn, true);
421 if (DB::isError($dbh)) {
422 do_err('Database error: '. htmlspecialchars(DB::errorMessage($dbh)) .
423 ' in ' .$type .' DSN.');
424 }
425 $dbh->disconnect();
426 echo "$IND$type database connect successful.<br />\n";
427
428 } else {
429 do_err($db.' database support not present!');
d18703d3 430 }
134e4174 431 }
432 } else {
8f186a2a 433 $db_error='Required PHP PEAR DB support is not available.'
434 .' Is PEAR installed and is the include path set correctly to find <tt>DB.php</tt>?'
435 .' The include path is now:<tt>' . ini_get('include_path') . '</tt>.';
436 do_err($db_error);
134e4174 437 }
4764a7ff 438} else {
d18703d3 439 echo $IND."not using database functionality.<br />\n";
0ed3bdc3 440}
7562c55b 441
442// LDAP DB tests
443echo "Checking LDAP functions...<br />\n";
444if( empty($ldap_server) ) {
134e4174 445 echo $IND."not using LDAP functionality.<br />\n";
7562c55b 446} else {
d0184454 447 if ( !function_exists('ldap_connect') ) {
7562c55b 448 do_err('Required LDAP support is not available.');
449 } else {
134e4174 450 echo "$IND LDAP support present.<br />\n";
7562c55b 451 foreach ( $ldap_server as $param ) {
452
d0184454 453 $linkid = @ldap_connect($param['host'], (empty($param['port']) ? 389 : $param['port']) );
7562c55b 454
455 if ( $linkid ) {
134e4174 456 echo "$IND LDAP connect to ".$param['host']." successful: ".$linkid."<br />\n";
91e0dccc 457
7562c55b 458 if ( !empty($param['protocol']) &&
459 !ldap_set_option($linkid, LDAP_OPT_PROTOCOL_VERSION, $param['protocol']) ) {
460 do_err('Unable to set LDAP protocol');
91e0dccc 461 }
7562c55b 462
463 if ( empty($param['binddn']) ) {
d0184454 464 $bind = @ldap_bind($linkid);
7562c55b 465 } else {
d0184454 466 $bind = @ldap_bind($param['binddn'], $param['bindpw']);
7562c55b 467 }
468
469 if ( $bind ) {
470 echo "$IND LDAP Bind Successful <br />";
471 } else {
472 do_err('Unable to Bind to LDAP Server');
473 }
91e0dccc 474
d0184454 475 @ldap_close($linkid);
7562c55b 476 } else {
477 do_err('Connection to LDAP failed');
478 }
479 }
480 }
481}
d1ae9d4c 482?>
483
484<p>Congratulations, your SquirrelMail setup looks fine to me!</p>
485
13721b47 486<p><a href="login.php">Login now</a></p>
d1ae9d4c 487
488</body>
489</html>
17fca61d 490<?php
491// vim: et ts=4
07337c9b 492?>