Cache class rewritten to better convention
[mailer.git] / inc / load_extensions.php
index 1b5d401..256cb97 100644 (file)
  ************************************************************************/
 
 // Some security stuff...
-if (ereg(basename(__FILE__), $_SERVER['PHP_SELF']))
-{
+if (!defined('__SECURITY')) {
        $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 = "";
@@ -56,40 +56,57 @@ if (FILE_READABLE(PATH."inc/extensions/ext-sql_patches.php")) {
        $cacheArray['active_extensions'] = array();
 }
 
+// By default no cache is set
+$cacheMode = "no";
+
 //
 // Load extensions
 //
 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)) {
+
+       // Check extension cache
+       switch (($cacheInstance->loadCacheFile("extensions", true)) && ($cacheInstance->extensionVersionMatches("sql_patches"))) {
                case true : $cacheMode = "load"; break;
                case false: $cacheMode = "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 {
-       // Cache extension not active
-       $cacheMode = "no";
-}
+       // Do we need to init the cache?
+       if (($cacheMode == "init") && ($_CONFIG['cache_exts'] == "Y")) {
+               // Init cache file
+               $cacheInstance->init("EXTENSIONS");
+               $cacheInstance->storeExtensionVersion("sql_patches");
+       } elseif ($_CONFIG['cache_exts'] == "N") {
+               // Cache will not be created for extensions
+               $cacheMode = "skip";
+       }
+} // END - if
 
+// Load cache?
 if ($cacheMode == "load") {
-       // Load more cache files (like admins)
-       require_once(PATH."inc/load_cache.php");
+       // Init include array
+       $EXT_POOL = array();
 
        // Re-initialize handler
-       $cacheInstance->cache_file("extensions", true);
+       $cacheInstance->loadCacheFile("extensions", true);
 
        // Load extension data from cache file
-       $EXT_DUMMY = $cacheInstance->cache_load();
+       $EXT_DUMMY = $cacheInstance->getArrayFromCache();
+
+       // Is the cache file fine?
+       if (!isset($EXT_DUMMY['ext_name'])) {
+               // Cache file is damaged so kill it
+               $cacheInstance->destroyCacheFile();
+
+               // Skip any further execution
+               return;
+       } // END -  if
+
+       // Begin with the cache preparation of extensions
        $EXT_NAMES = array();
-       foreach ($EXT_DUMMY['ext_name'] as $k=>$name) {
+       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");
@@ -98,7 +115,10 @@ if ($cacheMode == "load") {
                // 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)) require_once($INC);
+                       if (FILE_READABLE($INC)) {
+                               // Add it
+                               $EXT_POOL[] = $INC;
+                       } // END -  if
                } // END - if
 
                // Load CSS file
@@ -106,18 +126,21 @@ if ($cacheMode == "load") {
 
                // 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");
+                       $EXT_POOL[] = sprintf("%sinc/extensions/ext-%s.php", PATH, $name);
                } // END - if
 
                // 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]);
+
                // Extension id
                $EXT_DUMMY['ext_id'][$name] = $EXT_DUMMY['ext_id'][$k];
                $id = $EXT_DUMMY['ext_id'][$name];
@@ -126,6 +149,9 @@ if ($cacheMode == "load") {
                // 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
                $cacheArray['active_extensions']['$name'] = $EXT_DUMMY['ext_keep'][$k];
                unset($EXT_DUMMY['ext_keep'][$k]);
@@ -140,9 +166,6 @@ if ($cacheMode == "load") {
        $EXT_DUMMY['ext_name'] = $EXT_NAMES;
        unset($EXT_NAMES);
 
-       // Close cache file
-       $cacheInstance->cache_close();
-
        // Loading cache is done so let's free some memory!
        unset($EXT_DUMMY['ext_lang']);
        unset($EXT_DUMMY['ext_keep']);
@@ -153,19 +176,31 @@ if ($cacheMode == "load") {
 
        // 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);
+       } // END - foreach
+
+       // 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 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 (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
+               $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."
 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
+               // 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."
 ORDER BY ext_name", __FILE__, __LINE__);
        }
@@ -175,128 +210,130 @@ 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")) {
+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 we need to init the cache init it now
-       if ($cacheMode == "init") $cacheInstance->cache_init("EXTENSIONS");
-
        // 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
-               $menu = "N";
-               if (MODULE_HAS_MENU($name, true)) {
-                       $menu = "Y";
+               $content['ext_menu'] = "N";
+               if (MODULE_HAS_MENU($content['ext_name'], true)) {
+                       $content['ext_menu'] = "Y";
                } // END - if
 
                // Load extensions
-               $file1 = sprintf("%sinc/extensions/ext-%s.php", PATH, $name);
+               $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, $name);
+               $file3 = sprintf("%sinc/libs/%s_functions.php", 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($lang)) {
+                       if (!empty($content['ext_lang'])) {
                                // Create language file
-                               $file2 = sprintf("%sinc/language/%s_%s.php", PATH, $lang, GET_LANGUAGE());
-                       }
+                               $file2 = sprintf("%sinc/language/%s_%s.php", PATH, $content['ext_lang'], GET_LANGUAGE());
+                       } // END - if
 
                        if (FILE_READABLE($file3)) {
                                // Special functions file
-                               $funcs = "Y";
+                               $content['ext_funcs'] = "Y";
                                require_once($file3);
                        } else {
                                // Don't load functions file
-                               $funcs = "N";
+                               $content['ext_funcs'] = "N";
                        }
 
                        // Do we need a language file?
                        if (($file1 != $file2) && (FILE_READABLE($file2))) {
                                // Load language file
-                               $lang = "Y";
+                               $content['ext_lang'] = "Y";
                                include($file2);
                        } else {
                                // Don't load language file
-                               $lang = "N";
+                               $content['ext_lang'] = "N";
                        }
 
+                       // By default no extension is always active, except sql_patches
+                       $EXT_ALWAYS_ACTIVE = "N";
+
                        // Load extension
-                       if ($name != "sql_patches") {
+                       if ($content['ext_name'] != "sql_patches") {
                                // Load extension's file
                                include_once($file1);
                        } else {
-                               // KEEP sql_patches ALWAYS ACTIVE!
+                               // Keep sql_patches always active
                                $EXT_ALWAYS_ACTIVE = "Y";
                        }
 
-                       if ($css == "Y") {
-                               $CSS_FILE = sprintf("%stheme/%s/css/%s.css", PATH, GET_CURR_THEME(), $name);
+                       // Transfer EXT_ALWAYS_ACTIVE flag
+                       $content['ext_keep'] = $EXT_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']);
+
+                               // Is the file there?
                                if (FILE_READABLE($CSS_FILE)) {
                                        // CSS file for extension was found (use only relative path for now!)
-                                       $EXT_CSS_FILES[] = $name.".css";
+                                       $EXT_CSS_FILES[] = $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
+                       // Shall we cache?
                        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,
-                               ));
+                               // Add cache row
+                               $cacheInstance->addRow($content);
                        } elseif ($cacheMode == "no") {
                                // Remember this value for later usage
-                               $cacheArray['active_extensions'][$name] = $EXT_ALWAYS_ACTIVE;
+                               $cacheArray['active_extensions'][$content['ext_name']] = $EXT_ALWAYS_ACTIVE;
                        }
                } elseif (!FILE_READABLE($file1)) {
                        // Deleted extension file so we mark it for removal from DB
-                       $DEL[] = $name;
+                       $DEL[] = $content['ext_name'];
                }
        } // END - while
 
        if ($cacheMode == "init") {
                // Close cache file
-               $cacheInstance->cache_close();
+               $cacheInstance->finalize();
 
                // Load more cache files (like admins)
                require_once(PATH."inc/load_cache.php");
        } // END - if
-}
 
-// Free memory
-SQL_FREERESULT($res_ext_crt);
+       // Free memory
+       SQL_FREERESULT($res_ext_crt);
+} // END - if
 
-// Load include files
+// Load include files if found
 if (!empty($INC_POOL[0])) {
        foreach ($INC_POOL as $inc) {
                require_once($inc);
        } // END - foreach
+
+       // Remove array
+       unset($INC_POOL);
 } // END - if
 
 // 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 $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 LIKE '[%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