src/configtest.php

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