]> git.mxchange.org Git - mailer.git/blobdiff - inc/extensions.php
Extension loader rewritten and no more needed cache elements removed
[mailer.git] / inc / extensions.php
index 608efa6227dea95ea363a96639f43ab3243da597..29ea00c7bbc5ec444a870b36f2457c10ef17a0e6 100644 (file)
@@ -37,13 +37,63 @@ if (!defined('__SECURITY')) {
        require($INC);
 }
 
+// Load the extension and maybe found language and function files
+function LOAD_EXTENSION ($ext_name) {
+       global $EXT_LOADED, $_CONFIG, $CSS, $cacheMode;
+
+       // Is the extension already loaded?
+       if (isset($EXT_LOADED[$ext_name])) {
+               // Debug message
+               DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name));
+               return false;
+       }
+
+       // Construct FQFN for extension file
+       $extInclude = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
+
+       // Is the extension file NOT there?
+       if (!FILE_READABLE($extInclude)) {
+               // Debug message
+               DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s not found.", $ext_name));
+
+               // Abort here
+               return false;
+       } // END - if
+
+       // Construct FQFN for language file
+       $langInclude = sprintf("%sinc/language/%s_%s.php", PATH, $ext_name, GET_LANGUAGE());
+
+       // Is this include there?
+       if (FILE_READABLE($langInclude)) {
+               // Then load it
+               require($langInclude);
+       } // END - if
+
+       // Construct FQFN for functions file
+       $funcsInclude = sprintf("%sinc/libs/%s_functions.php", PATH, $ext_name);
+
+       // Is this include there?
+       if (FILE_READABLE($funcsInclude)) {
+               // Then load it
+               require($funcsInclude);
+       } // END - if
+
+       // Set extension load mode to nothing (default)
+       $EXT_LOAD_MODE = "";
+
+       // Include the extension file
+       require($extInclude);
+
+       // Mark it as loaded
+       $EXT_LOADED[$ext_name] = true;
+
+       // All fine!
+       return true;
+}
+
 //
-function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
-{
+function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false) {
        global $NOTES, $_CONFIG, $INC_POOL, $cacheInstance;
-       // We want to register an extension and registration status is by default "failed" (= false)
-       $EXT_LOAD_MODE = "register"; $ret = false; $SQLs = array();
-       $INC_POOL = array();
 
        // This shall never do a non-admin user!
        if (!IS_ADMIN()) return false;
@@ -51,12 +101,22 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
        // Is this extension already installed?
        if (EXT_IS_ACTIVE($ext_name)) return false;
 
+       // We want to register an extension and registration status is by default "failed" (= false)
+       $EXT_LOAD_MODE = "register"; $ret = false; $SQLs = array();
+       $INC_POOL = array();
+
+       // By default the language prefix is the extension's name
+       // @TODO: Do we really need this one anymore? Can't we just take $ext_name and done?
+       // By default we have no failtures
+       $EXT_REPORTS_FAILURE = false;
+
        // Generate file name
        $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
 
        // Does this extension exists?
        if (FILE_READABLE($file)) {
                // Extension was found so we can load it in registration mode
+               $EXT_ALWAYS_ACTIVE = "N";
                require($file);
 
                // And run possible updates
@@ -88,24 +148,27 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
                        $SQLs  = array();
                        $test  = false;
 
-                       // Backup language as well
-                       $LANG_BCK = $EXT_LANG_PREFIX;
-                       $EXT_ALWAYS_ACTIVE = "N";
-
                        // Load required extension also in update mode
                        $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $EXT_UPDATE_DEPENDS);
 
                        // Check for required file
                        if (FILE_READABLE($file)) {
-                               // File exists so let's load it
+                               // Bacup version number
                                $VER_BACKUP = $EXT_VERSION;
+
+                               // Save the Parrent $EXT_ALWAYS_ACTIVE for later!
+                               $EXT_ALWAYS_ACTIVE_PARRENT = $EXT_ALWAYS_ACTIVE;
+
+                               // Set EXT_ALWAYS_ACTIVE for update
+                               $EXT_ALWAYS_ACTIVE = "N";
+
+                               // File exists so let's load it
                                require($file);
-                               $EXT_VERSION = $VER_BACKUP;
 
                                // If versions mismatch update extension first
                                $ext_ver = GET_EXT_VERSION($EXT_UPDATE_DEPENDS);
 
-                               // Extension version set?
+                               // Extension version set? If empty the extension is not registered
                                if (empty($ext_ver)) {
                                        // Extension not registered so far so first load task's ID...
                                        $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_task_system WHERE task_type='EXTENSION' AND subject LIKE '[%s:]%%' LIMIT 1",
@@ -132,6 +195,12 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
                                        // Nothing to register / update before...
                                        $test = true;
                                }
+
+                               // Restore version number
+                               $EXT_VERSION = $VER_BACKUP;
+
+                               // Restore $EXT_ALWAYS_ACTIVE with the value from parrent
+                               $EXT_ALWAYS_ACTIVE = $EXT_ALWAYS_ACTIVE_PARRENT;
                        } else {
                                // Required file for update does not exists!
                                $test = true;
@@ -140,7 +209,6 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
 
                        // Finally restore previous SQLs
                        $SQLs = $SQLs2; unset($SQLs2);
-                       $EXT_LANG_PREFIX = $LANG_BCK;
                } else {
                        // Does not depend on an other extension
                        $test = true;
@@ -149,6 +217,9 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
                // Switch back to register mode
                $EXT_LOAD_MODE = "register";
 
+               // Remains true if extension registration reports no failtures
+               $test = ($test && !$EXT_REPORTS_FAILURE);
+
                // Does everthing before wents ok?
                if ($test) {
                        // "Dry-run-mode" activated?
@@ -175,9 +246,9 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
                                if ((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) {
                                        //* DEBUG: */ echo __LINE__.": DESTROY!<br />\n";
                                        // Remove cache files
-                                       if ($cacheInstance->cache_file("extensions", true)) $cacheInstance->cache_destroy();
-                                       if ($cacheInstance->cache_file("mod_reg", true))    $cacheInstance->cache_destroy();
-                                       if ($cacheInstance->cache_file("config", true))     $cacheInstance->cache_destroy();
+                                       if ($cacheInstance->loadCacheFile("extensions", true)) $cacheInstance->destroyCacheFile();
+                                       if ($cacheInstance->loadCacheFile("mod_reg"))          $cacheInstance->destroyCacheFile();
+                                       if ($cacheInstance->loadCacheFile("config"))           $cacheInstance->destroyCacheFile();
                                } // END - if
 
                                // Check for added include files
@@ -186,11 +257,14 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
                                        foreach ($INC_POOL as $inc) {
                                                require_once($inc);
                                        } // END - foreach
+
+                                       // Remove array
+                                       unset($INC_POOL);
                                } // END - if
 
                                // Register extension
-                               $result = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_extensions (ext_name, ext_lang_file, ext_active, ext_version) VALUES ('%s','%s','%s','%s')",
-                                array($ext_name, $EXT_LANG_PREFIX, $EXT_ALWAYS_ACTIVE, $EXT_VERSION), __FILE__, __LINE__);
+                               $result = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_extensions (ext_name, ext_active, ext_version) VALUES ('%s','%s','%s','%s')",
+                                array($ext_name, $EXT_ALWAYS_ACTIVE, $EXT_VERSION), __FILE__, __LINE__);
 
                                // Update task management
                                ADMIN_SOLVE_TASK($id);
@@ -239,9 +313,12 @@ function EXTENSION_REGISTER ($ext_name, $id, $dry_run=false)
 }
 //
 function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) {
-       global $cacheInstance;
+       global $cacheInstance, $_CONFIG;
        $SQLs = array();
 
+       // Extensions are never active by default
+       $EXT_ALWAYS_ACTIVE = "N";
+
        // By default no SQL has been executed
        $sqlRan = false;
 
@@ -253,14 +330,14 @@ function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) {
        if (empty($ext_name)) return false;
 
        // Load extension in detected mode
-       //* DEBUG: */ echo __FUNCTION__.":ext_name[{$id}]={$ext_name}<br />\n";
+       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):ext_name[{$id}]={$ext_name}<br />\n";
        $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
        if (FILE_READABLE($file)) {
                // Load the include
                require($file);
        } // END - if
 
-       //* DEBUG: */ echo __FUNCTION__.":SQLs::count=".count($SQLs)."<br />\n";
+       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):SQLs::count=".count($SQLs)."<br />\n";
        if ((is_array($SQLs) && (sizeof($SQLs) > 0))) {
                // Run SQL commands...
                foreach ($SQLs as $sql) {
@@ -270,7 +347,7 @@ function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) {
                        // Is there still an SQL query?
                        if (!empty($sql)) {
                                // Do we have an "ALTER TABLE" command?
-                               //* DEBUG: */ echo __FUNCTION__.":SQL={$SQL}<br />\n";
+                               //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):SQL={$SQL}<br />\n";
                                if (substr(strtolower($sql), 0, 11) == "alter table") {
                                        // Analyse the alteration command
                                        SQL_ALTER_TABLE($sql, __FILE__, __LINE__);
@@ -291,19 +368,7 @@ function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) {
                         array($id), __FILE__, __LINE__);
                } // END - if
 
-               //* DEBUG: */ echo __FUNCTION__.":mode={$EXT_LOAD_MODE}<br />\n";
-
-               // Remove cache file(s) if extension is active
-               if (((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) && (((SQL_AFFECTEDROWS() == 1) && ($EXT_LOAD_MODE == "remove")) || ($sqlRan === true))) {
-                       //* DEBUG: */ echo __LINE__.": DESTROY!<br />\n";
-                       // Remove cache files
-                       if ($cacheInstance->cache_file("extensions", true)) $cacheInstance->cache_destroy();
-                       if ($cacheInstance->cache_file("mod_reg", true))    $cacheInstance->cache_destroy();
-                       if ($cacheInstance->cache_file("config", true))     $cacheInstance->cache_destroy();
-
-                       // @TODO This causes the whole (!) menu cache being purged
-                       CACHE_PURGE_ADMIN_MENU();
-               } // END - if
+               //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):mode={$EXT_LOAD_MODE}<br />\n";
 
                // Is this the sql_patches?
                //* DEBUG: */ echo __LINE__.": {$id}/{$ext_name}/{$EXT_LOAD_MODE}<br />\n";
@@ -313,6 +378,18 @@ function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) {
                        LOAD_URL("modules.php?module=admin&logout=1&".$EXT_LOAD_MODE."=sql_patches");
                } // END - if
        } // END - if
+
+       // Remove cache file(s) if extension is active
+       if (((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) && (((SQL_AFFECTEDROWS() == 1)) || ($sqlRan === true) || ($EXT_LOAD_MODE == "activate") || ($EXT_LOAD_MODE == "deactivate"))) {
+               //* DEBUG: */ echo __LINE__.": DESTROY!<br />\n";
+               // Remove cache files
+               if ($cacheInstance->loadCacheFile("extensions", true)) $cacheInstance->destroyCacheFile();
+               if ($cacheInstance->loadCacheFile("mod_reg"))    $cacheInstance->destroyCacheFile();
+               if ($cacheInstance->loadCacheFile("config"))     $cacheInstance->destroyCacheFile();
+
+               // @TODO This causes the whole (!) menu cache being purged
+               CACHE_PURGE_ADMIN_MENU();
+       } // END - if
 }
 // Check if given extension is active
 function EXT_IS_ACTIVE ($ext_name) {
@@ -341,11 +418,16 @@ function EXT_IS_ACTIVE ($ext_name) {
                        // Extension was not found!
                        return false;
                }
+
+               // Load entry
                list($active) = SQL_FETCHROW($result);
-               //* DEBUG: */ echo $ext_name."[DB]: {$active}<br />\n";
+
+               // Free result
                SQL_FREERESULT($result);
 
+
                // Write cache array
+               //* DEBUG: */ echo $ext_name."[DB]: {$active}<br />\n";
                $cacheArray['extensions']['ext_active'][$ext_name] = $active;
        } else {
                // Extension not active!
@@ -353,11 +435,8 @@ function EXT_IS_ACTIVE ($ext_name) {
                $cacheArray['extensions']['ext_active'][$ext_name] = "N";
        }
 
-       // Create FQFN for extension file
-       $inc = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
-
        // Debug message
-       //DEBUG_LOG(__FUNCTION__.": ext_name={$ext_name},active={$active}");
+       //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " ext_name={$ext_name},active={$active}");
 
        // Is this extension activated? (For admins we always have active extensions...)
        return ($active == "Y");
@@ -369,12 +448,12 @@ function GET_EXT_VERSION ($ext_name) {
 
        // Extensions are all inactive during installation
        if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing'))) return "";
-       //* DEBUG: */ echo __FUNCTION__.": ext_name={$ext_name}<br />\n";
+       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ext_name={$ext_name}<br />\n";
 
        // Is the cache written?
        if (!empty($cacheArray['extensions']['ext_version'][$ext_name])) {
                // Load data from cache
-               //* DEBUG: */ echo __FUNCTION__.": CACHE!<br />\n";
+               //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): CACHE!<br />\n";
                $ret = $cacheArray['extensions']['ext_version'][$ext_name];
 
                // Count cache hits
@@ -391,14 +470,19 @@ function GET_EXT_VERSION ($ext_name) {
        }
 
        // Return result
-       //* DEBUG: */ echo __FUNCTION__.": ret={$ret}<br />\n";
+       //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ret={$ret}<br />\n";
        return $ret;
 }
 //
 function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false)
 {
        // This shall never do a non-admin user!
-       global $cacheInstance, $_CONFIG, $NOTES; $SQLs = array();
+       global $cacheInstance, $_CONFIG, $NOTES;
+
+       // Init arrays
+       $SQLs = array(); $INC_POOL = array();
+
+       // Only admins are allowed to update extensions
        if ((!IS_ADMIN()) || (empty($ext))) return false;
 
        // Load extension in update mode
@@ -452,9 +536,16 @@ function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false)
                                }
                        }
 
+                       // In real-mode execute any existing includes
+                       if ((!$dry_run) && (count($INC_POOL) > 0)) {
+                               // Include all files
+                               foreach ($INC_POOL as $fqfn) {
+                                       require_once($fqfn);
+                               } // END - foreach
+                       } // END - if
+
                        // Run SQLs
-                       if ((is_array($SQLs)) && (!$dry_run))
-                       {
+                       if ((is_array($SQLs)) && (!$dry_run)) {
                                // Run SQL commands
                                foreach ($SQLs as $sql)
                                {
@@ -491,9 +582,9 @@ function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false)
 
                        // Update cache
                        if (EXT_IS_ACTIVE("cache")) {
-                               if ($cacheInstance->cache_file("extensions", true) == true) $cacheInstance->cache_destroy();
-                               if ($cacheInstance->cache_file("config", true) == true)     $cacheInstance->cache_destroy();
-                               if ($cacheInstance->cache_file("mod_reg", true) == true)    $cacheInstance->cache_destroy();
+                               if ($cacheInstance->loadCacheFile("extensions", true)) $cacheInstance->destroyCacheFile();
+                               if ($cacheInstance->loadCacheFile("config")) $cacheInstance->destroyCacheFile();
+                               if ($cacheInstance->loadCacheFile("mod_reg")) $cacheInstance->destroyCacheFile();
                        } // END - if
 
                        // Remove array
@@ -504,7 +595,8 @@ function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false)
                }
        }
 }
-//
+
+// Output verbose SQL table for extension
 function EXTENSION_VERBOSE_TABLE($SQLs, $title = ADMIN_SQLS_EXECUTED_ON_REMOVAL, $dashed = "", $switch = false, $WIDTH = "480") {
        global $_CONFIG;
 
@@ -552,6 +644,7 @@ function EXTENSION_VERBOSE_TABLE($SQLs, $title = ADMIN_SQLS_EXECUTED_ON_REMOVAL,
        // Return output
        return $OUT;
 }
+
 // Get extension name from id
 function GET_EXT_NAME ($id) {
        $ret = "";
@@ -561,7 +654,7 @@ function GET_EXT_NAME ($id) {
                $ret = $cacheArray['extensions']['ext_name'][$id];
 
                // Count cache hits
-               $_CONFIG['cache_hits']++;
+               if (isset($_CONFIG['cache_hits'])) { $_CONFIG['cache_hits']++; } else { $_CONFIG['cache_hits'] = 1; }
        } elseif (!EXT_IS_ACTIVE("cache")) {
                // Load from database
                $result = SQL_QUERY_ESC("SELECT ext_name FROM "._MYSQL_PREFIX."_extensions WHERE id=%s LIMIT 1",
@@ -571,6 +664,7 @@ function GET_EXT_NAME ($id) {
        }
        return $ret;
 }
+
 // Get extension id from name
 function GET_EXT_ID($name) {
        $ret = 0;
@@ -580,7 +674,7 @@ function GET_EXT_ID($name) {
                $ret = $cacheArray['extensions']['ext_id'][$name];
 
                // Count cache hits
-               $_CONFIG['cache_hits']++;
+               if (isset($_CONFIG['cache_hits'])) { $_CONFIG['cache_hits']++; } else { $_CONFIG['cache_hits'] = 1; }
        } elseif (!EXT_IS_ACTIVE("cache")) {
                // Load from database
                $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
@@ -592,6 +686,7 @@ function GET_EXT_ID($name) {
        // Return value
        return $ret;
 }
+
 // Activate given extension
 function ACTIVATE_EXTENSION($ext_name) {
        // Activate the extension
@@ -604,6 +699,7 @@ function ACTIVATE_EXTENSION($ext_name) {
                EXTENSION_RUN_SQLS(GET_EXT_ID($ext_name), "activate");
        } // END - if
 }
+
 // Checks wether the extension is older than given
 function EXT_VERSION_IS_OLDER ($ext_name, $ext_ver) {
        // Get current extension version