Functions renamed to new naming convetion, TODOs.txt updated
[mailer.git] / inc / load_extensions.php
index c033051562e8d1ea0cdbf7136c0cb7143599f676..96b15450cd3c61e3b4b3a2d1afdc2c621c5c7d23 100644 (file)
  * -------------------------------------------------------------------- *
  * Kurzbeschreibung  : Alle Erweiterungen laden                         *
  * -------------------------------------------------------------------- *
- *                                                                      *
+ * @TODO Rewrite this whole file to load_cache-extensions.php           *
+ * -------------------------------------------------------------------- *
+ * $Revision::                                                        $ *
+ * $Date::                                                            $ *
+ * $Tag:: 0.2.1-FINAL                                                 $ *
+ * $Author::                                                          $ *
+ * Needs to be in all Files and every File needs "svn propset           *
+ * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2008 by Roland Haeder                           *
  * For more information visit: http://www.mxchange.org                  *
 
 // Some security stuff...
 if (!defined('__SECURITY')) {
-       $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
+       $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
        require($INC);
 }
 
 // Init variables
-global $EXT_CSS_FILES;
-$EXT_CSS_FILES = array();
-$ADD = "";
+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;
+if ((!isInstalled()) || (isInstalling())) {
+       // Init filter system here
+       initFilterSystem();
+
+       // Skip loading
+       return;
+} // END - if
 
 // Initialize array for "always keep active extensions"
-$cacheArray['active_extensions'] = array();
+$GLOBALS['cache_array']['active_extensions'] = array();
 
 // By default no cache is set
-$cacheMode = "no";
+$GLOBALS['cache_mode'] = 'no';
 
 // Load sql_patchrs extension alone
-LOAD_EXTENSION("sql_patches");
+if (!LOAD_EXTENSION('sql_patches')) {
+       // Could not load sql_patches! ARGH!!!
+       trigger_error('Cannot load extension sql_patches.');
+} // END - if
+
+// Init inc pool array
+INIT_INC_POOL();
 
 //
 // Load extensions
 //
-if (EXT_IS_ACTIVE("cache")) {
+if (EXT_IS_ACTIVE('cache')) {
        // Load cache extension alone
-       LOAD_EXTENSION("cache");
+       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") && (getConfig('cache_exts') == "Y")) {
+       if (($GLOBALS['cache_mode'] == 'init') && (getConfig('cache_exts') == 'Y')) {
                // Init cache file
-               $cacheInstance->init("EXTENSIONS");
-               $cacheInstance->storeExtensionVersion("sql_patches");
-       } elseif (getConfig('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();
 
                // Retry it
                require(__FILE__);
@@ -103,10 +128,10 @@ if ($cacheMode == "load") {
        $EXT_NAMES = array();
        foreach ($EXT_DUMMY['ext_name'] as $k => $name) {
                // 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())) && (!in_array($name, array("sql_patches", "cache")))) {
+               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
 
@@ -130,11 +155,11 @@ if ($cacheMode == "load") {
                // Add ext name
                $EXT_NAMES[$id] = $name;
 
-               // Add deprecated flag (defaults to "not deprecated")
-               $EXT_DUMMY['ext_deprecated'][$name] = "N";
+               // Add deprecated flag (defaults to 'not deprecated')
+               $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
@@ -148,7 +173,7 @@ if ($cacheMode == "load") {
        // Loading cache is done so let's free some memory!
        unset($EXT_DUMMY['ext_keep']);
        unset($EXT_DUMMY['ext_css']);
-       $cacheArray['extensions'] = $EXT_DUMMY;
+       $GLOBALS['cache_array']['extensions'] = $EXT_DUMMY;
        unset($EXT_DUMMY);
 
        // No database load needed
@@ -160,10 +185,10 @@ if ($cacheMode == "load") {
        } // END - foreach
 
        // Init filter system
-       INIT_FILTER_SYSTEM();
+       initFilterSystem();
 
        // Load more cache files (like admins)
-       require_once(PATH."inc/load_cache.php");
+       loadIncludeOnce('inc/load_cache.php');
 
        // Remove array
        unset($EXT_POOL);
@@ -171,17 +196,17 @@ if ($cacheMode == "load") {
        // 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") {
+       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_has_css AS ext_css, ext_active, ext_version
-FROM `{!_MYSQL_PREFIX!}_extensions`".$ADD."
+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_name, ext_active, ext_version
-FROM `{!_MYSQL_PREFIX!}_extensions`".$ADD."
+FROM `{!_MYSQL_PREFIX!}_extensions`" . $add . "
 ORDER BY ext_name", __FILE__, __LINE__);
        }
 }
@@ -190,100 +215,97 @@ 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 session management
-       require_once(PATH."inc/session.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
-               $content['ext_menu'] = "N";
+               $content['ext_menu'] = 'N';
                if (MODULE_HAS_MENU($content['ext_name'], true)) {
-                       $content['ext_menu'] = "Y";
+                       $content['ext_menu'] = 'Y';
                } // END - if
 
-               // Load extensions
-               $file1 = sprintf("%sinc/extensions/ext-%s.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 (isFileReadable($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") && (($content['ext_name'] != "cache") || (!EXT_IS_ACTIVE("cache")))) {
+                       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")) {
+                       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'), getCurrentTheme(), $content['ext_name']);
 
                                // Is the file there?
-                               if (FILE_READABLE($CSS_FILE)) {
+                               if (isFileReadable($FQFN)) {
                                        // CSS file for extension was found (use only relative path for now!)
-                                       $EXT_CSS_FILES[] = $content['ext_name'].".css";
-                                       $content['ext_css'] = "Y";
+                                       EXT_ADD_CSS_FILE($content['ext_name'] . '.css');
+                                       $content['ext_css'] = 'Y';
                                } else {
                                        // Don't load CSS file
-                                       $content['ext_css'] = "N";
+                                       $content['ext_css'] = 'N';
                                }
                        } // 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 (!isFileReadable($FQFN)) {
                        // Deleted extension file so we mark it for removal from DB
                        $DEL[] = $content['ext_name'];
                }
        } // END - while
 
        // Init filter system
-       INIT_FILTER_SYSTEM();
+       initFilterSystem();
 
-       if ($cacheMode == "init") {
+       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");
+               loadIncludeOnce('inc/load_cache.php');
        } // END - if
 
        // Free memory
        SQL_FREERESULT($res_ext_crt);
-} elseif (!EXT_IS_ACTIVE("cache")) {
+} elseif (!EXT_IS_ACTIVE('cache')) {
        // Init filter system even when there are no extensions installed. #16
-       INIT_FILTER_SYSTEM();
+       initFilterSystem();
 }
 
 // Run the filter
-RUN_FILTER('load_includes', $INC_POOL);
+runFilterChain('load_includes');
 
 // 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",
-                       array($del_ext), __FILE__, __LINE__);
+               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='[%s:]' AND (task_type='EXTENSION' OR task_type='EXTENSION_UPDATE')",
-                       array($del_ext), __FILE__, __LINE__);
+               array($del_ext), __FILE__, __LINE__);
        } // END - foreach
 
        // I think it's not neccessary to run the optimization function here