src/configtest.php

   1 <?php
   2
   3 /**
   4  * SquirrelMail configtest script
   5  *
   6  * Copyright (c) 2003-2005 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * @version $Id$
  10  * @package squirrelmail
  11  * @subpackage config
  12  */
  13
  14 /************************************************************
  15  * NOTE: you do not need to change this script!             *
  16  * If it throws errors you need to adjust your config.      *
  17  ************************************************************/
  18
  19 // This script could really use some restructuring as it has grown quite rapidly
  20 // but is not very 'clean'. Feel free to get some structure into this thing.
  21
  22 function do_err($str, $exit = TRUE) {
  23     global $IND;
  24     echo '<p>'.$IND.'<font color="red"><b>ERROR:</b></font> ' .$str. "</p>\n";
  25     if($exit) {
  26          echo '</body></html>';
  27          exit;
  28     }
  29 }
  30
  31 $IND = str_repeat('&nbsp;',4);
  32
  33 ob_implicit_flush();
  34 /** @ignore */
  35 define('SM_PATH', '../');
  36
  37 /* set default value in order to block remote access to script */
  38 $allow_remote_configtest=false;
  39
  40 /*
  41  * Load config before output begins. functions/strings.php depends on
  42  * functions/globals.php. functions/global.php needs to be run before
  43  * any html output starts. If config.php is missing, error will be displayed
  44  * later.
  45  */
  46 if (file_exists(SM_PATH . 'config/config.php')) {
  47     include(SM_PATH . 'config/config.php');
  48     include(SM_PATH . 'functions/strings.php');
  49 }
  50 ?><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  51 <html>
  52 <head>
  53     <title>SquirrelMail configtest</title>
  54 </head>
  55 <body>
  56 <h1>SquirrelMail configtest</h1>
  57
  58 <p>This script will try to check some aspects of your SquirrelMail configuration
  59 and point you to errors whereever it can find them. You need to go run <tt>conf.pl</tt>
  60 in the <tt>config/</tt> directory first before you run this script.</p>
  61
  62 <?php
  63
  64 $included = array_map('basename', get_included_files() );
  65 if(!in_array('config.php', $included)) {
  66     if(!file_exists(SM_PATH . 'config/config.php')) {
  67         do_err('Config file '.SM_PATH . 'config/config.php does not exist!<br />'.
  68                'You need to run <tt>conf.pl</tt> first.');
  69     }
  70     do_err('Could not read '.SM_PATH.'config/config.php! Check file permissions.');
  71 }
  72 if(!in_array('strings.php', $included)) {
  73     do_err('Could not include '.SM_PATH.'functions/strings.php!<br />'.
  74            'Check permissions on that file.');
  75 }
  76
  77 /* Block remote use of script */
  78 if (! $allow_remote_configtest) {
  79     sqGetGlobalVar('REMOTE_ADDR',$client_ip,SQ_SERVER);
  80     if (! isset($client_ip) || $client_ip!='127.0.0.1') {
  81         do_err('Enable "Allow remote configtest" option in squirrelmail configuration in order to use this script.');
  82     }
  83 }
  84 /* checking PHP specs */
  85
  86 echo "<p><table>\n<tr><td>SquirrelMail version:</td><td><b>" . $version . "</b></td></tr>\n" .
  87      '<tr><td>Config file version:</td><td><b>' . $config_version . "</b></td></tr>\n" .
  88      '<tr><td>Config file last modified:</td><td><b>' .
  89          date ('d F Y H:i:s', filemtime(SM_PATH . 'config/config.php')) .
  90          "</b></td></tr>\n</table>\n</p>\n\n";
  91
  92 echo "Checking PHP configuration...<br />\n";
  93
  94 if(!check_php_version(4,1,0)) {
  95     do_err('Insufficient PHP version: '. PHP_VERSION . '! Minimum required: 4.1.0');
  96 }
  97
  98 echo $IND . 'PHP version ' . PHP_VERSION . " OK.<br />\n";
  99
 100 $php_exts = array('session','pcre');
 101 $diff = array_diff($php_exts, get_loaded_extensions());
 102 if(count($diff)) {
 103     do_err('Required PHP extensions missing: '.implode(', ',$diff) );
 104 }
 105
 106 echo $IND . "PHP extensions OK.<br />\n";
 107
 108 /* dangerous php settings */
 109 /**
 110  * mbstring.func_overload allows to replace original string and regexp functions
 111  * with their equivalents from php mbstring extension. It causes problems when
 112  * scripts analyze 8bit strings byte after byte or use 8bit strings in regexp tests.
 113  * Setting can be controlled in php.ini (php 4.2.0), webserver config (php 4.2.0)
 114  * and .htaccess files (php 4.3.5).
 115  */
 116 if (function_exists('mb_internal_encoding') &&
 117     check_php_version(4,2,0) &&
 118     (int)ini_get('mbstring.func_overload')!=0) {
 119     $mb_error='You have enabled mbstring overloading.'
 120         .' It can cause problems with SquirrelMail scripts that rely on single byte string functions.';
 121     do_err($mb_error);
 122 }
 123
 124 /* checking paths */
 125
 126 echo "Checking paths...<br />\n";
 127
 128 if(!file_exists($data_dir)) {
 129     // data_dir is not that important in db_setups.
 130     if (isset($prefs_dsn) && ! empty($prefs_dsn)) {
 131         $data_dir_error = "Data dir ($data_dir) does not exist!\n";
 132         echo $IND .'<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
 133     } else {
 134         do_err("Data dir ($data_dir) does not exist!");
 135     }
 136 }
 137 // don't check if errors
 138 if(!isset($data_dir_error) && !is_dir($data_dir)) {
 139     if (isset($prefs_dsn) && ! empty($prefs_dsn)) {
 140         $data_dir_error = "Data dir ($data_dir) is not a directory!\n";
 141         echo $IND . '<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
 142     } else {
 143         do_err("Data dir ($data_dir) is not a directory!");
 144     }
 145 }
 146 // datadir should be executable - but no clean way to test on that
 147 if(!isset($data_dir_error) && !is_writable($data_dir)) {
 148     if (isset($prefs_dsn) && ! empty($prefs_dsn)) {
 149         $data_dir_error = "Data dir ($data_dir) is not writable!\n";
 150         echo $IND . '<font color="red"><b>ERROR:</b></font> ' . $data_dir_error;
 151     } else {
 152         do_err("Data dir ($data_dir) is not writable!");
 153     }
 154 }
 155
 156 if (isset($data_dir_error)) {
 157     echo " Some plugins might need access to data directory.<br />\n";
 158 } else {
 159     // todo_ornot: actually write something and read it back.
 160     echo $IND . "Data dir OK.<br />\n";
 161 }
 162
 163 if($data_dir == $attachment_dir) {
 164     echo $IND . "Attachment dir is the same as data dir.<br />\n";
 165     if (isset($data_dir_error)) {
 166         do_err($data_dir_error);
 167     }
 168 } else {
 169     if(!file_exists($attachment_dir)) {
 170         do_err("Attachment dir ($attachment_dir) does not exist!");
 171     }
 172     if (!is_dir($attachment_dir)) {
 173         do_err("Attachment dir ($attachment_dir) is not a directory!");
 174     }
 175     if (!is_writable($attachment_dir)) {
 176         do_err("I cannot write to attachment dir ($attachment_dir)!");
 177     }
 178     echo $IND . "Attachment dir OK.<br />\n";
 179 }
 180
 181
 182 /* check plugins and themes */
 183 if (isset($plugins[0])) {
 184     foreach($plugins as $plugin) {
 185         if(!file_exists(SM_PATH .'plugins/'.$plugin)) {
 186             do_err('You have enabled the <i>'.$plugin.'</i> plugin but I cannot find it.', FALSE);
 187         } elseif (!is_readable(SM_PATH .'plugins/'.$plugin.'/setup.php')) {
 188             do_err('You have enabled the <i>'.$plugin.'</i> plugin but I cannot read its setup.php file.', FALSE);
 189         }
 190     }
 191     echo $IND . "Plugins OK.<br />\n";
 192 } else {
 193     echo $IND . "Plugins are not enabled in config.<br />\n";
 194 }
 195 foreach($theme as $thm) {
 196     if(!file_exists($thm['PATH'])) {
 197         do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot find it ('.$thm['PATH'].').', FALSE);
 198     } elseif(!is_readable($thm['PATH'])) {
 199         do_err('You have enabled the <i>'.$thm['NAME'].'</i> theme but I cannot read it ('.$thm['PATH'].').', FALSE);
 200     }
 201 }
 202
 203 echo $IND . "Themes OK.<br />\n";
 204
 205 if ( $squirrelmail_default_language != 'en_US' ) {
 206     $loc_path = SM_PATH .'locale/'.$squirrelmail_default_language.'/LC_MESSAGES/squirrelmail.mo';
 207     if( ! file_exists( $loc_path ) ) {
 208         do_err('You have set <i>' . $squirrelmail_default_language .
 209             '</i> as your default language, but I cannot find this translation (should be '.
 210             'in <tt>' . $loc_path . '</tt>). Please note that you have to download translations '.
 211             'separately from the main SquirrelMail package.', FALSE);
 212     } elseif ( ! is_readable( $loc_path ) ) {
 213         do_err('You have set <i>' . $squirrelmail_default_language .
 214             '</i> as your default language, but I cannot read this translation (file '.
 215             'in <tt>' . $loc_path . '</tt> unreadable).', FALSE);
 216     } else {
 217         echo $IND . "Default language OK.<br />\n";
 218     }
 219 } else {
 220     echo $IND . "Default language OK.<br />\n";
 221 }
 222
 223 echo $IND . "Base URL detected as: <tt>" . htmlspecialchars(get_location()) . "</tt><br />\n";
 224
 225
 226 /* check outgoing mail */
 227
 228 if($use_smtp_tls || $use_imap_tls) {
 229     if(!check_php_version(4,3,0)) {
 230         do_err('You need at least PHP 4.3.0 for SMTP/IMAP TLS!');
 231     }
 232     if(!extension_loaded('openssl')) {
 233         do_err('You need the openssl PHP extension to use SMTP/IMAP TLS!');
 234     }
 235 }
 236
 237 echo "Checking outgoing mail service....<br />\n";
 238
 239 if($useSendmail) {
 240     // is_executable also checks for existance, but we want to be as precise as possible with the errors
 241     if(!file_exists($sendmail_path)) {
 242         do_err("Location of sendmail program incorrect ($sendmail_path)!");
 243     }
 244     if(!is_executable($sendmail_path)) {
 245         do_err("I cannot execute the sendmail program ($sendmail_path)!");
 246     }
 247
 248     echo $IND . "sendmail OK<br />\n";
 249 } else {
 250     $stream = fsockopen( ($use_smtp_tls?'tls://':'').$smtpServerAddress, $smtpPort,
 251                         $errorNumber, $errorString);
 252     if(!$stream) {
 253         do_err("Error connecting to SMTP server \"$smtpServerAddress:$smtpPort\".".
 254             "Server error: ($errorNumber) ".htmlspecialchars($errorString));
 255     }
 256
 257     // check for SMTP code; should be 2xx to allow us access
 258     $smtpline = fgets($stream, 1024);
 259     if(((int) $smtpline{0}) > 3) {
 260         do_err("Error connecting to SMTP server. Server error: ".
 261         htmlspecialchars($smtpline));
 262     }
 263
 264     fputs($stream, 'QUIT');
 265     fclose($stream);
 266     echo $IND . 'SMTP server OK (<tt><small>'.
 267         trim(htmlspecialchars($smtpline))."</small></tt>)<br />\n";
 268
 269     /* POP before SMTP */
 270     if($pop_before_smtp) {
 271         $stream = fsockopen($smtpServerAddress, 110, $err_no, $err_str);
 272         if (!$stream) {
 273             do_err("Error connecting to POP Server ($smtpServerAddress:110) "
 274                   . $err_no . ' : ' . htmlspecialchars($err_str));
 275         }
 276
 277         $tmp = fgets($stream, 1024);
 278         if (substr($tmp, 0, 3) != '+OK') {
 279             do_err("Error connecting to POP Server ($smtpServerAddress:110)"
 280                   . ' '.htmlspecialchars($tmp));
 281         }
 282         fputs($stream, 'QUIT');
 283         fclose($stream);
 284         echo $IND . "POP-before-SMTP OK.<br />\n";
 285     }
 286 }
 287
 288 /**
 289  * Check the IMAP server
 290  */
 291 echo "Checking IMAP service....<br />\n";
 292
 293 /** Can we open a connection? */
 294 $stream = fsockopen( ($use_imap_tls?'tls://':'').$imapServerAddress, $imapPort,
 295                        $errorNumber, $errorString);
 296 if(!$stream) {
 297     do_err("Error connecting to IMAP server \"$imapServerAddress:$imapPort\".".
 298         "Server error: ($errorNumber) ".
 299     htmlspecialchars($errorString));
 300 }
 301
 302 /** Is the first response 'OK'? */
 303 $imapline = fgets($stream, 1024);
 304 if(substr($imapline, 0,4) != '* OK') {
 305    do_err('Error connecting to IMAP server. Server error: '.
 306        htmlspecialchars($imapline));
 307 }
 308
 309 echo $IND . 'IMAP server ready (<tt><small>'.
 310     htmlspecialchars(trim($imapline))."</small></tt>)<br />\n";
 311
 312 /** Check capabilities */
 313 fputs($stream, "A001 CAPABILITY\r\n");
 314 $capline = fgets($stream, 1024);
 315
 316 echo $IND . 'Capabilities: <tt>'.htmlspecialchars($capline)."</tt><br />\n";
 317
 318 if($imap_auth_mech == 'login' && stristr($capline, 'LOGINDISABLED') !== FALSE) {
 319     do_err('Your server doesn\'t allow plaintext logins. '.
 320         'Try enabling another authentication mechanism like CRAM-MD5, DIGEST-MD5 or TLS-encryption '.
 321         'in the SquirrelMail configuration.', FALSE);
 322 }
 323 if($use_imap_tls && stristr($capline, 'STARTTLS') === FALSE) {
 324     do_err('You have enabled TLS encryption in the config, but the server does not '.
 325         'report STARTTLS capability. TLS is probably not supported.', FALSE);
 326 }
 327
 328 /** OK, close connection */
 329 fputs($stream, "A002 LOGOUT\r\n");
 330 fclose($stream);
 331
 332 echo "Checking internationalization (i18n) settings...<br />\n";
 333 echo "$IND gettext - ";
 334 if (function_exists('gettext')) {
 335     echo 'Gettext functions are available.'
 336         .' On some systems you must have appropriate system locales compiled.'
 337         ."<br />\n";
 338 } else {
 339     echo 'Gettext functions are unavailable.'
 340         .' SquirrelMail will use slower internal gettext functions.'
 341         ."<br />\n";
 342 }
 343 echo "$IND mbstring - ";
 344 if (function_exists('mb_detect_encoding')) {
 345     echo "Mbstring functions are available.<br />\n";
 346 } else {
 347     echo 'Mbstring functions are unavailable.'
 348         ." Japanese translation won't work.<br />\n";
 349 }
 350 echo "$IND recode - ";
 351 if (function_exists('recode')) {
 352     echo "Recode functions are available.<br />\n";
 353 } elseif ($use_php_recode) {
 354     echo "Recode functions are unavailable.<br />\n";
 355     do_err('Your configuration requires recode support, but recode support is missing.');
 356 } else {
 357     echo "Recode functions are unavailable.<br />\n";
 358 }
 359 echo "$IND iconv - ";
 360 if (function_exists('iconv')) {
 361     echo "Iconv functions are available.<br />\n";
 362 } elseif ($use_php_iconv) {
 363     echo "Iconv functions are unavailable.<br />\n";
 364     do_err('Your configuration requires iconv support, but iconv support is missing.');
 365 } else {
 366     echo "Iconv functions are unavailable.<br />\n";
 367 }
 368 // same test as in include/validate.php
 369 echo "$IND timezone - ";
 370 if ( (!ini_get('safe_mode')) ||
 371     !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
 372     preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars')) ) {
 373         echo "Webmail users can change their time zone settings.<br />\n";
 374 } else {
 375     echo "Webmail users can't change their time zone settings.<br />\n";
 376 }
 377
 378
 379 // Pear DB tests
 380 echo "Checking database functions...<br />\n";
 381 if($addrbook_dsn || $prefs_dsn || $addrbook_global_dsn) {
 382     @include_once('DB.php');
 383     if (class_exists('DB')) {
 384         echo "$IND PHP Pear DB support is present.<br />\n";
 385         $db_functions=array(
 386             'dbase' => 'dbase_open',
 387             'fbsql' => 'fbsql_connect',
 388             'interbase' => 'ibase_connect',
 389             'informix' => 'ifx_connect',
 390             'msql' => 'msql_connect',
 391             'mssql' => 'mssql_connect',
 392             'mysql' => 'mysql_connect',
 393             'mysqli' => 'mysqli_connect',
 394             'oci8' => 'ocilogon',
 395             'odbc' => 'odbc_connect',
 396             'pgsql' => 'pg_connect',
 397             'sqlite' => 'sqlite_open',
 398             'sybase' => 'sybase_connect'
 399             );
 400
 401         $dsns = array();
 402         if($prefs_dsn) {
 403             $dsns['preferences'] = $prefs_dsn;
 404         }
 405         if($addrbook_dsn) {
 406             $dsns['addressbook'] = $addrbook_dsn;
 407         }
 408         if($addrbook_global_dsn) {
 409             $dsns['global addressbook'] = $addrbook_global_dsn;
 410         }
 411
 412         foreach($dsns as $type => $dsn) {
 413             $dbtype = array_shift(explode(':', $dsn));
 414             if(isset($db_functions[$dbtype]) && function_exists($db_functions[$dbtype])) {
 415                 echo "$IND$dbtype database support present.<br />\n";
 416
 417                 // now, test this interface:
 418
 419                 $dbh = DB::connect($dsn, true);
 420                 if (DB::isError($dbh)) {
 421                     do_err('Database error: '. htmlspecialchars(DB::errorMessage($dbh)) .
 422                         ' in ' .$type .' DSN.');
 423                 }
 424                 $dbh->disconnect();
 425                 echo "$IND$type database connect successful.<br />\n";
 426
 427             } else {
 428                 do_err($db.' database support not present!');
 429             }
 430         }
 431     } else {
 432         $db_error='Required PHP PEAR DB support is not available.'
 433             .' Is PEAR installed and is the include path set correctly to find <tt>DB.php</tt>?'
 434             .' The include path is now:<tt>' . ini_get('include_path') . '</tt>.';
 435         do_err($db_error);
 436     }
 437 } else {
 438     echo $IND."not using database functionality.<br />\n";
 439 }
 440
 441 // LDAP DB tests
 442 echo "Checking LDAP functions...<br />\n";
 443 if( empty($ldap_server) ) {
 444     echo $IND."not using LDAP functionality.<br />\n";
 445 } else {
 446     if ( !function_exists('ldap_connect') ) {
 447         do_err('Required LDAP support is not available.');
 448     } else {
 449         echo "$IND LDAP support present.<br />\n";
 450         foreach ( $ldap_server as $param ) {
 451
 452             $linkid = @ldap_connect($param['host'], (empty($param['port']) ? 389 : $param['port']) );
 453
 454             if ( $linkid ) {
 455                echo "$IND LDAP connect to ".$param['host']." successful: ".$linkid."<br />\n";
 456
 457                 if ( !empty($param['protocol']) &&
 458                      !ldap_set_option($linkid, LDAP_OPT_PROTOCOL_VERSION, $param['protocol']) ) {
 459                     do_err('Unable to set LDAP protocol');
 460                 }
 461
 462                 if ( empty($param['binddn']) ) {
 463                     $bind = @ldap_bind($linkid);
 464                 } else {
 465                     $bind = @ldap_bind($param['binddn'], $param['bindpw']);
 466                 }
 467
 468                 if ( $bind ) {
 469                     echo "$IND LDAP Bind Successful <br />";
 470                 } else {
 471                     do_err('Unable to Bind to LDAP Server');
 472                 }
 473
 474                 @ldap_close($linkid);
 475             } else {
 476                 do_err('Connection to LDAP failed');
 477             }
 478         }
 479     }
 480 }
 481 ?>
 482
 483 <p>Congratulations, your SquirrelMail setup looks fine to me!</p>
 484
 485 <p><a href="login.php">Login now</a></p>
 486
 487 </body>
 488 </html>
 489 <?php
 490 // vim: et ts=4
 491 ?>