* Check for capabilities in configtest, and warn here about LOGINDISABLED or
[squirrelmail.git] / src / configtest.php
index b3f6324e1b99c2ee64c694268dbe96554f521c5a..b3f0307d82a31d8fa5e0f205643a31bba34da904 100644 (file)
@@ -1,11 +1,14 @@
 <?php
-/*
+
+/**
  * SquirrelMail configtest script
  *
  * Copyright (c) 2003-2004 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage config
  */
 
 /************************************************************
  * If it throws errors you need to adjust your config.      *
  ************************************************************/
 
+// This script could really use some restructuring as it has grown quite rapidly
+// but is not very 'clean'. Feel free to get some structure into this thing.
+
 function do_err($str, $exit = TRUE) {
-    echo '<p><font color="red"><b>ERROR:</b></font> ' .$str. "</p>\n";
+    global $IND;
+    echo '<p>'.$IND.'<font color="red"><b>ERROR:</b></font> ' .$str. "</p>\n";
     if($exit) {
          echo '</body></html>';
          exit;
@@ -24,6 +31,7 @@ function do_err($str, $exit = TRUE) {
 $IND = str_repeat('&nbsp;',4);
 
 ob_implicit_flush();
+/** @ignore */
 define('SM_PATH', '../');
 
 /*
@@ -46,7 +54,7 @@ if (file_exists(SM_PATH . 'config/config.php')) {
 
 <p>This script will try to check some aspects of your SquirrelMail configuration
 and point you to errors whereever it can find them. You need to go run <tt>conf.pl</tt>
-in this directory first before you run this script.</p>
+in the <tt>config/</tt> directory first before you run this script.</p>
 
 <?php
 
@@ -66,17 +74,19 @@ if(!in_array('strings.php', $included)) {
 
 /* checking PHP specs */
 
-echo '<p>SquirrelMail version: '.$version.'<br />'.
-     'Config file version: '.$config_version . '<br />'.
-     'Config file last modified: '.date ('d F Y H:i:s', filemtime(SM_PATH . 'config/config.php')).'</p>';
+echo "<p><table>\n<tr><td>SquirrelMail version:</td><td><b>" . $version . "</b></td></tr>\n" .
+     '<tr><td>Config file version:</td><td><b>' . $config_version . "</b></td></tr>\n" .
+     '<tr><td>Config file last modified:</td><td><b>' . 
+         date ('d F Y H:i:s', filemtime(SM_PATH . 'config/config.php')) .
+         "</b></td></tr>\n</table>\n</p>\n\n";
 
 echo "Checking PHP configuration...<br />\n";
 
-if(!check_php_version(4,0,6)) {
-    do_err('Insufficient PHP version: '. PHP_VERSION . '! Minimum required: 4.0.6');
+if(!check_php_version(4,1,0)) {
+    do_err('Insufficient PHP version: '. PHP_VERSION . '! Minimum required: 4.1.0');
 }
 
-echo $IND . 'PHP version '.PHP_VERSION.' OK.<br />';
+echo $IND . 'PHP version ' . PHP_VERSION . " OK.<br />\n";
 
 $php_exts = array('session','pcre');
 $diff = array_diff($php_exts, get_loaded_extensions());
@@ -84,7 +94,7 @@ if(count($diff)) {
     do_err('Required PHP extensions missing: '.implode(', ',$diff) );
 }
 
-echo $IND . 'PHP extensions OK.<br />';
+echo $IND . "PHP extensions OK.<br />\n";
 
 
 /* checking paths */
@@ -117,9 +127,6 @@ if($data_dir == $attachment_dir) {
     if (!is_dir($attachment_dir)) {
         do_err("Attachment dir ($attachment_dir) is not a directory!");
     } 
-    if (!is_readable($attachment_dir)) {
-        do_err("I cannot read from attachment dir ($attachment_dir)!");
-    } 
     if (!is_writable($attachment_dir)) {
         do_err("I cannot write to attachment dir ($attachment_dir)!");
     }
@@ -179,31 +186,33 @@ if($useSendmail) {
                         $errorNumber, $errorString);
     if(!$stream) {
         do_err("Error connecting to SMTP server \"$smtpServerAddress:$smtpPort\".".
-            "Server error: ($errorNumber) $errorString");
+            "Server error: ($errorNumber) ".htmlspecialchars($errorString));
     }
 
     // check for SMTP code; should be 2xx to allow us access
     $smtpline = fgets($stream, 1024);
     if(((int) $smtpline{0}) > 3) {
-        do_err("Error connecting to SMTP server. Server error: ".$smtpline);
+        do_err("Error connecting to SMTP server. Server error: ".
+        htmlspecialchars($smtpline));
     }
 
     fputs($stream, 'QUIT');
     fclose($stream);
-    echo $IND . 'SMTP server OK (<tt><small>'.trim($smtpline)."</small></tt>)<br />\n";
+    echo $IND . 'SMTP server OK (<tt><small>'.
+        trim(htmlspecialchars($smtpline))."</small></tt>)<br />\n";
 
     /* POP before SMTP */
     if($pop_before_smtp) {
         $stream = fsockopen($smtpServerAddress, 110, $err_no, $err_str);
         if (!$stream) {
-            do_err("Error connecting to POP Server ($smtpServerAddress:110)"
-                  . " $err_no : $err_str");
+            do_err("Error connecting to POP Server ($smtpServerAddress:110) "
+                  . $err_no . ' : ' . htmlspecialchars($err_str));
         }
 
         $tmp = fgets($stream, 1024);
         if (substr($tmp, 0, 3) != '+OK') {
             do_err("Error connecting to POP Server ($smtpServerAddress:110)"
-                  . ' '.$tmp);
+                  . ' '.htmlspecialchars($tmp));
         }
         fputs($stream, 'QUIT');
         fclose($stream);
@@ -211,30 +220,193 @@ if($useSendmail) {
     }
 }
 
+/**
+ * Check the IMAP server
+ */
 echo "Checking IMAP service....<br />\n";
 
+/** Can we open a connection? */
 $stream = fsockopen( ($use_imap_tls?'tls://':'').$imapServerAddress, $imapPort,
                        $errorNumber, $errorString);
 if(!$stream) {
     do_err("Error connecting to IMAP server \"$imapServerAddress:$imapPort\".".
-        "Server error: ($errorNumber) $errorString");
+        "Server error: ($errorNumber) ".
+    htmlspecialchars($errorString));
 }
 
+/** Is the first response 'OK'? */
 $imapline = fgets($stream, 1024);
 if(substr($imapline, 0,4) != '* OK') {
-   do_err('Error connecting to IMAP server. Server error: '.$imapline);
+   do_err('Error connecting to IMAP server. Server error: '.
+       htmlspecialchars($imapline));
 }
 
-fputs($stream, '001 LOGOUT');
+echo $IND . 'IMAP server ready (<tt><small>'.
+    htmlspecialchars(trim($imapline))."</small></tt>)<br />\n";
+
+/** Check capabilities */
+fputs($stream, "A001 CAPABILITY\r\n");
+$capline = fgets($stream, 1024);
+
+echo $IND . 'Capabilities: <tt>'.htmlspecialchars($capline)."</tt><br />\n";
+
+if($imap_auth_mech == 'login' && stristr($capline, 'LOGINDISABLED') !== FALSE) {
+    do_err('Your server doesn\'t allow plaintext logins. '.
+        'Try enabling another authentication mechanism like CRAM-MD5, DIGEST-MD5 or TLS-encryption '.
+        'in the SquirrelMail configuration.', FALSE);
+}
+if($use_imap_tls && stristr($capline, 'STARTTLS') === FALSE) {
+    do_err('You have enabled TLS encryption in the config, but the server does not '.
+        'report STARTTLS capability. TLS is probably not supported.', FALSE);
+}
+
+/** OK, close connection */
+fputs($stream, "A002 LOGOUT\r\n");
 fclose($stream);
 
-echo $IND . 'IMAP server OK (<tt><small>'.trim($imapline)."</small></tt>)<br />\n";
+echo "Checking internationalization (i18n) settings...<br />\n";
+echo "$IND gettext - ";
+if (function_exists('gettext')) {
+    echo "Gettext functions are available. You must have appropriate system locales compiled.<br />\n";
+} else {
+    echo "Gettext functions are unavailable. SquirrelMail will use slower internal gettext functions.<br />\n";
+}
+echo "$IND mbstring - ";
+if (function_exists('mb_detect_encoding')) {
+    echo "Mbstring functions are available.<br />\n";
+} else {
+    echo "Mbstring functions are unavailable. Japanese translation won't work.<br />\n";
+}
+echo "$IND recode - ";
+if (function_exists('recode')) {
+    echo "Recode functions are available.<br />\n";
+} elseif ($use_php_recode) {
+    echo "Recode functions are unavailable.<br />\n";
+    do_err('Your configuration requires recode support, but recode support is missing.');
+} else {
+    echo "Recode functions are unavailable.<br />\n";
+}
+echo "$IND iconv - ";
+if (function_exists('iconv')) {
+    echo "Iconv functions are available.<br />\n";
+} elseif ($use_php_iconv) {
+    echo "Iconv functions are unavailable.<br />\n";
+    do_err('Your configuration requires iconv support, but iconv support is missing.');
+} else {
+    echo "Iconv functions are unavailable.<br />\n";
+}
+// same test as in include/validate.php
+echo "$IND timezone - ";
+if ( (!ini_get('safe_mode')) ||
+    !strcmp(ini_get('safe_mode_allowed_env_vars'),'') ||
+    preg_match('/^([\w_]+,)*TZ/', ini_get('safe_mode_allowed_env_vars')) ) {
+        echo "Webmail users can change their time zone settings.<br />\n";
+} else {
+    echo "Webmail users can't change their time zone settings.<br />\n";
+}
+
+
+// Pear DB tests
+echo "Checking database functions...<br />\n";
+if($addrbook_dsn || $prefs_dsn || $addrbook_global_dsn) {
+    @include_once('DB.php');
+    if (class_exists('DB')) {
+        echo "$IND PHP Pear DB support is present.<br />\n";
+        $db_functions=array(
+            'dbase' => 'dbase_open', 
+            'fbsql' => 'fbsql_connect', 
+            'interbase' => 'ibase_connect', 
+            'informix' => 'ifx_connect',
+            'msql' => 'msql_connect',
+            'mssql' => 'mssql_connect',
+            'mysql' => 'mysql_connect',
+            'mysqli' => 'mysqli_connect',
+            'oci8' => 'ocilogon',
+            'odbc' => 'odbc_connect',
+            'pgsql' => 'pgsql_connect',
+            'sqlite' => 'sqlite_open',
+            'sybase' => 'sybase_connect'
+            );
+
+        $dsns = array();
+        if($prefs_dsn) {
+            $dsns['preferences'] = $prefs_dsn;
+        }
+        if($addrbook_dsn) {
+            $dsns['addressbook'] = $addrbook_dsn;
+        }
+        if($addrbook_global_dsn) {
+            $dsns['global addressbook'] = $addrbook_global_dsn;
+        }
+
+        foreach($dsns as $type => $dsn) {
+            $dbtype = array_shift(explode(':', $dsn));
+            if(isset($db_functions[$dbtype]) && function_exists($db_functions[$dbtype])) {
+                echo "$IND$dbtype database support present.<br />\n";
+
+                // now, test this interface:
+
+                $dbh = DB::connect($dsn, true);
+                if (DB::isError($dbh)) {
+                    do_err('Database error: '. htmlspecialchars(DB::errorMessage($dbh)) .
+                        ' in ' .$type .' DSN.');
+                }
+                $dbh->disconnect();
+                echo "$IND$type database connect successful.<br />\n";
+
+            } else {
+                do_err($db.' database support not present!');
+            }
+        }
+    } else {
+        do_err('Required PHP PEAR DB support is not available. Is PEAR installed and is the
+            include path set correctly to find <tt>DB.php</tt>? The include path is now:
+            "<tt>' . ini_get('include_path') . '</tt>".');
+    }
+} else {
+    echo $IND."not using database functionality.<br />\n";
+}
 
-// other possible checks:
-// ? prefs/abook DSN
-// ? locale/gettext
-// ? actually start a session to see if it works
-// ? ...
+// LDAP DB tests
+echo "Checking LDAP functions...<br />\n";
+if( empty($ldap_server) ) {
+    echo $IND."not using LDAP functionality.<br />\n";
+} else {
+    if ( !function_exists(ldap_connect) ) {
+        do_err('Required LDAP support is not available.');
+    } else {
+        echo "$IND LDAP support present.<br />\n";
+        foreach ( $ldap_server as $param ) {
+
+            $linkid = ldap_connect($param['host'], (empty($param['port']) ? 389 : $param['port']) );
+
+            if ( $linkid ) {
+               echo "$IND LDAP connect to ".$param['host']." successful: ".$linkid."<br />\n";
+                
+                if ( !empty($param['protocol']) &&
+                     !ldap_set_option($linkid, LDAP_OPT_PROTOCOL_VERSION, $param['protocol']) ) {
+                    do_err('Unable to set LDAP protocol');
+                }   
+
+                if ( empty($param['binddn']) ) {
+                    $bind = ldap_bind($linkid);    
+                } else {
+                    $bind = ldap_bind($param['binddn'], $param['bindpw']);
+                }
+
+                if ( $bind ) {
+                    echo "$IND LDAP Bind Successful <br />";
+                } else {
+                    do_err('Unable to Bind to LDAP Server');
+                }
+                
+                ldap_close($linkid);
+            } else {
+                do_err('Connection to LDAP failed');
+            }
+        }
+    }
+}
 ?>
 
 <p>Congratulations, your SquirrelMail setup looks fine to me!</p>
@@ -243,3 +415,6 @@ echo $IND . 'IMAP server OK (<tt><small>'.trim($imapline)."</small></tt>)<br />\
 
 </body>
 </html>
+<?php
+// vim: et ts=4
+?>