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