A lot while() conditions rewritten to SQL_FETCHARRAY(), see bug #107, @TODO tags...
[mailer.git] / inc / load_extensions.php
index 256cb97daa0fb13f0599d8d149854c8ba2a39740..f056fafa59eac5213661710e91e0698080059ce2 100644 (file)
@@ -10,6 +10,8 @@
  * -------------------------------------------------------------------- *
  * Kurzbeschreibung  : Alle Erweiterungen laden                         *
  * -------------------------------------------------------------------- *
+ * @TODO Rewrite this whole file to load_cache-extensions.php           *
+ * -------------------------------------------------------------------- *
  *                                                                      *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2008 by Roland Haeder                           *
@@ -38,95 +40,94 @@ if (!defined('__SECURITY')) {
 }
 
 // Init variables
-global $EXT_CSS_FILES;
-$EXT_CSS_FILES = array();
+EXT_INIT_CSS_FILES();
 $ADD = "";
 
+// Init cache instance and array
+$GLOBALS['cache_instance'] = null;
+$GLOBALS['cache_array'] = array();
+
 // Skip loading extensions
-if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing'))) return;
-
-// Load default sql_patches extension if present
-if (FILE_READABLE(PATH."inc/extensions/ext-sql_patches.php")) {
-       // Load it...
-       $EXT_LOAD_MODE = "";
-       require_once(PATH."inc/extensions/ext-sql_patches.php");
-       $cacheArray['active_extensions'] = array('sql_patches' => 'Y'); // KEEP THIS ALWAYS ACTIVE!
-} else {
-       // Initialize array for "always keep active extensions"
-       $cacheArray['active_extensions'] = array();
-}
+if ((!isInstalled()) || (isInstalling())) {
+       // Init filter system here
+       INIT_FILTER_SYSTEM();
+
+       // Skip loading
+       return;
+} // END - if
+
+// Initialize array for "always keep active extensions"
+$GLOBALS['cache_array']['active_extensions'] = array();
 
 // By default no cache is set
-$cacheMode = "no";
+$GLOBALS['cache_mode'] = "no";
+
+// Load sql_patchrs extension alone
+if (!LOAD_EXTENSION("sql_patches")) {
+       // Could not load sql_patches! ARGH!!!
+       trigger_error("Cannot load extension sql_patches.");
+} // END - if
+
+// Init inc pool array
+$INC_POOL = array();
 
 //
 // Load extensions
 //
 if (EXT_IS_ACTIVE("cache")) {
        // Load cache extension alone
-       include_once(PATH."inc/libs/cache_functions.php");
-       include_once(PATH."inc/extensions/ext-cache.php");
+       if (!LOAD_EXTENSION("cache")) {
+               // Extension 'cache' was not loaded
+               trigger_error("Cannot load extension cache.");
+       } // END - if
 
        // Check extension cache
-       switch (($cacheInstance->loadCacheFile("extensions", true)) && ($cacheInstance->extensionVersionMatches("sql_patches"))) {
-               case true : $cacheMode = "load"; break;
-               case false: $cacheMode = "init"; break;
+       switch (($GLOBALS['cache_instance']->loadCacheFile("extensions", true)) && ($GLOBALS['cache_instance']->extensionVersionMatches("sql_patches"))) {
+               case true : $GLOBALS['cache_mode'] = "load"; break;
+               case false: $GLOBALS['cache_mode'] = "init"; break;
        }
 
        // Do we need to init the cache?
-       if (($cacheMode == "init") && ($_CONFIG['cache_exts'] == "Y")) {
+       if (($GLOBALS['cache_mode'] == "init") && (getConfig('cache_exts') == "Y")) {
                // Init cache file
-               $cacheInstance->init("EXTENSIONS");
-               $cacheInstance->storeExtensionVersion("sql_patches");
-       } elseif ($_CONFIG['cache_exts'] == "N") {
+               $GLOBALS['cache_instance']->init("EXTENSIONS");
+               $GLOBALS['cache_instance']->storeExtensionVersion("sql_patches");
+       } elseif (getConfig('cache_exts') != "Y") {
                // Cache will not be created for extensions
-               $cacheMode = "skip";
+               $GLOBALS['cache_mode'] = "skip";
        }
 } // END - if
 
 // Load cache?
-if ($cacheMode == "load") {
+if ($GLOBALS['cache_mode'] == "load") {
        // Init include array
        $EXT_POOL = array();
 
        // Re-initialize handler
-       $cacheInstance->loadCacheFile("extensions", true);
+       $GLOBALS['cache_instance']->loadCacheFile("extensions", true);
 
        // Load extension data from cache file
-       $EXT_DUMMY = $cacheInstance->getArrayFromCache();
+       $EXT_DUMMY = $GLOBALS['cache_instance']->getArrayFromCache();
 
        // Is the cache file fine?
        if (!isset($EXT_DUMMY['ext_name'])) {
                // Cache file is damaged so kill it
-               $cacheInstance->destroyCacheFile();
+               $GLOBALS['cache_instance']->destroyCacheFile();
 
-               // Skip any further execution
+               // Retry it
+               require(__FILE__);
                return;
        } // END -  if
 
        // Begin with the cache preparation of extensions
        $EXT_NAMES = array();
        foreach ($EXT_DUMMY['ext_name'] as $k => $name) {
-               // Load functions file
-               if ($EXT_DUMMY['ext_funcs'][$k] == "Y") {
-                       require_once(PATH."inc/libs/".$name."_functions.php");
-               } // END - if
-
-               // Load Language file
-               if ($EXT_DUMMY['ext_lang'][$k] == "Y") {
-                       $INC = sprintf("%sinc/language/%s_%s.php", PATH, $name, GET_LANGUAGE());
-                       if (FILE_READABLE($INC)) {
-                               // Add it
-                               $EXT_POOL[] = $INC;
-                       } // END -  if
-               } // END - if
-
                // Load CSS file
-               if ($EXT_DUMMY['ext_css'][$k] == "Y") $EXT_CSS_FILES[] = "".$name.".css";
+               if ($EXT_DUMMY['ext_css'][$k] == "Y") EXT_ADD_CSS_FILE("".$name.".css");
 
                // Load extension file itself
-               if (($EXT_DUMMY['ext_active'][$k] == "Y") || ($EXT_DUMMY['ext_keep'][$k] == "Y") || (IS_ADMIN())) {
-                       $EXT_POOL[] = sprintf("%sinc/extensions/ext-%s.php", PATH, $name);
+               if ((($EXT_DUMMY['ext_active'][$k] == "Y") || ($EXT_DUMMY['ext_keep'][$k] == "Y") || (IS_ADMIN())) && (!in_array($name, array("sql_patches", "cache")))) {
+                       $EXT_POOL[] = $name;
                } // END - if
 
                // Version number
@@ -153,13 +154,11 @@ if ($cacheMode == "load") {
                $EXT_DUMMY['ext_deprecated'][$name] = "N";
 
                // Mark it as active extension
-               $cacheArray['active_extensions']['$name'] = $EXT_DUMMY['ext_keep'][$k];
+               $GLOBALS['cache_array']['active_extensions']['$name'] = $EXT_DUMMY['ext_keep'][$k];
                unset($EXT_DUMMY['ext_keep'][$k]);
 
                // Remove unneccessary data from memory
-               unset($EXT_DUMMY['ext_lang'][$k]);
                unset($EXT_DUMMY['ext_css'][$k]);
-               unset($EXT_DUMMY['ext_funcs'][$k]);
        } // END - foreach
 
        // Write dummy array back
@@ -167,41 +166,42 @@ if ($cacheMode == "load") {
        unset($EXT_NAMES);
 
        // Loading cache is done so let's free some memory!
-       unset($EXT_DUMMY['ext_lang']);
        unset($EXT_DUMMY['ext_keep']);
        unset($EXT_DUMMY['ext_css']);
-       unset($EXT_DUMMY['ext_funcs']);
-       $cacheArray['extensions'] = $EXT_DUMMY;
+       $GLOBALS['cache_array']['extensions'] = $EXT_DUMMY;
        unset($EXT_DUMMY);
 
        // No database load needed
        $res_ext_crt = false;
 
-       // Load more cache files (like admins)
-       require_once(PATH."inc/load_cache.php");
-
        // Load all extension files
-       foreach ($EXT_POOL as $inc) {
-               require_once($inc);
+       foreach ($EXT_POOL as $ext) {
+               LOAD_EXTENSION($ext);
        } // END - foreach
 
+       // Init filter system
+       INIT_FILTER_SYSTEM();
+
+       // Load more cache files (like admins)
+       LOAD_INC_ONCE("inc/load_cache.php");
+
        // Remove array
        unset($EXT_POOL);
 } else {
        // If current user is not admin load only activated extensions. But load
        // them all if we are going to init the cache files. The admin shall use
        // every available extension for testing purposes.
-       if ((!IS_ADMIN()) && ($cacheMode != "init")) $ADD = " WHERE ext_active='Y'";
+       if ((!IS_ADMIN()) && ($GLOBALS['cache_mode'] != "init")) $ADD = " WHERE ext_active='Y'";
 
        if (GET_EXT_VERSION("sql_patches") >= "0.0.6") {
                // Query with CSS file from DB
-               $res_ext_crt = SQL_QUERY("SELECT id AS ext_id, ext_name, ext_lang_file AS ext_lang, ext_has_css AS ext_css, ext_active, ext_version
-FROM "._MYSQL_PREFIX."_extensions".$ADD."
+               $res_ext_crt = SQL_QUERY("SELECT id AS ext_id, ext_name, ext_has_css AS ext_css, ext_active, ext_version
+FROM `{!_MYSQL_PREFIX!}_extensions`".$ADD."
 ORDER BY ext_name", __FILE__, __LINE__);
        } else {
                // Old obsolete query string
-               $res_ext_crt = SQL_QUERY("SELECT id AS ext_id, ext_name, ext_lang_file AS ext_lang, ext_name, ext_active, ext_version
-FROM "._MYSQL_PREFIX."_extensions".$ADD."
+               $res_ext_crt = SQL_QUERY("SELECT id AS ext_id, ext_name, ext_name, ext_active, ext_version
+FROM `{!_MYSQL_PREFIX!}_extensions`".$ADD."
 ORDER BY ext_name", __FILE__, __LINE__);
        }
 }
@@ -210,10 +210,7 @@ ORDER BY ext_name", __FILE__, __LINE__);
 $DEL = array();
 
 // At least one found?
-if ((SQL_NUMROWS($res_ext_crt) > 0) && ((($cacheMode == "init") && ($CSS != "1") && ($CSS != "-1")) || ($cacheMode == "no"))) {
-       // Load theme management
-       require_once(PATH."inc/theme-manager.php");
-
+if ((SQL_NUMROWS($res_ext_crt) > 0) && ((($GLOBALS['cache_mode'] == "init") && ($GLOBALS['output_mode'] != "1") && ($GLOBALS['output_mode'] != "-1")) || ($GLOBALS['cache_mode'] == "no"))) {
        // Extensions are registered so we load them
        while ($content = SQL_FETCHARRAY($res_ext_crt)) {
                // Get menu entry
@@ -222,64 +219,35 @@ if ((SQL_NUMROWS($res_ext_crt) > 0) && ((($cacheMode == "init") && ($CSS != "1")
                        $content['ext_menu'] = "Y";
                } // END - if
 
-               // Load extensions
-               $file1 = sprintf("%sinc/extensions/ext-%s.php", PATH, $content['ext_name']);
-               $file2 = $file1; $EXT_CSS = "N"; $EXT_ALWAYS_ACTIVE = "N";
-
-               // Special functions file
-               $file3 = sprintf("%sinc/libs/%s_functions.php", PATH, $content['ext_name']);
+               // Generate FQFN for extension
+               $FQFN = sprintf("%sinc/extensions/ext-%s.php", constant('PATH'), $content['ext_name']);
 
                // Does the extension file exists?
-               if (FILE_READABLE($file1)) {
-                       // If there's no language file specified we don't need to load one... ;-)
-                       if (!empty($content['ext_lang'])) {
-                               // Create language file
-                               $file2 = sprintf("%sinc/language/%s_%s.php", PATH, $content['ext_lang'], GET_LANGUAGE());
-                       } // END - if
-
-                       if (FILE_READABLE($file3)) {
-                               // Special functions file
-                               $content['ext_funcs'] = "Y";
-                               require_once($file3);
-                       } else {
-                               // Don't load functions file
-                               $content['ext_funcs'] = "N";
-                       }
-
-                       // Do we need a language file?
-                       if (($file1 != $file2) && (FILE_READABLE($file2))) {
-                               // Load language file
-                               $content['ext_lang'] = "Y";
-                               include($file2);
-                       } else {
-                               // Don't load language file
-                               $content['ext_lang'] = "N";
-                       }
-
+               if (FILE_READABLE($FQFN)) {
                        // By default no extension is always active, except sql_patches
-                       $EXT_ALWAYS_ACTIVE = "N";
+                       EXT_SET_ALWAYS_ACTIVE("N");
 
                        // Load extension
-                       if ($content['ext_name'] != "sql_patches") {
-                               // Load extension's file
-                               include_once($file1);
+                       if (($content['ext_name'] != "sql_patches") && (($content['ext_name'] != "cache") || (!EXT_IS_ACTIVE("cache")))) {
+                               // Load extension
+                               LOAD_EXTENSION($content['ext_name']);
                        } else {
                                // Keep sql_patches always active
-                               $EXT_ALWAYS_ACTIVE = "Y";
+                               EXT_SET_ALWAYS_ACTIVE("Y");
                        }
 
                        // Transfer EXT_ALWAYS_ACTIVE flag
-                       $content['ext_keep'] = $EXT_ALWAYS_ACTIVE;
+                       $content['ext_keep'] = EXT_GET_ALWAYS_ACTIVE();
 
                        // CSS file handling:
                        if ((!isset($content['ext_css'])) || ($content['ext_css'] == "Y")) {
                                // Create FQFN for the CSS file
-                               $CSS_FILE = sprintf("%stheme/%s/css/%s.css", PATH, GET_CURR_THEME(), $content['ext_name']);
+                               $FQFN = sprintf("%stheme/%s/css/%s.css", constant('PATH'), GET_CURR_THEME(), $content['ext_name']);
 
                                // Is the file there?
-                               if (FILE_READABLE($CSS_FILE)) {
+                               if (FILE_READABLE($FQFN)) {
                                        // CSS file for extension was found (use only relative path for now!)
-                                       $EXT_CSS_FILES[] = $content['ext_name'].".css";
+                                       EXT_ADD_CSS_FILE($content['ext_name'].".css");
                                        $content['ext_css'] = "Y";
                                } else {
                                        // Don't load CSS file
@@ -288,51 +256,50 @@ if ((SQL_NUMROWS($res_ext_crt) > 0) && ((($cacheMode == "init") && ($CSS != "1")
                        } // END - if
 
                        // Shall we cache?
-                       if ($cacheMode == "init") {
+                       if ($GLOBALS['cache_mode'] == "init") {
                                // Add cache row
-                               $cacheInstance->addRow($content);
-                       } elseif ($cacheMode == "no") {
+                               $GLOBALS['cache_instance']->addRow($content);
+                       } elseif ($GLOBALS['cache_mode'] == "no") {
                                // Remember this value for later usage
-                               $cacheArray['active_extensions'][$content['ext_name']] = $EXT_ALWAYS_ACTIVE;
+                               $GLOBALS['cache_array']['active_extensions'][$content['ext_name']] = EXT_GET_ALWAYS_ACTIVE();
                        }
-               } elseif (!FILE_READABLE($file1)) {
+               } elseif (!FILE_READABLE($FQFN)) {
                        // Deleted extension file so we mark it for removal from DB
                        $DEL[] = $content['ext_name'];
                }
        } // END - while
 
-       if ($cacheMode == "init") {
+       // Init filter system
+       INIT_FILTER_SYSTEM();
+
+       if ($GLOBALS['cache_mode'] == "init") {
                // Close cache file
-               $cacheInstance->finalize();
+               $GLOBALS['cache_instance']->finalize();
 
                // Load more cache files (like admins)
-               require_once(PATH."inc/load_cache.php");
+               LOAD_INC_ONCE("inc/load_cache.php");
        } // END - if
 
        // Free memory
        SQL_FREERESULT($res_ext_crt);
-} // END - if
-
-// Load include files if found
-if (!empty($INC_POOL[0])) {
-       foreach ($INC_POOL as $inc) {
-               require_once($inc);
-       } // END - foreach
+} elseif (!EXT_IS_ACTIVE("cache")) {
+       // Init filter system even when there are no extensions installed. #16
+       INIT_FILTER_SYSTEM();
+}
 
-       // Remove array
-       unset($INC_POOL);
-} // END - if
+// Run the filter
+runFilterChain('load_includes', $INC_POOL);
 
 // Uninstall extensions that are no longer in our system
 if (!empty($DEL[0])) {
        // Remove extensions from two tables: extension registry and tasks table
        foreach ($DEL as $del_ext) {
                // First remove entry from extensions table
-               SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
+               SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
                        array($del_ext), __FILE__, __LINE__);
 
                // Remove (maybe?) found tasks (main task and possible updates
-               SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_task_system WHERE subject LIKE '[%s:]%%' AND (task_type='EXTENSION' OR task_type='EXTENSION_UPDATE')",
+               SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_task_system` WHERE subject='[%s:]' AND (task_type='EXTENSION' OR task_type='EXTENSION_UPDATE')",
                        array($del_ext), __FILE__, __LINE__);
        } // END - foreach