Reorg placement of plugin loading and add config_override hook. Wondering why we...
[squirrelmail.git] / include / init.php
index 5a0dac87119cb793a7e809b5863dd2de8ecdf8b1..8be6cdad716c0456c76bc41cd9f6ab8cdf3f7b6c 100644 (file)
@@ -142,12 +142,10 @@ require(SM_PATH . 'config/config_default.php');
 $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 */
 require(SM_PATH . 'config/config.php');
 /* load local configuration overrides */
@@ -158,6 +156,7 @@ if (file_exists(SM_PATH . 'config/config_local.php')) {
 require(SM_PATH . 'functions/plugin.php');
 require(SM_PATH . 'include/constants.php');
 require(SM_PATH . 'include/languages.php');
+require(SM_PATH . 'class/template/Template.class.php');
 
 /**
  * If magic_quotes_runtime is on, SquirrelMail breaks in new and creative ways.
@@ -215,8 +214,39 @@ ini_set('session.name' , $session_name);
 session_set_cookie_params (0, $base_uri);
 sqsession_is_active();
 
-include_once(SM_PATH . 'plugins/multilogin/functions.php');
-multilogin_sqoverride_config_do();
+/**
+ * SquirrelMail version number -- DO NOT CHANGE
+ */
+$version = '1.5.2 [CVS]';
+
+/**
+ * SquirrelMail internal version number -- DO NOT CHANGE
+ * $sm_internal_version = array (release, major, minor)
+ */
+$SQM_INTERNAL_VERSION = array(1,5,2);
+
+/**
+ * Include Compatibility plugin if available.
+ */
+if (file_exists(SM_PATH . 'plugins/compatibility/functions.php'))
+    include_once(SM_PATH . 'plugins/compatibility/functions.php');
+
+/**
+ * MAIN PLUGIN LOADING CODE HERE
+ * On init, we no longer need to load all plugin setup files. 
+ * Now, we load the statically generated hook registrations here
+ * and let the hook calls include only the plugins needed.
+ */
+$squirrelmail_plugin_hooks = array();
+if (file_exists(SM_PATH . 'config/plugin_hooks.php')) {
+    require(SM_PATH . 'config/plugin_hooks.php');
+}
+
+/**
+ * allow plugins to override main configuration; hook is placed
+ * here to allow plugins to use session information to do their work
+ */
+do_hook('config_override');
 
 /**
  * DISABLED.
@@ -235,17 +265,6 @@ if ((bool) @ini_get('register_globals') &&
 
 sqsession_register(SM_BASE_URI,'base_uri');
 
-/**
- * SquirrelMail version number -- DO NOT CHANGE
- */
-$version = '1.5.2 [CVS]';
-
-/**
- * SquirrelMail internal version number -- DO NOT CHANGE
- * $sm_internal_version = array (release, major, minor)
- */
-$SQM_INTERNAL_VERSION = array(1,5,2);
-
 /**
  * Retrieve the language cookie
  */
@@ -261,33 +280,6 @@ if (!isset($sInitLocation)) {
     $sInitLocation=NULL;
 }
 
-/**
- * MAIN PLUGIN LOADING CODE HERE
- */
-
-/**
- * Include Compatibility plugin if available.
- */
-if (file_exists(SM_PATH . 'plugins/compatibility/functions.php'))
-    include_once(SM_PATH . 'plugins/compatibility/functions.php');
-$squirrelmail_plugin_hooks = array();
-
-/* On init, register all plugins configured for use. */
-if (isset($plugins) && is_array($plugins)) {
-    // 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)) {
-        die($output);
-    }
-}
-
 /**
  * Before 1.5.2 version hook was part of functions/constants.php.
  * After init layout changes, hook had to be moved because include/constants.php is
@@ -309,9 +301,6 @@ switch ($sInitLocation) {
 
         // make sure given template actually is available
         //
-        $aTemplateSet = (!isset($aTemplateSet) || !is_array($aTemplateSet)
-                         ? array() : $aTemplateSet);
-        $templateset_default = (!isset($templateset_default) ? 0 : $templateset_default);
         $found_templateset = false;
         for ($i = 0; $i < count($aTemplateSet); ++$i) {
             if ($aTemplateSet[$i]['ID'] == $templateid) {
@@ -320,12 +309,11 @@ switch ($sInitLocation) {
             }
         }
 
-// FIXME: do we need/want to check here for actual presence of template sets?
+// FIXME: do we need/want to check here for actual (physical) presence of template sets?
         // selected template not available, fall back to default template
         //
         if (!$found_templateset) {
-            $sTemplateID = (!isset($aTemplateSet[$templateset_default]['ID'])
-                            ? 'default' : $aTemplateSet[$templateset_default]['ID']);
+            $sTemplateID = Template::get_default_template_set();
         } else {
             $sTemplateID = $templateid;
         }
@@ -340,6 +328,7 @@ switch ($sInitLocation) {
          * plugins use own pref files.
          */
         require(SM_PATH . 'functions/prefs.php');
+        require(SM_PATH . 'functions/auth.php');
         /* hook loads custom prefs backend plugins */
         $prefs_backend = do_hook_function('prefs_backend');
         if (isset($prefs_backend) && !empty($prefs_backend) && file_exists(SM_PATH . $prefs_backend)) {
@@ -354,6 +343,23 @@ switch ($sInitLocation) {
         require(SM_PATH . 'functions/display_messages.php' );
         require(SM_PATH . 'functions/page_header.php');
         require(SM_PATH . 'functions/html.php');
+
+        // reset template file cache
+        //
+        $sTemplateID = Template::get_default_template_set();
+        Template::cache_template_file_hierarchy(TRUE);
+
+        /**
+         * Make sure icon variables are setup for the login page.
+         */
+        $icon_theme = $icon_themes[$icon_theme_def]['PATH'];
+        /*
+         * NOTE: The $icon_theme_path var should contain the path to the icon
+         *       theme to use.  If the admin has disabled icons, or the user has
+         *       set the icon theme to "None," no icons will be used.
+         */
+        $icon_theme_path = (!$use_icons || $icon_theme=='none') ? NULL : ($icon_theme == 'template' ? SM_PATH . Template::calculate_template_images_directory($sTemplateID) : $icon_theme);
+
         /**
          * cleanup old cookies with a cookie path the same as the standard php.ini
          * cookie path. All previous SquirrelMail version used the standard php.ini
@@ -403,18 +409,12 @@ switch ($sInitLocation) {
             /**
              * Initialize the template object (logout_error uses it)
              */
-            require(SM_PATH . 'class/template/Template.class.php');
             /*
              * $sTemplateID is not initialized when a user is not logged in, so we 
              * will use the config file defaults here.  If the neccesary variables 
              * are net set, force a default value.
              */
-            $aTemplateSet = (!isset($aTemplateSet) || !is_array($aTemplateSet) 
-                             ? array() : $aTemplateSet);
-            $templateset_default = ( !isset($templateset_default) ? 0 : $templateset_default );
-
-            $sTemplateID = ( !isset($aTemplateSet[$templateset_default]['ID']) ?
-                             'default' : $aTemplateSet[$templateset_default]['ID'] );
+            $sTemplateID = Template::get_default_template_set();
             $oTemplate = Template::construct_template($sTemplateID);
 
             set_up_language($squirrelmail_language, true);
@@ -423,6 +423,7 @@ switch ($sInitLocation) {
         }
 
         sqgetGlobalVar('username',$username,SQ_SESSION);
+        sqgetGlobalVar('authz',$authz,SQ_SESSION);
 
         /**
          * Setting the prefs backend
@@ -533,11 +534,6 @@ switch ($sInitLocation) {
         break;
 }
 
-/**
- * Initialize the template object
- */
-require(SM_PATH . 'class/template/Template.class.php');
-
 /*
  * $sTemplateID is not initialized when a user is not logged in, so we 
  * will use the config file defaults here.  If the neccesary variables 
@@ -547,17 +543,18 @@ require(SM_PATH . 'class/template/Template.class.php');
  * so we shouldn't change it here.
  */
 if (!isset($sTemplateID)) {
-    $aTemplateSet = (!isset($aTemplateSet) || !is_array($aTemplateSet) 
-                     ? array() : $aTemplateSet);
-    $templateset_default = ( !isset($templateset_default) ? 0 : $templateset_default );
-    
-    $sTemplateID = !isset($aTemplateSet[$templateset_default]['ID']) ? 'default' : $aTemplateSet[$templateset_default]['ID'];
+    $sTemplateID = Template::get_default_template_set();
     $icon_theme_path = !$use_icons ? NULL : Template::calculate_template_images_directory($sTemplateID);
 }
-$oTemplate = Template::construct_template($sTemplateID);
+
+// template object may have already been constructed in load_prefs.php
+//
+if (empty($oTemplate)) {
+    $oTemplate = Template::construct_template($sTemplateID);
+}
 
 // We want some variables to always be available to the template
-$always_include = array('sTemplateID', 'icon_theme_path');
+$always_include = array('sTemplateID', 'icon_theme_path', 'javascript_on');
 foreach ($always_include as $var) {
     $oTemplate->assign($var, (isset($$var) ? $$var : NULL));
 }