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