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