Functions renamed to new naming convetion, TODOs.txt updated
[mailer.git] / inc / load_extensions.php
index 75b0c422be5d182e635be63fed865f1b59125be8..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 (ereg(basename(__FILE__), $_SERVER['PHP_SELF']))
-{
-       $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
+if (!defined('__SECURITY')) {
+       $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
        require($INC);
 }
-//
-global $EXT_CSS_FILES;
-$EXT_CSS_FILES = array();
-$ADD = "";
+
+// Init variables
+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_exists(PATH."inc/extensions/ext-sql_patches.php") && is_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
+       initFilterSystem();
+
+       // Skip loading
+       return;
+} // END - if
+
+// Initialize array for "always keep active extensions"
+$GLOBALS['cache_array']['active_extensions'] = array();
+
+// By default no cache is set
+$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
+INIT_INC_POOL();
 
 //
 // Load extensions
 //
-if (EXT_IS_ACTIVE("cache")) {
+if (EXT_IS_ACTIVE('cache')) {
        // Load cache extension alone
-       include_once(PATH."inc/libs/cache_functions.php");
-       $cacheMode = "";
-       include_once(PATH."inc/extensions/ext-cache.php");
-       switch($cacheInstance->cache_file("extensions", true)) {
-               case true : $cacheMode = "load"; break;
-               case false: $cacheMode = "init"; break;
+       if (!LOAD_EXTENSION('cache')) {
+               // Extension 'cache' was not loaded
+               trigger_error('Cannot load extension cache.');
+       } // END - if
+
+       // Check extension cache
+       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 not recreate cache file when it's switched off!
-       if (($cacheMode == "init") && ($_CONFIG['cache_exts'] == 'N')) $cacheMode = "skip";
-
-       // Load language
-       if ($cacheMode == "load") include(PATH."inc/language/cache_".GET_LANGUAGE().".php");
-} else {
-       $cacheMode = "no";
-}
+       // Do we need to init the cache?
+       if (($GLOBALS['cache_mode'] == 'init') && (getConfig('cache_exts') == 'Y')) {
+               // Init cache file
+               $GLOBALS['cache_instance']->init('EXTENSIONS');
+               $GLOBALS['cache_instance']->storeExtensionVersion('sql_patches');
+       } elseif (getConfig('cache_exts') != 'Y') {
+               // Cache will not be created for extensions
+               $GLOBALS['cache_mode'] = 'skip';
+       }
+} // END - if
 
-if ($cacheMode == "load") {
-       // Load more cache files (like admins)
-       require_once(PATH."inc/load_cache.php");
+// Load cache?
+if ($GLOBALS['cache_mode'] == 'load') {
+       // Init include array
+       $EXT_POOL = array();
 
        // Re-initialize handler
-       $cacheInstance->cache_file("extensions", true);
+       $GLOBALS['cache_instance']->loadCacheFile('extensions', true);
 
        // Load extension data from cache file
-       $EXT_DUMMY = $cacheInstance->cache_load();
-       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");
-
-               // Load Language file
-               if ($EXT_DUMMY['ext_lang'][$k] == 'Y') {
-                       $INC = sprintf(PATH."inc/language/%s_%s.php", $name, GET_LANGUAGE());
-                       if (file_exists($INC)) require_once($INC);
-               }
+       $EXT_DUMMY = $GLOBALS['cache_instance']->getArrayFromCache();
+
+       // Is the cache file fine?
+       if (!isset($EXT_DUMMY['ext_name'])) {
+               // Cache file is damaged so kill it
+               $GLOBALS['cache_instance']->destroyCacheFile();
 
+               // 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 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())) {
-                       require_once(PATH."inc/extensions/ext-".$name.".php");
-               }
+               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
 
-               // Transfer version number and active status
+               // Version number
                $EXT_DUMMY['ext_version'][$name] = $EXT_DUMMY['ext_version'][$k];
                unset($EXT_DUMMY['ext_version'][$k]);
+
+               // Extension is active
                $EXT_DUMMY['ext_active'][$name] = $EXT_DUMMY['ext_active'][$k];
                unset($EXT_DUMMY['ext_active'][$k]);
+
+               // Ext menu
                $EXT_DUMMY['ext_menu'][$name] = $EXT_DUMMY['ext_menu'][$k];
                unset($EXT_DUMMY['ext_menu'][$k]);
-               $cacheArray['active_extensions']['$name'] = $EXT_DUMMY['ext_keep'][$k];
+
+               // Extension id
+               $EXT_DUMMY['ext_id'][$name] = $EXT_DUMMY['ext_id'][$k];
+               $id = $EXT_DUMMY['ext_id'][$name];
+               unset($EXT_DUMMY['ext_id'][$k]);
+
+               // Add ext name
+               $EXT_NAMES[$id] = $name;
+
+               // Add deprecated flag (defaults to 'not deprecated')
+               $EXT_DUMMY['ext_deprecated'][$name] = 'N';
+
+               // Mark it as active extension
+               $GLOBALS['cache_array']['active_extensions']['$name'] = $EXT_DUMMY['ext_keep'][$k];
                unset($EXT_DUMMY['ext_keep'][$k]);
-               $k2 = $EXT_DUMMY['ext_id'][$k];
-               $EXT_DUMMY['ext_id'][$k2] = $name;
-               if ($k2 != $k) unset($EXT_DUMMY['ext_id'][$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
 
-       // Close cache file
-       $cacheInstance->cache_close();
+       // Write dummy array back
+       $EXT_DUMMY['ext_name'] = $EXT_NAMES;
+       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 all extension files
+       foreach ($EXT_POOL as $ext) {
+               LOAD_EXTENSION($ext);
+       } // END - foreach
+
+       // Init filter system
+       initFilterSystem();
+
+       // Load more cache files (like admins)
+       loadIncludeOnce('inc/load_cache.php');
+
+       // Remove array
+       unset($EXT_POOL);
 } else {
-       // If current user is not admin load only activated extensions
-       // The admin shall use every available extension for testing purposes
-       if ((!IS_ADMIN()) && ($cacheMode != "init")) $ADD = " WHERE ext_active='Y'";
+       // 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()) && ($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, ext_name, ext_lang_file, ext_has_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 obsulete query string
-               $res_ext_crt = SQL_QUERY("SELECT id, ext_name, ext_lang_file, ext_name, ext_active, ext_version
-FROM "._MYSQL_PREFIX."_extensions".$ADD."
+               // 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 . "
 ORDER BY ext_name", __FILE__, __LINE__);
        }
 }
@@ -159,161 +215,102 @@ ORDER BY ext_name", __FILE__, __LINE__);
 $DEL = array();
 
 // At least one found?
-if ((SQL_NUMROWS($res_ext_crt) > 0) && (($cacheMode == "init") || ($cacheMode == "no")) && ($CSS != "1") && ($CSS != "-1"))
-{
-       // Load theme management
-       require_once(PATH."inc/theme-manager.php");
-
-       // If we need to init the cache init it now
-       if ($cacheMode == "init") $cacheInstance->cache_init("EXTENSIONS");
-
+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 (list($EXT_ID, $name, $lang, $css, $active, $version) = SQL_FETCHROW($res_ext_crt))
-       {
+       while ($content = SQL_FETCHARRAY($res_ext_crt)) {
                // Get menu entry
-               $result_menu = SQL_QUERY_ESC("SELECT has_menu FROM "._MYSQL_PREFIX."_mod_reg WHERE module='%s' LIMIT 1",
-                array($name), __FILE__, __LINE__);
-               list($menu) = SQL_FETCHROW($result_menu);
-               //* DEBUG: */ echo "*".$name."/".$menu."*<br>";
-
-               // An empty menu entry will be interpreted as N (no menu) to avoid problems
-               if (empty($menu)) $menu = 'N';
-
-               // Load extensions
-               $file1 = sprintf(PATH."inc/extensions/ext-%s.php", $name);
-               $file2 = $file1; $EXT_CSS = 'N'; $EXT_ALWAYS_ACTIVE = 'N';
+               $content['ext_menu'] = 'N';
+               if (MODULE_HAS_MENU($content['ext_name'], true)) {
+                       $content['ext_menu'] = 'Y';
+               } // END - if
 
-               // Special functions file
-               $file3 = sprintf(PATH."inc/libs/%s_functions.php", $name);
+               // Generate FQFN for extension
+               $FQFN = sprintf("%sinc/extensions/ext-%s.php", constant('PATH'), $content['ext_name']);
 
                // Does the extension file exists?
-               if (file_exists($file1) && is_readable($file1))
-               {
-                       // If there's no language file specified we don't need to load one... ;-)
-                       if (!empty($lang)) {
-                               // Create language file
-                               $file2 = sprintf(PATH."inc/language/%s_%s.php", $lang, GET_LANGUAGE());
-                       }
+               if (isFileReadable($FQFN)) {
+                       // By default no extension is always active, except sql_patches
+                       EXT_SET_ALWAYS_ACTIVE('N');
 
-                       if (file_exists($file3) && is_readable($file3))
-                       {
-                               // Special functions file
-                               $funcs = 'Y';
-                               require_once($file3);
-                       }
-                        else
-                       {
-                               // Don't load functions file
-                               $funcs = 'N';
+                       // Load extension
+                       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_SET_ALWAYS_ACTIVE('Y');
                        }
 
-                       // Do we need a language file?
-                       if (($file1 != $file2) && (file_exists($file2)) && (is_readable($file2)))
-                       {
-                               // Load language file
-                               $lang = 'Y';
-                               include($file2);
-                       }
-                        else
-                       {
-                               // Don't load language file
-                               $lang = 'N';
-                       }
+                       // Transfer EXT_ALWAYS_ACTIVE flag
+                       $content['ext_keep'] = EXT_GET_ALWAYS_ACTIVE();
 
-                       // Load extension
-                       if ($name != "sql_patches")
-                       {
-                               // Load extension's file
-                               include_once($file1);
-                       }
-                        else
-                       {
-                               // KEEP sql_patches ALWAYS ACTIVE!
-                               $EXT_ALWAYS_ACTIVE = 'Y';
-                       }
+                       // CSS file handling:
+                       if ((!isset($content['ext_css'])) || ($content['ext_css'] == 'Y')) {
+                               // Create FQFN for the CSS file
+                               $FQFN = sprintf("%stheme/%s/css/%s.css", constant('PATH'), getCurrentTheme(), $content['ext_name']);
 
-                       if ($css == 'Y')
-                       {
-                               $CSS_FILE = PATH."theme/".GET_CURR_THEME()."/css/".$name.".css";
-                               if (file_exists($CSS_FILE))
-                               {
+                               // Is the file there?
+                               if (isFileReadable($FQFN)) {
                                        // CSS file for extension was found (use only relative path for now!)
-                                       $EXT_CSS_FILES[] = $name.".css";
-                               }
-                                else
-                               {
+                                       EXT_ADD_CSS_FILE($content['ext_name'] . '.css');
+                                       $content['ext_css'] = 'Y';
+                               } else {
                                        // Don't load CSS file
-                                       $css = 'N';
+                                       $content['ext_css'] = 'N';
                                }
-                       }
+                       } // END - if
 
-                       // Add cache row
-                       if ($cacheMode == "init")
-                       {
-                               $cacheInstance->add_row(array(
-                                       'ext_id'      => $EXT_ID,
-                                       'ext_name'    => $name,
-                                       'ext_lang'    => $lang,
-                                       'ext_css'     => $css,
-                                       'ext_menu'    => $menu,
-                                       'ext_funcs'   => $funcs,
-                                       'ext_active'  => $active,
-                                       'ext_version' => $version,
-                                       'ext_keep'    => $EXT_ALWAYS_ACTIVE,
-                               ));
-                       }
-                        elseif ($cacheMode == "no")
-                       {
+                       // Shall we cache?
+                       if ($GLOBALS['cache_mode'] == 'init') {
+                               // Add cache row
+                               $GLOBALS['cache_instance']->addRow($content);
+                       } elseif ($GLOBALS['cache_mode'] == 'no') {
                                // Remember this value for later usage
-                               $cacheArray['active_extensions'][$name] = $EXT_ALWAYS_ACTIVE;
+                               $GLOBALS['cache_array']['active_extensions'][$content['ext_name']] = EXT_GET_ALWAYS_ACTIVE();
                        }
-               }
-                elseif (!file_exists($file1))
-               {
+               } elseif (!isFileReadable($FQFN)) {
                        // Deleted extension file so we mark it for removal from DB
-                       $DEL[] = $name;
+                       $DEL[] = $content['ext_name'];
                }
-       }
+       } // END - while
+
+       // Init filter system
+       initFilterSystem();
 
-       if ($cacheMode == "init")
-       {
+       if ($GLOBALS['cache_mode'] == 'init') {
                // Close cache file
-               $cacheInstance->cache_close();
+               $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')) {
+       // Init filter system even when there are no extensions installed. #16
+       initFilterSystem();
 }
 
-// Free memory
-SQL_FREERESULT($res_ext_crt);
-
-// Load include files
-if (!empty($INC_POOL[0]))
-{
-       foreach ($INC_POOL as $inc)
-       {
-               require_once($inc);
-       }
-}
+// Run the filter
+runFilterChain('load_includes');
 
 // Uninstall extensions that are no longer in our system
-if (!empty($DEL[0]))
-{
+if (!empty($DEL[0])) {
        // Remove extensions from two tables: extension registry and tasks table
-       foreach ($DEL as $name)
-       {
+       foreach ($DEL as $del_ext) {
                // First remove entry from extensions table
-               $result = SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
-                array($name), __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
-               $result = SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_task_system WHERE subject LIKE '[%s:] %' AND (task_type='EXTENSION' OR task_type='EXTENSION_UPDATE')",
-                array($name), __FILE__, __LINE__);
-       }
+               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
 
        // I think it's not neccessary to run the optimization function here
        // because we didn't delete so much data from database. Can you aggree?
-}
+} // END - if
+
 //
 ?>