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 echo $IND . 'display_errors: ' . ini_get('display_errors') . "<br />\n";
 200
 201 echo $IND . 'error_reporting: ' . ini_get('error_reporting') . "<br />\n";
 202
 203 $safe_mode = ini_get('safe_mode');
 204 if ($safe_mode) {
 205     echo $IND . 'safe_mode: ' . $safe_mode;
 206     if (empty($prefs_dsn) || empty($addrbook_dsn))
 207         echo ' (<font color="red">double check data and attachment directory ownership, etc!</font>)';
 208     if (!empty($addrbook_dsn) || !empty($prefs_dsn) || !empty($addrbook_global_dsn))
 209         echo ' (<font color="red">does PHP have access to database interface?</font>)';
 210     echo "<br />\n";
 211     $safe_mode_exec_dir = ini_get('safe_mode_exec_dir');
 212     echo $IND . 'safe_mode_exec_dir: ' . $safe_mode_exec_dir . "<br />\n";
 213 }
 214
 215 /* register_globals check: test for boolean false and any string that is not equal to 'off' */
 216
 217 if ((bool) ini_get('register_globals') &&
 218     strtolower(ini_get('register_globals'))!='off') {
 219     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);
 220 }
 221
 222
 223 /* variables_order check */
 224
 225 // FIXME(?): Hmm, how do we distinguish between when an ini setting is
 226 //           not available (ini_set() returns empty string) and when
 227 //           the administrator set the value to an empty string?  The
 228 //           latter is sure to be highly rare, so for now, just assume
 229 //           that empty value means the setting isn't even available
 230 //           (could also check PHP version when this setting was implemented)
 231 //           although, we'll also warn the user if it is empty, with
 232 //           a non-fatal error
 233 $variables_order = strtoupper(ini_get('variables_order'));
 234 if (empty($variables_order))
 235     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);
 236 else if (strpos($variables_order, 'G') === FALSE
 237  || strpos($variables_order, 'P') === FALSE
 238  || strpos($variables_order, 'C') === FALSE
 239  || strpos($variables_order, 'S') === FALSE) {
 240     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);
 241 } else {
 242     echo $IND . "variables_order OK: $variables_order.<br />\n";
 243 }
 244
 245
 246 /* gpc_order check (removed from PHP as of v5.0) */
 247
 248 if (!check_php_version(5)) {
 249     // FIXME(?): Hmm, how do we distinguish between when an ini setting is
 250     //           not available (ini_set() returns empty string) and when
 251     //           the administrator set the value to an empty string?  The
 252     //           latter is sure to be highly rare, so for now, just assume
 253     //           that empty value means the setting isn't even available
 254     //           (could also check PHP version when this setting was implemented)
 255     //           although, we'll also warn the user if it is empty, with
 256     //           a non-fatal error
 257     $gpc_order = strtoupper(ini_get('gpc_order'));
 258     if (empty($gpc_order))
 259         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);
 260     else if (strpos($gpc_order, 'G') === FALSE
 261      || strpos($gpc_order, 'P') === FALSE
 262      || strpos($gpc_order, 'C') === FALSE) {
 263         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);
 264     } else {
 265         echo $IND . "gpc_order OK: $gpc_order.<br />\n";
 266     }
 267 }
 268
 269
 270 /* check PHP extensions */
 271
 272 $php_exts = array('session','pcre');
 273 $diff = array_diff($php_exts, get_loaded_extensions());
 274 if(count($diff)) {
 275     do_err('Required PHP extensions missing: '.implode(', ',$diff) );
 276 }
 277
 278 echo $IND . "PHP extensions OK. Dynamic loading is ";
 279
 280 if (!(bool)ini_get('enable_dl') || (bool)ini_get('safe_mode')) {
 281     echo "disabled.<br />\n";
 282 } else {
 283     echo "enabled.<br />\n";
 284 }
 285
 286
 287 /* dangerous php settings */
 288 /**
 289  * mbstring.func_overload allows to replace original string and regexp functions
 290  * with their equivalents from php mbstring extension. It causes problems when
 291  * scripts analyze 8bit strings byte after byte or use 8bit strings in regexp tests.
 292  * Setting can be controlled in php.ini (php 4.2.0), webserver config (php 4.2.0)
 293  * and .htaccess files (php 4.3.5).
 294  */
 295 if (function_exists('mb_internal_encoding') &&
 296     check_php_version(4,2,0) &&
 297     (int)ini_get('mbstring.func_overload')!=0) {
 298     $mb_error='You have enabled mbstring overloading.'
 299         .' It can cause problems with SquirrelMail scripts that rely on single byte string functions.';
 300     do_err($mb_error);
 301 }
 302
 303 /**
 304  * Do not use SquirrelMail with magic_quotes_* on.
 305  */
 306 if ( get_magic_quotes_runtime() || get_magic_quotes_gpc() ||
 307     ( (bool) ini_get('magic_quotes_sybase') && ini_get('magic_quotes_sybase') != 'off' )
 308     ) {
 309     $magic_quotes_warning='You have enabled any one of <tt>magic_quotes_runtime</tt>, '
 310         .'<tt>magic_quotes_gpc</tt> or <tt>magic_quotes_sybase</tt> in your PHP '
 311         .'configuration. We recommend all those settings to be off. SquirrelMail '
 312         .'may work with them on, but when experiencing stray backslashes in your mail '
 313         .'or other strange behaviour, it may be advisable to turn them off.';
 314     do_err($magic_quotes_warning,false);
 315 }
 316
 317 if (ini_get('short_open_tag') == 0) {
 318     $short_open_tag_warning = 'You have configured PHP not to allow short tags '
 319         . '(<tt>short_open_tag=off</tt>). This shouldn\'t be a problem with '
 320         . 'SquirrelMail or any plugin coded coded according to the '
 321         . 'SquirrelMail Coding Guidelines, but if you experience problems with '
 322         . 'PHP code being displayed in some of the pages and changing setting '
 323         . 'to "on" solves the problem, please file a bug report against the '
 324         . 'failing plugin. The correct contact information is most likely '
 325         . 'to be found in the plugin documentation.';
 326     do_err($short_open_tag_warning, false);
 327 }
 328
 329 /* checking paths */
 330
 331 echo "Checking paths...<br />\n";
 332
 333 if(!file_exists($data_dir)) {
 334     // data_dir is not that important in db_setups.
 335     if (!empty($prefs_dsn)) {
 336         $data_dir_error = "Data dir ($data_dir) does not exist!\n";
 337         echo $IND .'<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
 338     } else {
 339         do_err("Data dir ($data_dir) does not exist!");
 340     }
 341 }
 342 // don't check if errors
 343 if(!isset($data_dir_error) && !is_dir($data_dir)) {
 344     if (!empty($prefs_dsn)) {
 345         $data_dir_error = "Data dir ($data_dir) is not a directory!\n";
 346         echo $IND . '<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
 347     } else {
 348         do_err("Data dir ($data_dir) is not a directory!");
 349     }
 350 }
 351 // datadir should be executable - but no clean way to test on that
 352 if(!isset($data_dir_error) && !is_writable($data_dir)) {
 353     if (!empty($prefs_dsn)) {
 354         $data_dir_error = "Data dir ($data_dir) is not writable!\n";
 355         echo $IND . '<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
 356     } else {
 357         do_err("Data dir ($data_dir) is not writable!");
 358     }
 359 }
 360
 361 if (isset($data_dir_error)) {
 362     echo " Some plugins might need access to data directory.<br />\n";
 363 } else {
 364     // todo_ornot: actually write something and read it back.
 365     echo $IND . "Data dir OK.<br />\n";
 366 }
 367
 368 if($data_dir == $attachment_dir) {
 369     echo $IND . "Attachment dir is the same as data dir.<br />\n";
 370     if (isset($data_dir_error)) {
 371         do_err($data_dir_error);
 372     }
 373 } else {
 374     if(!file_exists($attachment_dir)) {
 375         do_err("Attachment dir ($attachment_dir) does not exist!");
 376     }
 377     if (!is_dir($attachment_dir)) {
 378         do_err("Attachment dir ($attachment_dir) is not a directory!");
 379     }
 380     if (!is_writable($attachment_dir)) {
 381         do_err("I cannot write to attachment dir ($attachment_dir)!");
 382     }
 383     echo $IND . "Attachment dir OK.<br />\n";
 384 }
 385
 386
 387 echo "Checking plugins...<br />\n";
 388
 389 /* check plugins and themes */
 390 //FIXME: check requirements given in plugin _info() function, such
 391 //       as required PHP extensions, Pear packages, other plugins, SM version, etc
 392 //       see development docs for list of returned info from that function
 393 $bad_plugins = array(
 394         'attachment_common',      // Integrated into SquirrelMail 1.2 core
 395         'auto_prune_sent',        // Obsolete: See Proon Automatic Folder Pruning plugin
 396         'compose_new_window',     // Integrated into SquirrelMail 1.4 core
 397         'delete_move_next',       // Integrated into SquirrelMail 1.5 core
 398         'disk_quota',             // Obsolete: See Check Quota plugin
 399         'email_priority',         // Integrated into SquirrelMail 1.2 core
 400         'emoticons',              // Obsolete: See HTML Mail plugin
 401         'focus_change',           // Integrated into SquirrelMail 1.2 core
 402         'folder_settings',        // Integrated into SquirrelMail 1.5.1 core
 403         'global_sql_addressbook', // Integrated into SquirrelMail 1.4 core
 404         'hancock',                // Not Working: See Random Signature Taglines plugin
 405         'msg_flags',              // Integrated into SquirrelMail 1.5.1 core
 406         'message_source',         // Added to SquirrelMail 1.4 Core Plugins (message_details)
 407         'motd',                   // Integrated into SquirrelMail 1.2 core
 408         'paginator',              // Integrated into SquirrelMail 1.2 core
 409         'printer_friendly',       // Integrated into SquirrelMail 1.2 core
 410         'procfilter',             // Obsolete: See Server Side Filter plugin
 411         'redhat_php_cgi_fix',     // Integrated into SquirrelMail 1.1.1 core
 412         'send_to_semicolon',      // Integrated into SquirrelMail 1.4.1 core
 413         'spamassassin',           // Not working beyond SquirrelMail 1.2.7: See Spamassassin SpamFilter (Frontend) v2 plugin
 414         'sqcalendar',             // Added to SquirrelMail 1.2 Core Plugins (calendar)
 415         'sqclock',                // Integrated into SquirrelMail 1.2 core
 416         'sql_squirrel_logger',    // Obsolete: See Squirrel Logger plugin
 417         'tmda',                   // Obsolete: See TMDA Tools plugin
 418         'vacation',               // Obsolete: See Vacation Local plugin
 419         'view_as_html',           // Integrated into SquirrelMail 1.5.1 core
 420         'xmailer'                 // Integrated into SquirrelMail 1.2 core
 421         );
 422
 423 if (isset($plugins[0])) {
 424     foreach($plugins as $plugin) {
 425         if(!file_exists(SM_PATH .'plugins/'.$plugin)) {
 426             do_err('You have enabled the <i>'.$plugin.'</i> plugin, but I cannot find it.', FALSE);
 427         } elseif (!is_readable(SM_PATH .'plugins/'.$plugin.'/setup.php')) {
 428             do_err('You have enabled the <i>'.$plugin.'</i> plugin, but I cannot read its setup.php file.', FALSE);
 429         } elseif (in_array($plugin, $bad_plugins)) {
 430             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);
 431         }
 432     }
 433     // load plugin functions
 434     include_once(SM_PATH . 'functions/plugin.php');
 435     // turn on output buffering in order to prevent output of new lines
 436     ob_start();
 437     foreach ($plugins as $name) {
 438         use_plugin($name);
 439     }
 440     // get output and remove whitespace
 441     $output = trim(ob_get_contents());
 442     ob_end_clean();
 443     // if plugins output more than newlines and spacing, stop script execution.
 444     if (!empty($output)) {
 445         $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);
 446         do_err($plugin_load_error);
 447     }
 448     /**
 449      * Print plugin versions
 450      */
 451     echo $IND . "Plugin versions...<br />\n";
 452     foreach ($plugins as $name) {
 453         $plugin_version = get_plugin_version($name);
 454         $english_name = get_plugin_requirement($name, 'english_name');
 455         echo $IND . $IND . (empty($english_name) ? $name . ' ' : $english_name . ' (' . $name . ') ') . (empty($plugin_version) ? '??' : $plugin_version) . "<br />\n";
 456
 457         // check if this plugin has any other plugin
 458         // dependencies and if they are satisfied
 459         //
 460         $failed_dependencies = check_plugin_dependencies($name);
 461         if ($failed_dependencies === SQ_INCOMPATIBLE) {
 462             do_err($name . ' is NOT COMPATIBLE with this version of SquirrelMail', FALSE);
 463         }
 464         else if (is_array($failed_dependencies)) {
 465             $missing_plugins = '';
 466             foreach ($failed_dependencies as $depend_name => $depend_requirements) {
 467                 $missing_plugins .= ', ' . $depend_name . ' (version ' . $depend_requirements['version'] . ', ' . ($depend_requirements['activate'] ? 'must be activated' : 'need not be activated') . ')';
 468             }
 469             do_err($name . ' is missing some dependencies: ' . trim($missing_plugins, ', '), FALSE);
 470         }
 471
 472     }
 473     /**
 474      * This hook was added in 1.5.2 and 1.4.10. Each plugins should print an error
 475      * message and return TRUE if there are any errors in its setup/configuration.
 476      */
 477     $plugin_err = boolean_hook_function('configtest', $null, 1);
 478     if($plugin_err) {
 479         do_err('Some plugin tests failed.');
 480     } else {
 481         echo $IND . "Plugins OK.<br />\n";
 482     }
 483 } else {
 484     echo $IND . "Plugins are not enabled in config.<br />\n";
 485 }
 486 foreach($theme as $thm) {
 487     if(!file_exists($thm['PATH'])) {
 488         do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot find it ('.$thm['PATH'].').', FALSE);
 489     } elseif(!is_readable($thm['PATH'])) {
 490         do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot read it ('.$thm['PATH'].').', FALSE);
 491     }
 492 }
 493
 494 echo $IND . "Themes OK.<br />\n";
 495
 496 if ( $squirrelmail_default_language != 'en_US' ) {
 497     $loc_path = SM_PATH .'locale/'.$squirrelmail_default_language.'/LC_MESSAGES/squirrelmail.mo';
 498     if( ! file_exists( $loc_path ) ) {
 499         do_err('You have set <i>' . $squirrelmail_default_language .
 500                 '</i> as your default language, but I cannot find this translation (should be '.
 501                 'in <tt>' . $loc_path . '</tt>). Please note that you have to download translations '.
 502                 'separately from the main SquirrelMail package.', FALSE);
 503     } elseif ( ! is_readable( $loc_path ) ) {
 504         do_err('You have set <i>' . $squirrelmail_default_language .
 505                 '</i> as your default language, but I cannot read this translation (file '.
 506                 'in <tt>' . $loc_path . '</tt> unreadable).', FALSE);
 507     } else {
 508         echo $IND . "Default language OK.<br />\n";
 509     }
 510 } else {
 511     echo $IND . "Default language OK.<br />\n";
 512 }
 513
 514 echo $IND . "Base URL detected as: <tt>" . htmlspecialchars($test_location) .
 515     "</tt> (location base " . (empty($config_location_base) ? 'autodetected' : 'set to <tt>' .
 516     htmlspecialchars($config_location_base)."</tt>") . ")<br />\n";
 517
 518 /* check minimal requirements for other security options */
 519
 520 /* imaps or ssmtp */
 521 if($use_smtp_tls == 1 || $use_imap_tls == 1) {
 522     if(!check_php_version(4,3,0)) {
 523         do_err('You need at least PHP 4.3.0 for SMTP/IMAP TLS!');
 524     }
 525     if(!extension_loaded('openssl')) {
 526         do_err('You need the openssl PHP extension to use SMTP/IMAP TLS!');
 527     }
 528 }
 529 /* starttls extensions */
 530 if($use_smtp_tls === 2 || $use_imap_tls === 2) {
 531     if (! function_exists('stream_socket_enable_crypto')) {
 532         do_err('If you want to use STARTTLS extension, you need stream_socket_enable_crypto() function from PHP 5.1.0 and newer.');
 533     }
 534 }
 535 /* digest-md5 */
 536 if ($smtp_auth_mech=='digest-md5' || $imap_auth_mech =='digest-md5') {
 537     if (!extension_loaded('xml')) {
 538         do_err('You need the PHP XML extension to use Digest-MD5 authentication!');
 539     }
 540 }
 541
 542 /* check outgoing mail */
 543
 544 echo "Checking outgoing mail service....<br />\n";
 545
 546 if($useSendmail) {
 547     // is_executable also checks for existance, but we want to be as precise as possible with the errors
 548     if(!file_exists($sendmail_path)) {
 549         do_err("Location of sendmail program incorrect ($sendmail_path)!");
 550     }
 551     if(!is_executable($sendmail_path)) {
 552         do_err("I cannot execute the sendmail program ($sendmail_path)!");
 553     }
 554
 555     echo $IND . "sendmail OK<br />\n";
 556 } else {
 557     $stream = fsockopen( ($use_smtp_tls==1?'tls://':'').$smtpServerAddress, $smtpPort,
 558             $errorNumber, $errorString);
 559     if(!$stream) {
 560         do_err("Error connecting to SMTP server \"$smtpServerAddress:$smtpPort\".".
 561                 "Server error: ($errorNumber) ".htmlspecialchars($errorString));
 562     }
 563
 564     // check for SMTP code; should be 2xx to allow us access
 565     $smtpline = fgets($stream, 1024);
 566     if(((int) $smtpline{0}) > 3) {
 567         do_err("Error connecting to SMTP server. Server error: ".
 568                 htmlspecialchars($smtpline));
 569     }
 570
 571     /* smtp starttls checks */
 572     if ($use_smtp_tls===2) {
 573         // if something breaks, script should close smtp connection on exit.
 574
 575         // say helo
 576         fwrite($stream,"EHLO $client_ip\r\n");
 577
 578         $ehlo=array();
 579         $ehlo_error = false;
 580         while ($line=fgets($stream, 1024)){
 581             if (preg_match("/^250(-|\s)(\S*)\s+(\S.*)/",$line,$match)||
 582                     preg_match("/^250(-|\s)(\S*)\s+/",$line,$match)) {
 583                 if (!isset($match[3])) {
 584                     // simple one word extension
 585                     $ehlo[strtoupper($match[2])]='';
 586                 } else {
 587                     // ehlo-keyword + ehlo-param
 588                     $ehlo[strtoupper($match[2])]=trim($match[3]);
 589                 }
 590                 if ($match[1]==' ') {
 591                     $ret = $line;
 592                     break;
 593                 }
 594             } else {
 595                 //
 596                 $ehlo_error = true;
 597                 $ehlo[]=$line;
 598                 break;
 599             }
 600         }
 601         if ($ehlo_error) {
 602             do_err('SMTP EHLO failed. You need ESMTP support for SMTP STARTTLS');
 603         } elseif (!array_key_exists('STARTTLS',$ehlo)) {
 604             do_err('STARTTLS support is not declared by SMTP server.');
 605         }
 606
 607         fwrite($stream,"STARTTLS\r\n");
 608         $starttls_response=fgets($stream, 1024);
 609         if ($starttls_response[0]!=2) {
 610             $starttls_cmd_err = 'SMTP STARTTLS failed. Server replied: '
 611                 .htmlspecialchars($starttls_response);
 612             do_err($starttls_cmd_err);
 613         } elseif(! stream_socket_enable_crypto($stream,true,STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
 614             do_err('Failed to enable encryption on SMTP STARTTLS connection.');
 615         } else {
 616             echo $IND . "SMTP STARTTLS extension looks OK.<br />\n";
 617         }
 618         // According to RFC we should second ehlo call here.
 619     }
 620
 621     fputs($stream, 'QUIT');
 622     fclose($stream);
 623     echo $IND . 'SMTP server OK (<tt><small>'.
 624             trim(htmlspecialchars($smtpline))."</small></tt>)<br />\n";
 625
 626     /* POP before SMTP */
 627     if($pop_before_smtp) {
 628         $stream = fsockopen($smtpServerAddress, 110, $err_no, $err_str);
 629         if (!$stream) {
 630             do_err("Error connecting to POP Server ($smtpServerAddress:110) "
 631                 . $err_no . ' : ' . htmlspecialchars($err_str));
 632         }
 633
 634         $tmp = fgets($stream, 1024);
 635         if (substr($tmp, 0, 3) != '+OK') {
 636             do_err("Error connecting to POP Server ($smtpServerAddress:110)"
 637                 . ' '.htmlspecialchars($tmp));
 638         }
 639         fputs($stream, 'QUIT');
 640         fclose($stream);
 641         echo $IND . "POP-before-SMTP OK.<br />\n";
 642     }
 643 }
 644
 645 /**
 646  * Check the IMAP server
 647  */
 648 echo "Checking IMAP service....<br />\n";
 649
 650 /** Can we open a connection? */
 651 $stream = fsockopen( ($use_imap_tls==1?'tls://':'').$imapServerAddress, $imapPort,
 652         $errorNumber, $errorString);
 653 if(!$stream) {
 654     do_err("Error connecting to IMAP server \"$imapServerAddress:$imapPort\".".
 655             "Server error: ($errorNumber) ".
 656             htmlspecialchars($errorString));
 657 }
 658
 659 /** Is the first response 'OK'? */
 660 $imapline = fgets($stream, 1024);
 661 if(substr($imapline, 0,4) != '* OK') {
 662     do_err('Error connecting to IMAP server. Server error: '.
 663             htmlspecialchars($imapline));
 664 }
 665
 666 echo $IND . 'IMAP server ready (<tt><small>'.
 667     htmlspecialchars(trim($imapline))."</small></tt>)<br />\n";
 668
 669 /** Check capabilities */
 670 fputs($stream, "A001 CAPABILITY\r\n");
 671 $capline = '';
 672 while ($line=fgets($stream, 1024)){
 673     if (preg_match("/A001.*/",$line)) {
 674         break;
 675     } else {
 676         $capline.=$line;
 677     }
 678 }
 679
 680 /* don't display capabilities before STARTTLS */
 681 if ($use_imap_tls===2 && stristr($capline, 'STARTTLS') === false) {
 682     do_err('Your server doesn\'t support STARTTLS.');
 683 } elseif($use_imap_tls===2) {
 684     /* try starting starttls */
 685     fwrite($stream,"A002 STARTTLS\r\n");
 686     $starttls_line=fgets($stream, 1024);
 687     if (! preg_match("/^A002 OK.*/i",$starttls_line)) {
 688         $imap_starttls_err = 'IMAP STARTTLS failed. Server replied: '
 689             .htmlspecialchars($starttls_line);
 690         do_err($imap_starttls_err);
 691     } elseif (! stream_socket_enable_crypto($stream,true,STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
 692         do_err('Failed to enable encryption on IMAP connection.');
 693     } else {
 694         echo $IND . "IMAP STARTTLS extension looks OK.<br />\n";
 695     }
 696
 697     // get new capability line
 698     fwrite($stream,"A003 CAPABILITY\r\n");
 699     $capline='';
 700     while ($line=fgets($stream, 1024)){
 701         if (preg_match("/A003.*/",$line)) {
 702             break;
 703         } else {
 704             $capline.=$line;
 705         }
 706     }
 707 }
 708
 709 echo $IND . 'Capabilities: <tt>'.htmlspecialchars($capline)."</tt><br />\n";
 710
 711 if($imap_auth_mech == 'login' && stristr($capline, 'LOGINDISABLED') !== FALSE) {
 712     do_err('Your server doesn\'t allow plaintext logins. '.
 713             'Try enabling another authentication mechanism like CRAM-MD5, DIGEST-MD5 or TLS-encryption '.
 714             'in the SquirrelMail configuration.', FALSE);
 715 }
 716
 717 if (stristr($capline, 'XMAGICTRASH') !== false) {
 718     $magic_trash = 'It looks like IMAP_MOVE_EXPUNGE_TO_TRASH option is turned on '
 719         .'in your Courier IMAP configuration. Courier does not provide tools that '
 720         .'allow to detect folder used for Trash or commands are not documented. '
 721         .'SquirrelMail can\'t detect special trash folder. SquirrelMail manages '
 722         .'all message deletion or move operations internally and '
 723         .'IMAP_MOVE_EXPUNGE_TO_TRASH option can cause errors in message and '
 724         .'folder management operations. Please turn off IMAP_MOVE_EXPUNGE_TO_TRASH '
 725         .'option in Courier imapd configuration.';
 726     do_err($magic_trash,false);
 727 }
 728
 729 /* add warning about IMAP delivery */
 730 if (stristr($capline, 'XCOURIEROUTBOX') !== false) {
 731     $courier_outbox = 'OUTBOX setting is enabled in your Courier imapd '
 732         .'configuration. SquirrelMail uses standard SMTP protocol or sendmail '
 733         .'binary to send emails. Courier IMAP delivery method is not supported'
 734         .' and can create duplicate email messages.';
 735     do_err($courier_outbox,false);
 736 }
 737
 738 /** OK, close connection */
 739 fputs($stream, "A004 LOGOUT\r\n");
 740 fclose($stream);
 741
 742 echo "Checking internationalization (i18n) settings...<br />\n";
 743 echo "$IND gettext - ";
 744 if (function_exists('gettext')) {
 745     echo 'Gettext functions are available.'
 746         .' On some systems you must have appropriate system locales compiled.'
 747         ."<br />\n";
 748
 749     /* optional setlocale() tests. Should work only on glibc systems. */
 750     if (sqgetGlobalVar('testlocales',$testlocales,SQ_GET)) {
 751         include_once(SM_PATH . 'include/languages.php');
 752         echo $IND . $IND . 'Testing translations:<br>';
 753         foreach ($languages as $lang_code => $lang_data) {
 754             /* don't test aliases */
 755             if (isset($lang_data['NAME'])) {
 756                 /* locale can be $lang_code or $lang_data['LOCALE'] */
 757                 if (isset($lang_data['LOCALE'])) {
 758                     $setlocale = $lang_data['LOCALE'];
 759                 } else {
 760                     $setlocale = $lang_code;
 761                 }
 762                 /* prepare information about tested locales */
 763                 if (is_array($setlocale)) {
 764                     $display_locale = implode(', ',$setlocale);
 765                     $locale_count = count($setlocale);
 766                 } else {
 767                     $display_locale = $setlocale;
 768                     $locale_count = 1;
 769                 }
 770                 $tested_locales_msg = 'Tested '.htmlspecialchars($display_locale).' '
 771                     .($locale_count>1 ? 'locales':'locale'). '.';
 772
 773                 echo $IND . $IND .$IND . $lang_data['NAME'].' (' .$lang_code. ') - ';
 774                 $retlocale = sq_setlocale(LC_ALL,$setlocale);
 775                 if (is_bool($retlocale)) {
 776                     echo '<font color="red">unsupported</font>. ';
 777                     echo $tested_locales_msg;
 778                 } else {
 779                     echo 'supported. '
 780                         .$tested_locales_msg
 781                         .' setlocale() returned "'.htmlspecialchars($retlocale).'"';
 782                 }
 783                 echo "<br />\n";
 784             }
 785         }
 786         echo $IND . $IND . '<a href="configtest.php">Don\'t test translations</a>';
 787     } else {
 788         echo $IND . $IND . '<a href="configtest.php?testlocales=1">Test translations</a>. '
 789             .'This test is not accurate and might work only on some systems.'
 790             ."\n";
 791     }
 792     echo "<br />\n";
 793     /* end of translation tests */
 794 } else {
 795     echo 'Gettext functions are unavailable.'
 796         .' SquirrelMail will use slower internal gettext functions.'
 797         ."<br />\n";
 798 }
 799 echo "$IND mbstring - ";
 800 if (function_exists('mb_detect_encoding')) {
 801     echo "Mbstring functions are available.<br />\n";
 802 } else {
 803     echo 'Mbstring functions are unavailable.'
 804         ." Japanese translation won't work.<br />\n";
 805 }
 806 echo "$IND recode - ";
 807 if (function_exists('recode')) {
 808     echo "Recode functions are available.<br />\n";
 809 } elseif (isset($use_php_recode) && $use_php_recode) {
 810     echo "Recode functions are unavailable.<br />\n";
 811     do_err('Your configuration requires recode support, but recode support is missing.');
 812 } else {
 813     echo "Recode functions are unavailable.<br />\n";
 814 }
 815 echo "$IND iconv - ";
 816 if (function_exists('iconv')) {
 817     echo "Iconv functions are available.<br />\n";
 818 } elseif (isset($use_php_iconv) && $use_php_iconv) {
 819     echo "Iconv functions are unavailable.<br />\n";
 820     do_err('Your configuration requires iconv support, but iconv support is missing.');
 821 } else {
 822     echo "Iconv functions are unavailable.<br />\n";
 823 }
 824 // same test as in include/init.php + date_default_timezone_set check
 825 echo "$IND timezone - ";
 826 if ( (!ini_get('safe_mode')) || function_exists('date_default_timezone_set') ||
 827         !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
 828         preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars')) ) {
 829     echo "Webmail users can change their time zone settings. \n";
 830 } else {
 831     echo "Webmail users can't change their time zone settings. \n";
 832 }
 833 if (isset($_ENV['TZ'])) {
 834     echo 'Default time zone is '.htmlspecialchars($_ENV['TZ']);
 835 } else {
 836     echo 'Current time zone is '.date('T');
 837 }
 838 echo ".<br />\n";
 839
 840 // Pear DB tests
 841 echo "Checking database functions...<br />\n";
 842 if($addrbook_dsn || $prefs_dsn || $addrbook_global_dsn) {
 843     @include_once('DB.php');
 844     if (class_exists('DB')) {
 845         echo "$IND PHP Pear DB support is present.<br />\n";
 846         $db_functions=array(
 847                 'dbase' => 'dbase_open',
 848                 'fbsql' => 'fbsql_connect',
 849                 'interbase' => 'ibase_connect',
 850                 'informix' => 'ifx_connect',
 851                 'msql' => 'msql_connect',
 852                 'mssql' => 'mssql_connect',
 853                 'mysql' => 'mysql_connect',
 854                 'mysqli' => 'mysqli_connect',
 855                 'oci8' => 'ocilogon',
 856                 'odbc' => 'odbc_connect',
 857                 'pgsql' => 'pg_connect',
 858                 'sqlite' => 'sqlite_open',
 859                 'sybase' => 'sybase_connect'
 860                 );
 861
 862         $dsns = array();
 863         if($prefs_dsn) {
 864             $dsns['preferences'] = $prefs_dsn;
 865         }
 866         if($addrbook_dsn) {
 867             $dsns['addressbook'] = $addrbook_dsn;
 868         }
 869         if($addrbook_global_dsn) {
 870             $dsns['global addressbook'] = $addrbook_global_dsn;
 871         }
 872
 873         foreach($dsns as $type => $dsn) {
 874             $aDsn = explode(':', $dsn);
 875             $dbtype = array_shift($aDsn);
 876
 877             if(isset($db_functions[$dbtype]) && function_exists($db_functions[$dbtype])) {
 878                 echo "$IND$dbtype database support present.<br />\n";
 879             } elseif(!(bool)ini_get('enable_dl') || (bool)ini_get('safe_mode')) {
 880                 do_err($dbtype.' database support not present!');
 881             } else {
 882                 // Non-fatal error
 883                 do_err($dbtype.' database support not present or not configured!
 884                     Trying to dynamically load '.$dbtype.' extension.
 885                     Please note that it is advisable to not rely on dynamic loading of extensions.', FALSE);
 886             }
 887
 888
 889             // now, test this interface:
 890
 891             $dbh = DB::connect($dsn, true);
 892             if (DB::isError($dbh)) {
 893                 do_err('Database error: '. htmlspecialchars(DB::errorMessage($dbh)) .
 894                         ' in ' .$type .' DSN.');
 895             }
 896             $dbh->disconnect();
 897             echo "$IND$type database connect successful.<br />\n";
 898         }
 899     } else {
 900         $db_error='Required PHP PEAR DB support is not available.'
 901             .' Is PEAR installed and is the include path set correctly to find <tt>DB.php</tt>?'
 902             .' The include path is now: "<tt>' . ini_get('include_path') . '</tt>".';
 903         do_err($db_error);
 904     }
 905 } else {
 906     echo $IND."not using database functionality.<br />\n";
 907 }
 908
 909 // LDAP DB tests
 910 echo "Checking LDAP functions...<br />\n";
 911 if( empty($ldap_server) ) {
 912     echo $IND."not using LDAP functionality.<br />\n";
 913 } else {
 914     if ( !function_exists('ldap_connect') ) {
 915         do_err('Required LDAP support is not available.');
 916     } else {
 917         echo "$IND LDAP support present.<br />\n";
 918         foreach ( $ldap_server as $param ) {
 919
 920             $linkid = @ldap_connect($param['host'], (empty($param['port']) ? 389 : $param['port']) );
 921
 922             if ( $linkid ) {
 923                 echo "$IND LDAP connect to ".$param['host']." successful: ".$linkid."<br />\n";
 924
 925                 if ( !empty($param['protocol']) &&
 926                         !ldap_set_option($linkid, LDAP_OPT_PROTOCOL_VERSION, $param['protocol']) ) {
 927                     do_err('Unable to set LDAP protocol');
 928                 }
 929
 930                 if ( empty($param['binddn']) ) {
 931                     $bind = @ldap_bind($linkid);
 932                 } else {
 933                     $bind = @ldap_bind($param['binddn'], $param['bindpw']);
 934                 }
 935
 936                 if ( $bind ) {
 937                     echo "$IND LDAP Bind Successful <br />";
 938                 } else {
 939                     do_err('Unable to Bind to LDAP Server');
 940                 }
 941
 942                 @ldap_close($linkid);
 943             } else {
 944                 do_err('Connection to LDAP failed');
 945             }
 946         }
 947     }
 948 }
 949
 950 echo '<hr width="75%" align="center">';
 951 echo '<h2 align="center">Summary</h2>';
 952 $footer = '<hr width="75%" align="center">';
 953 if ($warnings) {
 954     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>';
 955     echo $footer;
 956 } else {
 957     print <<< EOF
 958 <p>Congratulations, your SquirrelMail setup looks fine to me!</p>
 959
 960 <p><a href="login.php">Login now</a></p>
 961
 962 </body>
 963 </html>
 964 EOF;
 965     echo $footer;
 966 }