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