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             $incompatible_plugins = '';
 494             foreach ($failed_dependencies as $depend_name => $depend_requirements) {
 495                 if ($depend_requirements['version'] == SQ_INCOMPATIBLE)
 496                     $incompatible_plugins .= ', ' . $depend_name;
 497                 else
 498                     $missing_plugins .= ', ' . $depend_name . ' (version ' . $depend_requirements['version'] . ', ' . ($depend_requirements['activate'] ? 'must be activated' : 'need not be activated') . ')';
 499             }
 500             $error_string = (!empty($incompatible_plugins) ? $name . ' cannot be activated at the same time as the following plugins: ' . trim($incompatible_plugins, ', ') : '')
 501                           . (!empty($missing_plugins) ? (!empty($incompatible_plugins) ? '.  ' . $name . ' is also ' : $name . ' is ') . 'missing some dependencies: ' . trim($missing_plugins, ', ') : '');
 502             do_err($error_string, FALSE);
 503         }
 504
 505     }
 506
 507
 508     /**
 509      * This hook was added in 1.5.2 and 1.4.10. Each plugins should print an error
 510      * message and return TRUE if there are any errors in its setup/configuration.
 511      */
 512     $plugin_err = boolean_hook_function('configtest', $null, 1);
 513     if($plugin_err) {
 514         do_err('Some plugin tests failed.');
 515     } else {
 516         echo $IND . "Plugins OK.<br />\n";
 517     }
 518 } else {
 519     echo $IND . "Plugins are not enabled in config.<br />\n";
 520 }
 521 foreach($theme as $thm) {
 522     if(!file_exists($thm['PATH'])) {
 523         do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot find it ('.$thm['PATH'].').', FALSE);
 524     } elseif(!is_readable($thm['PATH'])) {
 525         do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot read it ('.$thm['PATH'].').', FALSE);
 526     }
 527 }
 528
 529 echo $IND . "Themes OK.<br />\n";
 530
 531 if ( $squirrelmail_default_language != 'en_US' ) {
 532     $loc_path = SM_PATH .'locale/'.$squirrelmail_default_language.'/LC_MESSAGES/squirrelmail.mo';
 533     if( ! file_exists( $loc_path ) ) {
 534         do_err('You have set <i>' . $squirrelmail_default_language .
 535                 '</i> as your default language, but I cannot find this translation (should be '.
 536                 'in <tt>' . $loc_path . '</tt>). Please note that you have to download translations '.
 537                 'separately from the main SquirrelMail package.', FALSE);
 538     } elseif ( ! is_readable( $loc_path ) ) {
 539         do_err('You have set <i>' . $squirrelmail_default_language .
 540                 '</i> as your default language, but I cannot read this translation (file '.
 541                 'in <tt>' . $loc_path . '</tt> unreadable).', FALSE);
 542     } else {
 543         echo $IND . "Default language OK.<br />\n";
 544     }
 545 } else {
 546     echo $IND . "Default language OK.<br />\n";
 547 }
 548
 549 echo $IND . "Base URL detected as: <tt>" . htmlspecialchars($test_location) .
 550     "</tt> (location base " . (empty($config_location_base) ? 'autodetected' : 'set to <tt>' .
 551     htmlspecialchars($config_location_base)."</tt>") . ")<br />\n";
 552
 553 /* check minimal requirements for other security options */
 554
 555 /* imaps or ssmtp */
 556 if($use_smtp_tls == 1 || $use_imap_tls == 1) {
 557     if(!check_php_version(4,3,0)) {
 558         do_err('You need at least PHP 4.3.0 for SMTP/IMAP TLS!');
 559     }
 560     if(!extension_loaded('openssl')) {
 561         do_err('You need the openssl PHP extension to use SMTP/IMAP TLS!');
 562     }
 563 }
 564 /* starttls extensions */
 565 if($use_smtp_tls === 2 || $use_imap_tls === 2) {
 566     if (! function_exists('stream_socket_enable_crypto')) {
 567         do_err('If you want to use STARTTLS extension, you need stream_socket_enable_crypto() function from PHP 5.1.0 and newer.');
 568     }
 569 }
 570 /* digest-md5 */
 571 if ($smtp_auth_mech=='digest-md5' || $imap_auth_mech =='digest-md5') {
 572     if (!extension_loaded('xml')) {
 573         do_err('You need the PHP XML extension to use Digest-MD5 authentication!');
 574     }
 575 }
 576
 577 /* check outgoing mail */
 578
 579 echo "Checking outgoing mail service....<br />\n";
 580
 581 if($useSendmail) {
 582     // is_executable also checks for existance, but we want to be as precise as possible with the errors
 583     if(!file_exists($sendmail_path)) {
 584         do_err("Location of sendmail program incorrect ($sendmail_path)!");
 585     }
 586     if(!is_executable($sendmail_path)) {
 587         do_err("I cannot execute the sendmail program ($sendmail_path)!");
 588     }
 589
 590     echo $IND . "sendmail OK<br />\n";
 591 } else {
 592     $stream = fsockopen( ($use_smtp_tls==1?'tls://':'').$smtpServerAddress, $smtpPort,
 593             $errorNumber, $errorString);
 594     if(!$stream) {
 595         do_err("Error connecting to SMTP server \"$smtpServerAddress:$smtpPort\".".
 596                 "Server error: ($errorNumber) ".htmlspecialchars($errorString));
 597     }
 598
 599     // check for SMTP code; should be 2xx to allow us access
 600     $smtpline = fgets($stream, 1024);
 601     if(((int) $smtpline{0}) > 3) {
 602         do_err("Error connecting to SMTP server. Server error: ".
 603                 htmlspecialchars($smtpline));
 604     }
 605
 606     /* smtp starttls checks */
 607     if ($use_smtp_tls===2) {
 608         // if something breaks, script should close smtp connection on exit.
 609
 610         // say helo
 611         fwrite($stream,"EHLO $client_ip\r\n");
 612
 613         $ehlo=array();
 614         $ehlo_error = false;
 615         while ($line=fgets($stream, 1024)){
 616             if (preg_match("/^250(-|\s)(\S*)\s+(\S.*)/",$line,$match)||
 617                     preg_match("/^250(-|\s)(\S*)\s+/",$line,$match)) {
 618                 if (!isset($match[3])) {
 619                     // simple one word extension
 620                     $ehlo[strtoupper($match[2])]='';
 621                 } else {
 622                     // ehlo-keyword + ehlo-param
 623                     $ehlo[strtoupper($match[2])]=trim($match[3]);
 624                 }
 625                 if ($match[1]==' ') {
 626                     $ret = $line;
 627                     break;
 628                 }
 629             } else {
 630                 //
 631                 $ehlo_error = true;
 632                 $ehlo[]=$line;
 633                 break;
 634             }
 635         }
 636         if ($ehlo_error) {
 637             do_err('SMTP EHLO failed. You need ESMTP support for SMTP STARTTLS');
 638         } elseif (!array_key_exists('STARTTLS',$ehlo)) {
 639             do_err('STARTTLS support is not declared by SMTP server.');
 640         }
 641
 642         fwrite($stream,"STARTTLS\r\n");
 643         $starttls_response=fgets($stream, 1024);
 644         if ($starttls_response[0]!=2) {
 645             $starttls_cmd_err = 'SMTP STARTTLS failed. Server replied: '
 646                 .htmlspecialchars($starttls_response);
 647             do_err($starttls_cmd_err);
 648         } elseif(! stream_socket_enable_crypto($stream,true,STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
 649             do_err('Failed to enable encryption on SMTP STARTTLS connection.');
 650         } else {
 651             echo $IND . "SMTP STARTTLS extension looks OK.<br />\n";
 652         }
 653         // According to RFC we should second ehlo call here.
 654     }
 655
 656     fputs($stream, 'QUIT');
 657     fclose($stream);
 658     echo $IND . 'SMTP server OK (<tt><small>'.
 659             trim(htmlspecialchars($smtpline))."</small></tt>)<br />\n";
 660
 661     /* POP before SMTP */
 662     if($pop_before_smtp) {
 663         $stream = fsockopen($smtpServerAddress, 110, $err_no, $err_str);
 664         if (!$stream) {
 665             do_err("Error connecting to POP Server ($smtpServerAddress:110) "
 666                 . $err_no . ' : ' . htmlspecialchars($err_str));
 667         }
 668
 669         $tmp = fgets($stream, 1024);
 670         if (substr($tmp, 0, 3) != '+OK') {
 671             do_err("Error connecting to POP Server ($smtpServerAddress:110)"
 672                 . ' '.htmlspecialchars($tmp));
 673         }
 674         fputs($stream, 'QUIT');
 675         fclose($stream);
 676         echo $IND . "POP-before-SMTP OK.<br />\n";
 677     }
 678 }
 679
 680 /**
 681  * Check the IMAP server
 682  */
 683 echo "Checking IMAP service....<br />\n";
 684
 685 /** Can we open a connection? */
 686 $stream = fsockopen( ($use_imap_tls==1?'tls://':'').$imapServerAddress, $imapPort,
 687         $errorNumber, $errorString);
 688 if(!$stream) {
 689     do_err("Error connecting to IMAP server \"$imapServerAddress:$imapPort\".".
 690             "Server error: ($errorNumber) ".
 691             htmlspecialchars($errorString));
 692 }
 693
 694 /** Is the first response 'OK'? */
 695 $imapline = fgets($stream, 1024);
 696 if(substr($imapline, 0,4) != '* OK') {
 697     do_err('Error connecting to IMAP server. Server error: '.
 698             htmlspecialchars($imapline));
 699 }
 700
 701 echo $IND . 'IMAP server ready (<tt><small>'.
 702     htmlspecialchars(trim($imapline))."</small></tt>)<br />\n";
 703
 704 /** Check capabilities */
 705 fputs($stream, "A001 CAPABILITY\r\n");
 706 $capline = '';
 707 while ($line=fgets($stream, 1024)){
 708     if (preg_match("/A001.*/",$line)) {
 709         break;
 710     } else {
 711         $capline.=$line;
 712     }
 713 }
 714
 715 /* don't display capabilities before STARTTLS */
 716 if ($use_imap_tls===2 && stristr($capline, 'STARTTLS') === false) {
 717     do_err('Your server doesn\'t support STARTTLS.');
 718 } elseif($use_imap_tls===2) {
 719     /* try starting starttls */
 720     fwrite($stream,"A002 STARTTLS\r\n");
 721     $starttls_line=fgets($stream, 1024);
 722     if (! preg_match("/^A002 OK.*/i",$starttls_line)) {
 723         $imap_starttls_err = 'IMAP STARTTLS failed. Server replied: '
 724             .htmlspecialchars($starttls_line);
 725         do_err($imap_starttls_err);
 726     } elseif (! stream_socket_enable_crypto($stream,true,STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
 727         do_err('Failed to enable encryption on IMAP connection.');
 728     } else {
 729         echo $IND . "IMAP STARTTLS extension looks OK.<br />\n";
 730     }
 731
 732     // get new capability line
 733     fwrite($stream,"A003 CAPABILITY\r\n");
 734     $capline='';
 735     while ($line=fgets($stream, 1024)){
 736         if (preg_match("/A003.*/",$line)) {
 737             break;
 738         } else {
 739             $capline.=$line;
 740         }
 741     }
 742 }
 743
 744 echo $IND . 'Capabilities: <tt>'.htmlspecialchars($capline)."</tt><br />\n";
 745
 746 if($imap_auth_mech == 'login' && stristr($capline, 'LOGINDISABLED') !== FALSE) {
 747     do_err('Your server doesn\'t allow plaintext logins. '.
 748             'Try enabling another authentication mechanism like CRAM-MD5, DIGEST-MD5 or TLS-encryption '.
 749             'in the SquirrelMail configuration.', FALSE);
 750 }
 751
 752 if (stristr($capline, 'XMAGICTRASH') !== false) {
 753     $magic_trash = 'It looks like IMAP_MOVE_EXPUNGE_TO_TRASH option is turned on '
 754         .'in your Courier IMAP configuration. Courier does not provide tools that '
 755         .'allow to detect folder used for Trash or commands are not documented. '
 756         .'SquirrelMail can\'t detect special trash folder. SquirrelMail manages '
 757         .'all message deletion or move operations internally and '
 758         .'IMAP_MOVE_EXPUNGE_TO_TRASH option can cause errors in message and '
 759         .'folder management operations. Please turn off IMAP_MOVE_EXPUNGE_TO_TRASH '
 760         .'option in Courier imapd configuration.';
 761     do_err($magic_trash,false);
 762 }
 763
 764 /* add warning about IMAP delivery */
 765 if (stristr($capline, 'XCOURIEROUTBOX') !== false) {
 766     $courier_outbox = 'OUTBOX setting is enabled in your Courier imapd '
 767         .'configuration. SquirrelMail uses standard SMTP protocol or sendmail '
 768         .'binary to send emails. Courier IMAP delivery method is not supported'
 769         .' and can create duplicate email messages.';
 770     do_err($courier_outbox,false);
 771 }
 772
 773 /** OK, close connection */
 774 fputs($stream, "A004 LOGOUT\r\n");
 775 fclose($stream);
 776
 777 echo "Checking internationalization (i18n) settings...<br />\n";
 778 echo "$IND gettext - ";
 779 if (function_exists('gettext')) {
 780     echo 'Gettext functions are available.'
 781         .' On some systems you must have appropriate system locales compiled.'
 782         ."<br />\n";
 783
 784     /* optional setlocale() tests. Should work only on glibc systems. */
 785     if (sqgetGlobalVar('testlocales',$testlocales,SQ_GET)) {
 786         include_once(SM_PATH . 'include/languages.php');
 787         echo $IND . $IND . 'Testing translations:<br>';
 788         foreach ($languages as $lang_code => $lang_data) {
 789             /* don't test aliases */
 790             if (isset($lang_data['NAME'])) {
 791                 /* locale can be $lang_code or $lang_data['LOCALE'] */
 792                 if (isset($lang_data['LOCALE'])) {
 793                     $setlocale = $lang_data['LOCALE'];
 794                 } else {
 795                     $setlocale = $lang_code;
 796                 }
 797                 /* prepare information about tested locales */
 798                 if (is_array($setlocale)) {
 799                     $display_locale = implode(', ',$setlocale);
 800                     $locale_count = count($setlocale);
 801                 } else {
 802                     $display_locale = $setlocale;
 803                     $locale_count = 1;
 804                 }
 805                 $tested_locales_msg = 'Tested '.htmlspecialchars($display_locale).' '
 806                     .($locale_count>1 ? 'locales':'locale'). '.';
 807
 808                 echo $IND . $IND .$IND . $lang_data['NAME'].' (' .$lang_code. ') - ';
 809                 $retlocale = sq_setlocale(LC_ALL,$setlocale);
 810                 if (is_bool($retlocale)) {
 811                     echo '<font color="red">unsupported</font>. ';
 812                     echo $tested_locales_msg;
 813                 } else {
 814                     echo 'supported. '
 815                         .$tested_locales_msg
 816                         .' setlocale() returned "'.htmlspecialchars($retlocale).'"';
 817                 }
 818                 echo "<br />\n";
 819             }
 820         }
 821         echo $IND . $IND . '<a href="configtest.php">Don\'t test translations</a>';
 822     } else {
 823         echo $IND . $IND . '<a href="configtest.php?testlocales=1">Test translations</a>. '
 824             .'This test is not accurate and might work only on some systems.'
 825             ."\n";
 826     }
 827     echo "<br />\n";
 828     /* end of translation tests */
 829 } else {
 830     echo 'Gettext functions are unavailable.'
 831         .' SquirrelMail will use slower internal gettext functions.'
 832         ."<br />\n";
 833 }
 834 echo "$IND mbstring - ";
 835 if (function_exists('mb_detect_encoding')) {
 836     echo "Mbstring functions are available.<br />\n";
 837 } else {
 838     echo 'Mbstring functions are unavailable.'
 839         ." Japanese translation won't work.<br />\n";
 840 }
 841 echo "$IND recode - ";
 842 if (function_exists('recode')) {
 843     echo "Recode functions are available.<br />\n";
 844 } elseif (isset($use_php_recode) && $use_php_recode) {
 845     echo "Recode functions are unavailable.<br />\n";
 846     do_err('Your configuration requires recode support, but recode support is missing.');
 847 } else {
 848     echo "Recode functions are unavailable.<br />\n";
 849 }
 850 echo "$IND iconv - ";
 851 if (function_exists('iconv')) {
 852     echo "Iconv functions are available.<br />\n";
 853 } elseif (isset($use_php_iconv) && $use_php_iconv) {
 854     echo "Iconv functions are unavailable.<br />\n";
 855     do_err('Your configuration requires iconv support, but iconv support is missing.');
 856 } else {
 857     echo "Iconv functions are unavailable.<br />\n";
 858 }
 859 // same test as in include/init.php + date_default_timezone_set check
 860 echo "$IND timezone - ";
 861 if ( (!ini_get('safe_mode')) || function_exists('date_default_timezone_set') ||
 862         !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
 863         preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars')) ) {
 864     echo "Webmail users can change their time zone settings. \n";
 865 } else {
 866     echo "Webmail users can't change their time zone settings. \n";
 867 }
 868 if (isset($_ENV['TZ'])) {
 869     echo 'Default time zone is '.htmlspecialchars($_ENV['TZ']);
 870 } else {
 871     echo 'Current time zone is '.date('T');
 872 }
 873 echo ".<br />\n";
 874
 875 // Pear DB tests
 876 echo "Checking database functions...<br />\n";
 877 if($addrbook_dsn || $prefs_dsn || $addrbook_global_dsn) {
 878     @include_once('DB.php');
 879     if (class_exists('DB')) {
 880         echo "$IND PHP Pear DB support is present.<br />\n";
 881         $db_functions=array(
 882                 'dbase' => 'dbase_open',
 883                 'fbsql' => 'fbsql_connect',
 884                 'interbase' => 'ibase_connect',
 885                 'informix' => 'ifx_connect',
 886                 'msql' => 'msql_connect',
 887                 'mssql' => 'mssql_connect',
 888                 'mysql' => 'mysql_connect',
 889                 'mysqli' => 'mysqli_connect',
 890                 'oci8' => 'ocilogon',
 891                 'odbc' => 'odbc_connect',
 892                 'pgsql' => 'pg_connect',
 893                 'sqlite' => 'sqlite_open',
 894                 'sybase' => 'sybase_connect'
 895                 );
 896
 897         $dsns = array();
 898         if($prefs_dsn) {
 899             $dsns['preferences'] = $prefs_dsn;
 900         }
 901         if($addrbook_dsn) {
 902             $dsns['addressbook'] = $addrbook_dsn;
 903         }
 904         if($addrbook_global_dsn) {
 905             $dsns['global addressbook'] = $addrbook_global_dsn;
 906         }
 907
 908         foreach($dsns as $type => $dsn) {
 909             $aDsn = explode(':', $dsn);
 910             $dbtype = array_shift($aDsn);
 911
 912             if(isset($db_functions[$dbtype]) && function_exists($db_functions[$dbtype])) {
 913                 echo "$IND$dbtype database support present.<br />\n";
 914             } elseif(!(bool)ini_get('enable_dl') || (bool)ini_get('safe_mode')) {
 915                 do_err($dbtype.' database support not present!');
 916             } else {
 917                 // Non-fatal error
 918                 do_err($dbtype.' database support not present or not configured!
 919                     Trying to dynamically load '.$dbtype.' extension.
 920                     Please note that it is advisable to not rely on dynamic loading of extensions.', FALSE);
 921             }
 922
 923
 924             // now, test this interface:
 925
 926             $dbh = DB::connect($dsn, true);
 927             if (DB::isError($dbh)) {
 928                 do_err('Database error: '. htmlspecialchars(DB::errorMessage($dbh)) .
 929                         ' in ' .$type .' DSN.');
 930             }
 931             $dbh->disconnect();
 932             echo "$IND$type database connect successful.<br />\n";
 933         }
 934     } else {
 935         $db_error='Required PHP PEAR DB support is not available.'
 936             .' Is PEAR installed and is the include path set correctly to find <tt>DB.php</tt>?'
 937             .' The include path is now: "<tt>' . ini_get('include_path') . '</tt>".';
 938         do_err($db_error);
 939     }
 940 } else {
 941     echo $IND."not using database functionality.<br />\n";
 942 }
 943
 944 // LDAP DB tests
 945 echo "Checking LDAP functions...<br />\n";
 946 if( empty($ldap_server) ) {
 947     echo $IND."not using LDAP functionality.<br />\n";
 948 } else {
 949     if ( !function_exists('ldap_connect') ) {
 950         do_err('Required LDAP support is not available.');
 951     } else {
 952         echo "$IND LDAP support present.<br />\n";
 953         foreach ( $ldap_server as $param ) {
 954
 955             $linkid = @ldap_connect($param['host'], (empty($param['port']) ? 389 : $param['port']) );
 956
 957             if ( $linkid ) {
 958                 echo "$IND LDAP connect to ".$param['host']." successful: ".$linkid."<br />\n";
 959
 960                 if ( !empty($param['protocol']) &&
 961                         !ldap_set_option($linkid, LDAP_OPT_PROTOCOL_VERSION, $param['protocol']) ) {
 962                     do_err('Unable to set LDAP protocol');
 963                 }
 964
 965                 if ( empty($param['binddn']) ) {
 966                     $bind = @ldap_bind($linkid);
 967                 } else {
 968                     $bind = @ldap_bind($param['binddn'], $param['bindpw']);
 969                 }
 970
 971                 if ( $bind ) {
 972                     echo "$IND LDAP Bind Successful <br />";
 973                 } else {
 974                     do_err('Unable to Bind to LDAP Server');
 975                 }
 976
 977                 @ldap_close($linkid);
 978             } else {
 979                 do_err('Connection to LDAP failed');
 980             }
 981         }
 982     }
 983 }
 984
 985 echo '<hr width="75%" align="center">';
 986 echo '<h2 align="center">Summary</h2>';
 987 $footer = '<hr width="75%" align="center">';
 988 if ($warnings) {
 989     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>';
 990     echo $footer;
 991 } else {
 992     print <<< EOF
 993 <p>Congratulations, your SquirrelMail setup looks fine to me!</p>
 994
 995 <p><a href="login.php">Login now</a></p>
 996
 997 </body>
 998 </html>
 999 EOF;
1000     echo $footer;
1001 }