Re-enable plugins in configtest
[squirrelmail.git] / src / configtest.php
index e64f8e544f9123d18f308ebda4f946b017a511f5..45822902a5b496f33b5000e2f50ad68e9f7a9896 100644 (file)
 
 // 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.
-$warnings = 0;
 
+/** force verbose error reporting and turn on display of errors */
+error_reporting(E_ALL);
+ini_set('display_errors',1);
+
+/** Blockcopy from init.php. Cleans globals. */
+if ((bool) ini_get('register_globals') &&
+    strtolower(ini_get('register_globals'))!='off') {
+    /**
+     * Remove all globals that are not reserved by PHP
+     * 'value' and 'key' are used by foreach. Don't unset them inside foreach.
+     */
+    foreach ($GLOBALS as $key => $value) {
+        switch($key) {
+        case 'HTTP_POST_VARS':
+        case '_POST':
+        case 'HTTP_GET_VARS':
+        case '_GET':
+        case 'HTTP_COOKIE_VARS':
+        case '_COOKIE':
+        case 'HTTP_SERVER_VARS':
+        case '_SERVER':
+        case 'HTTP_ENV_VARS':
+        case '_ENV':
+        case 'HTTP_POST_FILES':
+        case '_FILES':
+        case '_REQUEST':
+        case 'HTTP_SESSION_VARS':
+        case '_SESSION':
+        case 'GLOBALS':
+        case 'key':
+        case 'value':
+            break;
+        default:
+            unset($GLOBALS[$key]);
+        }
+    }
+    // Unset variables used in foreach
+    unset($GLOBALS['key']);
+    unset($GLOBALS['value']);
+}
+
+
+/**
+ * Displays error messages and warnings
+ * @param string $str message
+ * @param boolean $fatal fatal error or only warning
+ */
 function do_err($str, $fatal = TRUE) {
     global $IND, $warnings;
     $level = $fatal ? 'FATAL ERROR:' : 'WARNING:';
@@ -31,25 +77,57 @@ function do_err($str, $fatal = TRUE) {
     }
 }
 
-$IND = str_repeat(' ',4);
-
 ob_implicit_flush();
 /** @ignore */
 define('SM_PATH', '../');
+/** load minimal function set */
+require(SM_PATH . 'functions/global.php');
+require(SM_PATH . 'functions/strings.php');
 
-/* set default value in order to block remote access to script */
+/** set default value in order to block remote access */
 $allow_remote_configtest=false;
 
-/*
- * Load config before output begins. functions/strings.php depends on
- * functions/globals.php. functions/global.php needs to be run before
- * any html output starts. If config.php is missing, error will be displayed
- * later.
- */
+/** Load all configuration files before output begins */
+
+/* load default configuration */
+require(SM_PATH . 'config/config_default.php');
+/* reset arrays in default configuration */
+$ldap_server = array();
+$plugins = array();
+$fontsets = array();
+$theme = array();
+$theme[0]['PATH'] = SM_PATH . 'themes/default_theme.php';
+$theme[0]['NAME'] = 'Default';
+$aTemplateSet = array();
+$aTemplateSet[0]['ID'] = 'default';
+$aTemplateSet[0]['NAME'] = 'Default';
+/* load site configuration */
 if (file_exists(SM_PATH . 'config/config.php')) {
-    include(SM_PATH . 'config/config.php');
-    include(SM_PATH . 'functions/strings.php');
+    require(SM_PATH . 'config/config.php');
 }
+/* load local configuration overrides */
+if (file_exists(SM_PATH . 'config/config_local.php')) {
+    require(SM_PATH . 'config/config_local.php');
+}
+
+/** Load plugins */
+global $disable_plugins;
+$squirrelmail_plugin_hooks = array();
+if (!$disable_plugins && file_exists(SM_PATH . 'config/plugin_hooks.php')) {
+    require(SM_PATH . 'config/plugin_hooks.php');
+}
+
+/** Warning counter */
+$warnings = 0;
+
+/** indent */
+$IND = str_repeat(' ',4);
+
+/**
+ * get_location starts session and must be run before output is started.
+ */
+$test_location = get_location();
+
 ?><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
 <html>
@@ -98,7 +176,7 @@ echo "<p><table>\n<tr><td>SquirrelMail version:</td><td><b>" . $version . "</b><
     "</b></td></tr>\n</table>\n</p>\n\n";
 
 /* check $config_version */
-if ($config_version!='1.4.0') {
+if ($config_version!='1.5.0') {
     do_err('Configuration file version does not match required version. Please update your configuration file.');
 }
 
@@ -109,7 +187,11 @@ if(!check_php_version(4,1,0)) {
 }
 
 echo $IND . 'PHP version ' . PHP_VERSION . ' OK. (You have: ' . phpversion() . ". Minimum: 4.1.0)<br />\n";
-
+/* test for boolean false and any string that is not equal to 'off' */
+if ((bool) ini_get('register_globals') && 
+    strtolower(ini_get('register_globals'))!='off') {
+    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);
+}
 $php_exts = array('session','pcre');
 $diff = array_diff($php_exts, get_loaded_extensions());
 if(count($diff)) {
@@ -193,33 +275,37 @@ if($data_dir == $attachment_dir) {
 
 
 /* check plugins and themes */
+//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
 $bad_plugins = array(
-        'attachment_common',      // Integrated into SM 1.2 Core
+        'attachment_common',      // Integrated into SquirrelMail 1.2 core
         'auto_prune_sent',        // Obsolete: See Proon Automatic Folder Pruning plugin
-        'compose_new_window',     // Integrated into SM 1.4 Core
-        'delete_move_next',       // Integrated into SM 1.5 Core
+        'compose_new_window',     // Integrated into SquirrelMail 1.4 core
+        'delete_move_next',       // Integrated into SquirrelMail 1.5 core
         'disk_quota',             // Obsolete: See Check Quota plugin
-        'email_priority',         // Integrated into SM 1.2 Core
+        'email_priority',         // Integrated into SquirrelMail 1.2 core
         'emoticons',              // Obsolete: See HTML Mail plugin
-        'focus_change',           // Integrated into SM 1.2 Core
-        'folder_preferences',     // 
-        'global_sql_addressbook', // Integrated into SM 1.4 Core
+        'focus_change',           // Integrated into SquirrelMail 1.2 core
+        'folder_settings',        // Integrated into SquirrelMail 1.5.1 core
+        'global_sql_addressbook', // Integrated into SquirrelMail 1.4 core
         'hancock',                // Not Working: See Random Signature Taglines plugin
-        'message_source',         // Added to SM 1.4 Core Plugins (message_details)
-        'motd',                   // Integrated into SM 1.2 Core
-        'paginator',              // Integrated into SM 1.2 Core
-        'printer_friendly',       // Integrated into SM 1.2 Core
+        'msg_flags',              // Integrated into SquirrelMail 1.5.1 core
+        'message_source',         // Added to SquirrelMail 1.4 Core Plugins (message_details)
+        'motd',                   // Integrated into SquirrelMail 1.2 core
+        'paginator',              // Integrated into SquirrelMail 1.2 core
+        'printer_friendly',       // Integrated into SquirrelMail 1.2 core
         'procfilter',             // Obsolete: See Server Side Filter plugin
-        'redhat_php_cgi_fix',     // Integrated into SM 1.1.1 Core
-        'send_to_semicolon',      // Integrated into SM 1.4.1 Core
-        'spamassassin',           // Not working beyond SM 1.2.7: See Spamassassin SpamFilter (Frontend) v2 plugin
-        'sqcalendar',             // Added to SM 1.2 Core Plugins (calendar)
-        'sqclock',                // Integrated into SM 1.2 Core
+        'redhat_php_cgi_fix',     // Integrated into SquirrelMail 1.1.1 core
+        'send_to_semicolon',      // Integrated into SquirrelMail 1.4.1 core
+        'spamassassin',           // Not working beyond SquirrelMail 1.2.7: See Spamassassin SpamFilter (Frontend) v2 plugin
+        'sqcalendar',             // Added to SquirrelMail 1.2 Core Plugins (calendar)
+        'sqclock',                // Integrated into SquirrelMail 1.2 core
         'sql_squirrel_logger',    // Obsolete: See Squirrel Logger plugin
         'tmda',                   // Obsolete: See TMDA Tools plugin
         'vacation',               // Obsolete: See Vacation Local plugin
-        'view_as_html',           // Integrated into SM 1.5.1 Core
-        'xmailer'                 // Integrated into SM 1.2 Core
+        'view_as_html',           // Integrated into SquirrelMail 1.5.1 core
+        'xmailer'                 // Integrated into SquirrelMail 1.2 core
         );
 
 if (isset($plugins[0])) {
@@ -232,7 +318,32 @@ if (isset($plugins[0])) {
             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);
         }
     }
-    echo $IND . "Plugins OK.<br />\n";
+    // load plugin functions
+    include_once(SM_PATH . 'functions/plugin.php');
+    // turn on output buffering in order to prevent output of new lines
+    ob_start();
+    foreach ($plugins as $name) {
+        use_plugin($name);
+    }
+    // get output and remove whitespace
+    $output = trim(ob_get_contents());
+    ob_end_clean();
+    // if plugins output more than newlines and spacing, stop script execution.
+    if (!empty($output)) {
+        $plugin_load_error = 'Some output is produced when plugins are loaded.'
+            .' Usually it means error. Output said: '.htmlspecialchars($output);
+        do_err($plugin_load_error);
+    }
+    /**
+     * This hook was added in 1.5.2. Each plugins should print an error 
+     * message and return TRUE if there are any errors in its setup/configuration.
+     */
+    $plugin_err = boolean_hook_function('configtest', $null);
+    if($plugin_err) {
+        do_err('Some plugin tests failed.');
+    } else {
+        echo $IND . "Plugins OK.<br />\n";
+    }
 } else {
     echo $IND . "Plugins are not enabled in config.<br />\n";
 }
@@ -264,7 +375,9 @@ if ( $squirrelmail_default_language != 'en_US' ) {
     echo $IND . "Default language OK.<br />\n";
 }
 
-echo $IND . "Base URL detected as: <tt>" . htmlspecialchars(get_location()) . "</tt><br />\n";
+echo $IND . "Base URL detected as: <tt>" . htmlspecialchars($test_location) .
+    "</tt> (location base " . (empty($config_location_base) ? 'autodetected' : 'set to <tt>' .
+    htmlspecialchars($config_location_base)."</tt>") . ")<br />\n";
 
 /* check minimal requirements for other security options */
 
@@ -278,7 +391,7 @@ if($use_smtp_tls == 1 || $use_imap_tls == 1) {
     }
 }
 /* starttls extensions */
-if($use_smtp_tls == 2 || $use_imap_tls == 2) {
+if($use_smtp_tls === 2 || $use_imap_tls === 2) {
     if (! function_exists('stream_socket_enable_crypto')) {
         do_err('If you want to use STARTTLS extension, you need stream_socket_enable_crypto() function from PHP 5.1.0 and newer.');
     }
@@ -320,7 +433,7 @@ if($useSendmail) {
     }
 
     /* smtp starttls checks */
-    if ($use_smtp_tls==2) {
+    if ($use_smtp_tls===2) {
         // if something breaks, script should close smtp connection on exit.
 
         // say helo
@@ -429,9 +542,9 @@ while ($line=fgets($stream, 1024)){
 }
 
 /* don't display capabilities before STARTTLS */
-if ($use_imap_tls==2 && stristr($capline, 'STARTTLS') === false) {
+if ($use_imap_tls===2 && stristr($capline, 'STARTTLS') === false) {
     do_err('Your server doesn\'t support STARTTLS.');
-} elseif($use_imap_tls==2) {
+} elseif($use_imap_tls===2) {
     /* try starting starttls */
     fwrite($stream,"A002 STARTTLS\r\n");
     $starttls_line=fgets($stream, 1024);
@@ -465,6 +578,27 @@ if($imap_auth_mech == 'login' && stristr($capline, 'LOGINDISABLED') !== FALSE) {
             'in the SquirrelMail configuration.', FALSE);
 }
 
+if (stristr($capline, 'XMAGICTRASH') !== false) {
+    $magic_trash = 'It looks like IMAP_MOVE_EXPUNGE_TO_TRASH option is turned on '
+        .'in your Courier IMAP configuration. Courier does not provide tools that '
+        .'allow to detect folder used for Trash or commands are not documented. '
+        .'SquirrelMail can\'t detect special trash folder. SquirrelMail manages '
+        .'all message deletion or move operations internally and '
+        .'IMAP_MOVE_EXPUNGE_TO_TRASH option can cause errors in message and '
+        .'folder management operations. Please turn off IMAP_MOVE_EXPUNGE_TO_TRASH '
+        .'option in Courier imapd configuration.';
+    do_err($magic_trash,false);
+}
+
+/* add warning about IMAP delivery */
+if (stristr($capline, 'XCOURIEROUTBOX') !== false) {
+    $courier_outbox = 'OUTBOX setting is enabled in your Courier imapd '
+        .'configuration. SquirrelMail uses standard SMTP protocol or sendmail '
+        .'binary to send emails. Courier IMAP delivery method is not supported'
+        .' and can create duplicate email messages.';
+    do_err($courier_outbox,false);
+}
+
 /** OK, close connection */
 fputs($stream, "A004 LOGOUT\r\n");
 fclose($stream);
@@ -475,6 +609,52 @@ if (function_exists('gettext')) {
     echo 'Gettext functions are available.'
         .' On some systems you must have appropriate system locales compiled.'
         ."<br />\n";
+
+    /* optional setlocale() tests. Should work only on glibc systems. */
+    if (sqgetGlobalVar('testlocales',$testlocales,SQ_GET)) {
+        include_once(SM_PATH . 'include/languages.php');
+        echo $IND . $IND . 'Testing translations:<br>';
+        foreach ($languages as $lang_code => $lang_data) {
+            /* don't test aliases */
+            if (isset($lang_data['NAME'])) {
+                /* locale can be $lang_code or $lang_data['LOCALE'] */
+                if (isset($lang_data['LOCALE'])) {
+                    $setlocale = $lang_data['LOCALE'];
+                } else {
+                    $setlocale = $lang_code;
+                }
+                /* prepare information about tested locales */
+                if (is_array($setlocale)) {
+                    $display_locale = implode(', ',$setlocale);
+                    $locale_count = count($setlocale);
+                } else {
+                    $display_locale = $setlocale;
+                    $locale_count = 1;
+                }
+                $tested_locales_msg = 'Tested '.htmlspecialchars($display_locale).' '
+                    .($locale_count>1 ? 'locales':'locale'). '.';
+
+                echo $IND . $IND .$IND . $lang_data['NAME'].' (' .$lang_code. ') - ';
+                $retlocale = sq_setlocale(LC_ALL,$setlocale);
+                if (is_bool($retlocale)) {
+                    echo '<font color="red">unsupported</font>. ';
+                    echo $tested_locales_msg;
+                } else {
+                    echo 'supported. '
+                        .$tested_locales_msg
+                        .' setlocale() returned "'.htmlspecialchars($retlocale).'"';
+                }
+                echo "<br />\n";
+            }
+        }
+        echo $IND . $IND . '<a href="configtest.php">Don\'t test translations</a>';
+    } else {
+        echo $IND . $IND . '<a href="configtest.php?testlocales=1">Test translations</a>. '
+            .'This test is not accurate and might work only on some systems.'
+            ."\n";
+    }
+    echo "<br />\n";
+    /* end of translation tests */
 } else {
     echo 'Gettext functions are unavailable.'
         .' SquirrelMail will use slower internal gettext functions.'
@@ -505,16 +685,21 @@ if (function_exists('iconv')) {
 } else {
     echo "Iconv functions are unavailable.<br />\n";
 }
-// same test as in include/validate.php
+// same test as in include/init.php + date_default_timezone_set check
 echo "$IND timezone - ";
-if ( (!ini_get('safe_mode')) ||
+if ( (!ini_get('safe_mode')) || function_exists('date_default_timezone_set') ||
         !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";
+    echo "Webmail users can change their time zone settings. \n";
 } else {
-    echo "Webmail users can't change their time zone settings.<br />\n";
+    echo "Webmail users can't change their time zone settings. \n";
 }
-
+if (isset($_ENV['TZ'])) {
+    echo 'Default time zone is '.htmlspecialchars($_ENV['TZ']);
+} else {
+    echo 'Current time zone is '.date('T');
+}
+echo ".<br />\n";
 
 // Pear DB tests
 echo "Checking database functions...<br />\n";
@@ -637,4 +822,4 @@ if ($warnings) {
 EOF;
     echo $footer;
 }
-?>
\ No newline at end of file
+?>