Replacing tabs with spaces, trimming white space at EOL and newline at EOF (PHP only)
[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
37/*
91e0dccc 38 * Load config before output begins. functions/strings.php depends on
5b53b7e0 39 * functions/globals.php. functions/global.php needs to be run before
91e0dccc 40 * any html output starts. If config.php is missing, error will be displayed
5b53b7e0 41 * later.
42 */
43if (file_exists(SM_PATH . 'config/config.php')) {
44 include(SM_PATH . 'config/config.php');
45 include(SM_PATH . 'functions/strings.php');
46}
d1ae9d4c 47?><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
48<html>
49<head>
50 <title>SquirrelMail configtest</title>
51</head>
52<body>
53<h1>SquirrelMail configtest</h1>
54
55<p>This script will try to check some aspects of your SquirrelMail configuration
56and point you to errors whereever it can find them. You need to go run <tt>conf.pl</tt>
d18703d3 57in the <tt>config/</tt> directory first before you run this script.</p>
d1ae9d4c 58
59<?php
60
d1ae9d4c 61
62$included = array_map('basename', get_included_files() );
63if(!in_array('config.php', $included)) {
64 if(!file_exists(SM_PATH . 'config/config.php')) {
65 do_err('Config file '.SM_PATH . 'config/config.php does not exist!<br />'.
66 'You need to run <tt>conf.pl</tt> first.');
67 }
68 do_err('Could not read '.SM_PATH.'config/config.php! Check file permissions.');
69}
70if(!in_array('strings.php', $included)) {
71 do_err('Could not include '.SM_PATH.'functions/strings.php!<br />'.
72 'Check permissions on that file.');
73}
74
75/* checking PHP specs */
76
17fca61d 77echo "<p><table>\n<tr><td>SquirrelMail version:</td><td><b>" . $version . "</b></td></tr>\n" .
78 '<tr><td>Config file version:</td><td><b>' . $config_version . "</b></td></tr>\n" .
91e0dccc 79 '<tr><td>Config file last modified:</td><td><b>' .
17fca61d 80 date ('d F Y H:i:s', filemtime(SM_PATH . 'config/config.php')) .
81 "</b></td></tr>\n</table>\n</p>\n\n";
d1ae9d4c 82
83echo "Checking PHP configuration...<br />\n";
84
abd74f7d 85if(!check_php_version(4,1,0)) {
86 do_err('Insufficient PHP version: '. PHP_VERSION . '! Minimum required: 4.1.0');
d1ae9d4c 87}
88
17fca61d 89echo $IND . 'PHP version ' . PHP_VERSION . " OK.<br />\n";
d1ae9d4c 90
91$php_exts = array('session','pcre');
92$diff = array_diff($php_exts, get_loaded_extensions());
93if(count($diff)) {
94 do_err('Required PHP extensions missing: '.implode(', ',$diff) );
95}
96
17fca61d 97echo $IND . "PHP extensions OK.<br />\n";
d1ae9d4c 98
99
100/* checking paths */
101
102echo "Checking paths...<br />\n";
103
104if(!file_exists($data_dir)) {
105 do_err("Data dir ($data_dir) does not exist!");
91e0dccc 106}
d1ae9d4c 107if(!is_dir($data_dir)) {
108 do_err("Data dir ($data_dir) is not a directory!");
91e0dccc 109}
d1ae9d4c 110if(!is_readable($data_dir)) {
111 do_err("I cannot read from data dir ($data_dir)!");
91e0dccc 112}
d1ae9d4c 113if(!is_writable($data_dir)) {
114 do_err("I cannot write to data dir ($data_dir)!");
115}
116
117// todo_ornot: actually write something and read it back.
118echo $IND . "Data dir OK.<br />\n";
119
120
121if($data_dir == $attachment_dir) {
122 echo $IND . "Attachment dir is the same as data dir.<br />\n";
123} else {
124 if(!file_exists($attachment_dir)) {
125 do_err("Attachment dir ($attachment_dir) does not exist!");
91e0dccc 126 }
d1ae9d4c 127 if (!is_dir($attachment_dir)) {
128 do_err("Attachment dir ($attachment_dir) is not a directory!");
91e0dccc 129 }
d1ae9d4c 130 if (!is_writable($attachment_dir)) {
131 do_err("I cannot write to attachment dir ($attachment_dir)!");
132 }
133 echo $IND . "Attachment dir OK.<br />\n";
134}
135
136
137/* check plugins and themes */
5b53b7e0 138if (isset($plugins[0])) {
139 foreach($plugins as $plugin) {
140 if(!file_exists(SM_PATH .'plugins/'.$plugin)) {
141 do_err('You have enabled the <i>'.$plugin.'</i> plugin but I cannot find it.', FALSE);
142 } elseif (!is_readable(SM_PATH .'plugins/'.$plugin.'/setup.php')) {
143 do_err('You have enabled the <i>'.$plugin.'</i> plugin but I cannot read its setup.php file.', FALSE);
144 }
d1ae9d4c 145 }
5b53b7e0 146 echo $IND . "Plugins OK.<br />\n";
147} else {
148 echo $IND . "Plugins are not enabled in config.<br />\n";
d1ae9d4c 149}
d1ae9d4c 150foreach($theme as $thm) {
151 if(!file_exists($thm['PATH'])) {
152 do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot find it ('.$thm['PATH'].').', FALSE);
153 } elseif(!is_readable($thm['PATH'])) {
154 do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot read it ('.$thm['PATH'].').', FALSE);
155 }
156}
157
158echo $IND . "Themes OK.<br />\n";
159
23649466 160echo $IND . "Base URL detected as: <tt>" . htmlspecialchars(get_location()) . "</tt><br />\n";
161
d1ae9d4c 162
163/* check outgoing mail */
164
165if($use_smtp_tls || $use_imap_tls) {
166 if(!check_php_version(4,3,0)) {
167 do_err('You need at least PHP 4.3.0 for SMTP/IMAP TLS!');
168 }
169 if(!extension_loaded('openssl')) {
170 do_err('You need the openssl PHP extension to use SMTP/IMAP TLS!');
171 }
172}
173
174echo "Checking outgoing mail service....<br />\n";
175
176if($useSendmail) {
177 // is_executable also checks for existance, but we want to be as precise as possible with the errors
178 if(!file_exists($sendmail_path)) {
179 do_err("Location of sendmail program incorrect ($sendmail_path)!");
91e0dccc 180 }
d1ae9d4c 181 if(!is_executable($sendmail_path)) {
182 do_err("I cannot execute the sendmail program ($sendmail_path)!");
183 }
184
185 echo $IND . "sendmail OK<br />\n";
186} else {
187 $stream = fsockopen( ($use_smtp_tls?'tls://':'').$smtpServerAddress, $smtpPort,
188 $errorNumber, $errorString);
189 if(!$stream) {
190 do_err("Error connecting to SMTP server \"$smtpServerAddress:$smtpPort\".".
9c941728 191 "Server error: ($errorNumber) ".htmlspecialchars($errorString));
d1ae9d4c 192 }
193
194 // check for SMTP code; should be 2xx to allow us access
195 $smtpline = fgets($stream, 1024);
196 if(((int) $smtpline{0}) > 3) {
9c941728 197 do_err("Error connecting to SMTP server. Server error: ".
134e4174 198 htmlspecialchars($smtpline));
d1ae9d4c 199 }
200
201 fputs($stream, 'QUIT');
202 fclose($stream);
9c941728 203 echo $IND . 'SMTP server OK (<tt><small>'.
204 trim(htmlspecialchars($smtpline))."</small></tt>)<br />\n";
d1ae9d4c 205
206 /* POP before SMTP */
207 if($pop_before_smtp) {
208 $stream = fsockopen($smtpServerAddress, 110, $err_no, $err_str);
209 if (!$stream) {
9c941728 210 do_err("Error connecting to POP Server ($smtpServerAddress:110) "
211 . $err_no . ' : ' . htmlspecialchars($err_str));
d1ae9d4c 212 }
213
214 $tmp = fgets($stream, 1024);
215 if (substr($tmp, 0, 3) != '+OK') {
216 do_err("Error connecting to POP Server ($smtpServerAddress:110)"
9c941728 217 . ' '.htmlspecialchars($tmp));
d1ae9d4c 218 }
219 fputs($stream, 'QUIT');
220 fclose($stream);
221 echo $IND . "POP-before-SMTP OK.<br />\n";
222 }
223}
224
df758744 225/**
226 * Check the IMAP server
227 */
d1ae9d4c 228echo "Checking IMAP service....<br />\n";
229
df758744 230/** Can we open a connection? */
d1ae9d4c 231$stream = fsockopen( ($use_imap_tls?'tls://':'').$imapServerAddress, $imapPort,
232 $errorNumber, $errorString);
233if(!$stream) {
70b71161 234 do_err("Error connecting to IMAP server \"$imapServerAddress:$imapPort\".".
9c941728 235 "Server error: ($errorNumber) ".
134e4174 236 htmlspecialchars($errorString));
d1ae9d4c 237}
238
df758744 239/** Is the first response 'OK'? */
d1ae9d4c 240$imapline = fgets($stream, 1024);
241if(substr($imapline, 0,4) != '* OK') {
9c941728 242 do_err('Error connecting to IMAP server. Server error: '.
243 htmlspecialchars($imapline));
d1ae9d4c 244}
245
df758744 246echo $IND . 'IMAP server ready (<tt><small>'.
9c941728 247 htmlspecialchars(trim($imapline))."</small></tt>)<br />\n";
d1ae9d4c 248
df758744 249/** Check capabilities */
250fputs($stream, "A001 CAPABILITY\r\n");
251$capline = fgets($stream, 1024);
252
253echo $IND . 'Capabilities: <tt>'.htmlspecialchars($capline)."</tt><br />\n";
254
255if($imap_auth_mech == 'login' && stristr($capline, 'LOGINDISABLED') !== FALSE) {
256 do_err('Your server doesn\'t allow plaintext logins. '.
257 'Try enabling another authentication mechanism like CRAM-MD5, DIGEST-MD5 or TLS-encryption '.
258 'in the SquirrelMail configuration.', FALSE);
259}
260if($use_imap_tls && stristr($capline, 'STARTTLS') === FALSE) {
261 do_err('You have enabled TLS encryption in the config, but the server does not '.
262 'report STARTTLS capability. TLS is probably not supported.', FALSE);
263}
264
265/** OK, close connection */
266fputs($stream, "A002 LOGOUT\r\n");
267fclose($stream);
268
17fca61d 269echo "Checking internationalization (i18n) settings...<br />\n";
0ed3bdc3 270echo "$IND gettext - ";
271if (function_exists('gettext')) {
272 echo "Gettext functions are available. You must have appropriate system locales compiled.<br />\n";
273} else {
274 echo "Gettext functions are unavailable. SquirrelMail will use slower internal gettext functions.<br />\n";
275}
276echo "$IND mbstring - ";
277if (function_exists('mb_detect_encoding')) {
278 echo "Mbstring functions are available.<br />\n";
279} else {
280 echo "Mbstring functions are unavailable. Japanese translation won't work.<br />\n";
281}
282echo "$IND recode - ";
283if (function_exists('recode')) {
284 echo "Recode functions are available.<br />\n";
285} elseif ($use_php_recode) {
286 echo "Recode functions are unavailable.<br />\n";
287 do_err('Your configuration requires recode support, but recode support is missing.');
288} else {
289 echo "Recode functions are unavailable.<br />\n";
290}
291echo "$IND iconv - ";
292if (function_exists('iconv')) {
293 echo "Iconv functions are available.<br />\n";
294} elseif ($use_php_iconv) {
295 echo "Iconv functions are unavailable.<br />\n";
296 do_err('Your configuration requires iconv support, but iconv support is missing.');
297} else {
298 echo "Iconv functions are unavailable.<br />\n";
299}
300// same test as in include/validate.php
301echo "$IND timezone - ";
302if ( (!ini_get('safe_mode')) ||
303 !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
304 preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars')) ) {
134e4174 305 echo "Webmail users can change their time zone settings.<br />\n";
0ed3bdc3 306} else {
4764a7ff 307 echo "Webmail users can't change their time zone settings.<br />\n";
308}
309
d18703d3 310
4764a7ff 311// Pear DB tests
d18703d3 312echo "Checking database functions...<br />\n";
313if($addrbook_dsn || $prefs_dsn || $addrbook_global_dsn) {
134e4174 314 @include_once('DB.php');
315 if (class_exists('DB')) {
316 echo "$IND PHP Pear DB support is present.<br />\n";
317 $db_functions=array(
91e0dccc 318 'dbase' => 'dbase_open',
319 'fbsql' => 'fbsql_connect',
320 'interbase' => 'ibase_connect',
134e4174 321 'informix' => 'ifx_connect',
322 'msql' => 'msql_connect',
323 'mssql' => 'mssql_connect',
324 'mysql' => 'mysql_connect',
325 'mysqli' => 'mysqli_connect',
326 'oci8' => 'ocilogon',
327 'odbc' => 'odbc_connect',
328 'pgsql' => 'pgsql_connect',
329 'sqlite' => 'sqlite_open',
330 'sybase' => 'sybase_connect'
331 );
332
333 $dsns = array();
334 if($prefs_dsn) {
335 $dsns['preferences'] = $prefs_dsn;
336 }
337 if($addrbook_dsn) {
338 $dsns['addressbook'] = $addrbook_dsn;
339 }
340 if($addrbook_global_dsn) {
341 $dsns['global addressbook'] = $addrbook_global_dsn;
342 }
343
344 foreach($dsns as $type => $dsn) {
345 $dbtype = array_shift(explode(':', $dsn));
346 if(isset($db_functions[$dbtype]) && function_exists($db_functions[$dbtype])) {
347 echo "$IND$dbtype database support present.<br />\n";
348
349 // now, test this interface:
350
351 $dbh = DB::connect($dsn, true);
352 if (DB::isError($dbh)) {
353 do_err('Database error: '. htmlspecialchars(DB::errorMessage($dbh)) .
354 ' in ' .$type .' DSN.');
355 }
356 $dbh->disconnect();
357 echo "$IND$type database connect successful.<br />\n";
358
359 } else {
360 do_err($db.' database support not present!');
d18703d3 361 }
134e4174 362 }
363 } else {
364 do_err('Required PHP PEAR DB support is not available. Is PEAR installed and is the
365 include path set correctly to find <tt>DB.php</tt>? The include path is now:
366 "<tt>' . ini_get('include_path') . '</tt>".');
367 }
4764a7ff 368} else {
d18703d3 369 echo $IND."not using database functionality.<br />\n";
0ed3bdc3 370}
7562c55b 371
372// LDAP DB tests
373echo "Checking LDAP functions...<br />\n";
374if( empty($ldap_server) ) {
134e4174 375 echo $IND."not using LDAP functionality.<br />\n";
7562c55b 376} else {
377 if ( !function_exists(ldap_connect) ) {
378 do_err('Required LDAP support is not available.');
379 } else {
134e4174 380 echo "$IND LDAP support present.<br />\n";
7562c55b 381 foreach ( $ldap_server as $param ) {
382
383 $linkid = ldap_connect($param['host'], (empty($param['port']) ? 389 : $param['port']) );
384
385 if ( $linkid ) {
134e4174 386 echo "$IND LDAP connect to ".$param['host']." successful: ".$linkid."<br />\n";
91e0dccc 387
7562c55b 388 if ( !empty($param['protocol']) &&
389 !ldap_set_option($linkid, LDAP_OPT_PROTOCOL_VERSION, $param['protocol']) ) {
390 do_err('Unable to set LDAP protocol');
91e0dccc 391 }
7562c55b 392
393 if ( empty($param['binddn']) ) {
91e0dccc 394 $bind = ldap_bind($linkid);
7562c55b 395 } else {
396 $bind = ldap_bind($param['binddn'], $param['bindpw']);
397 }
398
399 if ( $bind ) {
400 echo "$IND LDAP Bind Successful <br />";
401 } else {
402 do_err('Unable to Bind to LDAP Server');
403 }
91e0dccc 404
7562c55b 405 ldap_close($linkid);
406 } else {
407 do_err('Connection to LDAP failed');
408 }
409 }
410 }
411}
d1ae9d4c 412?>
413
414<p>Congratulations, your SquirrelMail setup looks fine to me!</p>
415
13721b47 416<p><a href="login.php">Login now</a></p>
d1ae9d4c 417
418</body>
419</html>
17fca61d 420<?php
421// vim: et ts=4
e50f5ac2 422?>