* -------------------------------------------------------------------- *
* Kurzbeschreibung : Erweiterungen-Management *
* -------------------------------------------------------------------- *
- * *
+ * $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']))
-{
+if (!defined('__SECURITY')) {
$INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
require($INC);
}
-//
-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;
+// Load the extension and maybe found language and function files.
+function LOAD_EXTENSION ($ext_name, $EXT_LOAD_MODE = "", $EXT_VER = "", $dry_run = false) {
+ // Set current extension name
+ EXT_SET_CURR_NAME($ext_name);
+
+ // Init array
+ INIT_INC_POOL();
+
+ // Init EXT_UPDATE_DEPENDS
+ EXT_INIT_UPDATE_DEPENDS();
+
+ // Init current extension name list
+ INIT_EXT_SQLS();
+
+ // Is the extension already loaded?
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Loading extension {$ext_name}, mode={$EXT_LOAD_MODE}, ver={$EXT_VER}.");
+ if ((isset($GLOBALS['ext_loaded']['ext'][$ext_name])) && (empty($EXT_LOAD_MODE))) {
+ // Debug message
+ DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name));
+ return false;
+ } // END - if
+
+ // Construct include filename and FQFN for extension file
+ $INC = sprintf("inc/extensions/ext-%s.php", $ext_name);
+ $FQFN = constant('PATH') . $INC;
+
+ // Is the extension file NOT there?
+ if (!INCLUDE_READABLE($INC)) {
+ // 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("inc/language/%s_%s.php", $ext_name, GET_LANGUAGE());
+
+ // Is this include there?
+ if ((FILE_READABLE($langInclude)) && (!isset($GLOBALS['ext_loaded']['lang'][$ext_name]))) {
+ // Then load it
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "--- Language loaded.");
+ $GLOBALS['ext_loaded']['lang'][$ext_name] = true;
+ LOAD_INC_ONCE($langInclude);
+ } // END - if
+
+ // Construct FQFN for functions file
+ $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
+
+ // Is this include there?
+ if ((FILE_READABLE($funcsInclude)) && (!isset($GLOBALS['ext_loaded']['funcs'][$ext_name]))) {
+ // Then load it
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "--- Functions loaded.");
+ $GLOBALS['ext_loaded']['funcs'][$ext_name] = true;
+ LOAD_INC_ONCE($funcsInclude);
+ } // END - if
+
+ // Extensions are not deprecated by default
+ EXT_SET_DEPRECATED("N");
+
+ // Extensions are not always active by default
+ EXT_SET_ALWAYS_ACTIVE("N");
+
+ // Extension update notes
+ EXT_SET_UPDATE_NOTES("");
- // Is this extension already installed?
- if (EXT_IS_ACTIVE($ext_name)) return false;
+ // Include the extension file
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "Extension loaded.");
+ require($FQFN);
- // Generate file name
- $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
+ // Is this extension deprecated?
+ if (EXT_GET_DEPRECATED() == "Y") {
+ // Deactivate the extension
+ DEACTIVATE_EXTENSION($ext_name);
+
+ // Abort here
+ return false;
+ } // END - if
+
+ // Mark it as loaded in normal mode
+ if (empty($EXT_LOAD_MODE)) {
+ // Mark it now...
+ $GLOBALS['ext_loaded']['ext'][$ext_name] = true;
+ } // END - if
+
+ // All fine!
+ return true;
+}
+
+// Registeres an extension and possible update depencies
+function REGISTER_EXTENSION ($ext_name, $task_id, $dry_run = false, $logout = true) {
+ // Set current extension name
+ EXT_SET_CURR_NAME($ext_name);
+
+ //* DEBUG: */ print __FUNCTION__."[".__LINE__."]:currName=".EXT_GET_CURR_NAME()." - ENTERED!<br />\n";
+ // This shall never do a non-admin user or if the extension is active (already installed)
+ if ((!IS_ADMIN()) || (EXT_IS_ACTIVE($ext_name))) {
+ return false;
+ } // END - if
+
+ // When this extension is already in install/update phase, all is fine
+ if (EXT_IS_REGISTER_RUNNING($ext_name)) {
+ // Then abort here which is fine
+ //* DEBUG: */ print __FUNCTION__."[".__LINE__."]:currName=".EXT_GET_CURR_NAME()." - ALREADY!<br />\n";
+ return true;
+ } // END - if
+
+ // This registration is running
+ EXT_ADD_RUNNING_REGISTRATION($ext_name);
+
+ // Init EXT_UPDATE_DEPENDS
+ EXT_INIT_UPDATE_DEPENDS();
+
+ // Is the task id zero? Then we need to auto-fix it here
+ if ($task_id == 0) {
+ // Try to find the task
+ $task_id = DETERMINE_EXTENSION_TASK_ID(EXT_GET_CURR_NAME());
+
+ // Still zero and not in dry-run?
+ if (($task_id == 0) && (!$dry_run)) {
+ // Then request a bug report
+ debug_report_bug(sprintf("%s: task_id is still zero after DETERMINE_EXTENSION_TASK_ID(%s)",
+ __FUNCTION__,
+ EXT_GET_CURR_NAME()
+ ));
+ } // END - if
+ } // END - if
+
+ // Init queries and notes
+ INIT_EXT_SQLS();
+ EXT_INIT_NOTES();
+
+ // Init variables
+ $ret = false;
+ $test = false;
+ INIT_INC_POOL();
+
+ // By default we have no failures
+ EXT_SET_REPORTS_FAILURE(false);
// Does this extension exists?
- if (file_exists($file) && is_readable($file))
- {
- // Extension was found so we can load it in registration mode
- require($file);
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "currName=".EXT_GET_CURR_NAME()."");
+ if (LOAD_EXTENSION(EXT_GET_CURR_NAME(), "register", "", $dry_run)) {
+ // Set current extension name again
+ EXT_SET_CURR_NAME($ext_name);
// And run possible updates
- $EXT_LOAD_MODE = "update"; $EXT_UPDATE_DEPENDS = "";
- foreach ($EXT_VER_HISTORY as $EXT_VER)
- {
- require($file);
- if (((GET_EXT_VERSION("sql_patches") != '') && ($_CONFIG['verbose_sql'] == "Y")) || (!EXT_IS_ACTIVE("sql_patches")))
- {
- if (!empty($UPDATE_NOTES))
- {
- // Update notes found
- $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br />".$UPDATE_NOTES."<br /><br />\n";
- $UPDATE_NOTES = "";
- }
- elseif (($EXT_VER == "0.0") || ($EXT_VER == "0.0.0"))
- {
- // Initial release
- $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br />".INITIAL_RELEASE."<br /><br />\n";
- }
- else
- {
- $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br /><I>".NO_UPDATE_NOTES."</I><br /><br />\n";
- }
- }
- }
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "".EXT_GET_CURR_NAME());
+ $history = EXT_GET_VER_HISTORY();
+ foreach ($history as $ver) {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "ext_name=".EXT_GET_CURR_NAME().", ext_ver={$ver}");
+ // Load extension in update mode
+ LOAD_EXTENSION(EXT_GET_CURR_NAME(), "update", $ver, $dry_run);
- // Does this extension depends on an outstanding update of another update?
- if (!empty($EXT_UPDATE_DEPENDS))
- {
- // Backup SQL commands and clear current
- $SQLs2 = $SQLs; $SQLs = array(); $test = false;
+ // Add update notes to our output
+ ADD_EXTENSION_NOTES($ver);
+ } // END - foreach
- // Backup language as well
- $LANG_BCK = $EXT_LANG_PREFIX; $EXT_ALWAYS_ACTIVE = "N";
+ // Does this extension depends on an outstanding update of another update?
+ for ($dmy = EXT_GET_UPDATE_ITERATOR(); EXT_GET_UPDATE_ITERATOR() < EXT_COUNT_UPDATE_DEPENDS();) {
+ // Get next update
+ $ext_update = EXT_GET_ITERATOR_UPDATE_DEPENDS();
- // Load required extension also in update mode
- $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $EXT_UPDATE_DEPENDS);
+ // Increment here to avoid endless loop
+ EXT_INCREMENT_UPDATE_INTERATOR();
// Check for required file
- if (file_exists($file) && is_readable($file))
- {
- // File exists so let's load it
- $VER_BACKUP = $EXT_VERSION;
- require($file);
- $EXT_VERSION = $VER_BACKUP;
+ if (LOAD_EXTENSION($ext_update, "register", "", $dry_run)) {
+ // Set current extension name again
+ EXT_SET_CURR_NAME($ext_name);
// If versions mismatch update extension first
- $ext_ver = GET_EXT_VERSION($EXT_UPDATE_DEPENDS);
- if (empty($ext_ver))
- {
+ $ext_ver = GET_EXT_VERSION($ext_update);
+
+ // 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",
- array($EXT_UPDATE_DEPENDS), __FILE__, __LINE__);
- if (SQL_NUMROWS($result) == 1)
- {
- // Task found so load task's ID and register extension...
- list($task) = SQL_FETCHROW($result);
- SQL_FREERESULT($result);
- $test = EXTENSION_REGISTER($EXT_UPDATE_DEPENDS, $task, $dry_run);
- }
- }
- elseif ($ext_ver != $EXT_VERSION)
- {
+ $task = DETERMINE_EXTENSION_TASK_ID($ext_update);
+
+ // Entry found?
+ if ($task > 0) {
+ // Try to register the extension
+ //* DEBUG: */ print __FUNCTION__."[".__LINE__."]:currName=".EXT_GET_CURR_NAME().":ext_update=".$ext_update.",taskId=".$task."<br />\n";
+ $test = REGISTER_EXTENSION($ext_update, $task, $dry_run, false);
+ //* DEBUG: */ print __FUNCTION__."[".__LINE__."]:currName=".EXT_GET_CURR_NAME().":"; var_dump($test);
+ } // END - if
+ } elseif ($ext_ver != EXT_GET_VERSION()) {
// Ok, update this extension now
- EXTENSION_UPDATE(basename($file), $EXT_UPDATE_DEPENDS, $ext_ver, $dry_run);
+ EXTENSION_UPDATE($ext_update, $ext_ver, $dry_run);
// All okay!
$test = true;
- }
- else
- {
+ } else {
// Nothing to register / update before...
$test = true;
}
- }
- else
- {
+ } else {
// Required file for update does not exists!
$test = true;
// But this is fine for the first time...
}
- // Finally restore previous SQLs
- $SQLs = $SQLs2; unset($SQLs2);
- $EXT_LANG_PREFIX = $LANG_BCK;
- }
- else
- {
- // Does not depend on an other extension
+ // Restore the current extension name
+ EXT_SET_CURR_NAME($ext_name);
+ } // END - for
+
+ // Is there no update?
+ if (EXT_COUNT_UPDATE_DEPENDS(EXT_GET_CURR_NAME()) == 0) {
+ // Then test is passed!
$test = true;
- }
+ } // END - if
// Switch back to register mode
$EXT_LOAD_MODE = "register";
+ // Remains true if extension registration reports no failures
+ //* DEBUG: */ print __FUNCTION__."[".__LINE__."]:currName=".EXT_GET_CURR_NAME().":"; var_dump($test);
+ $test = (($test === true) && (EXT_GET_REPORTS_FAILURE() === false));
+ //* DEBUG: */ print __FUNCTION__."[".__LINE__."]:currName=".EXT_GET_CURR_NAME().":"; var_dump($test);
+
// Does everthing before wents ok?
- if ($test) {
+ if ($test === true) {
// "Dry-run-mode" activated?
- if (!$dry_run) {
- // Run all SQLs
- foreach ($SQLs as $sql) {
- // Trim spaces away which we don't need
- $sql = trim($sql);
-
- // Is there still an SQL query?
- if (!empty($sql)) {
- // Run SQL command
- $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
- } // END - if
- } // END - foreach
+ if ((!$dry_run) && (!EXT_IS_ON_REMOVAL_LIST())) {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " ext_name=".EXT_GET_CURR_NAME());
+ // Init SQLs and transfer ext->generic
+ INIT_SQLS();
+ SET_SQLS(GET_EXT_SQLS());
- // Remove cache file(s) if extension is active
- 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();
- } // END - if
-
- // Check for added include files
- if (count($INC_POOL > 0)) {
- // Loads every include file
- foreach ($INC_POOL as $inc) {
- require_once($inc);
- } // END - foreach
- }
+ // Run installation pre-installation filters
+ runFilterChain('pre_extension_installed', array('dry_run' => $dry_run));
// 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__);
+ SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_extensions` (ext_name, ext_active, ext_version) VALUES ('%s','%s','%s')",
+ array(EXT_GET_CURR_NAME(), EXT_GET_ALWAYS_ACTIVE(), EXT_GET_VERSION()), __FUNCTION__, __LINE__);
+
+ // Remove cache file(s) if extension is active
+ runFilterChain('post_extension_installed', array('ext_name' => EXT_GET_CURR_NAME(), 'task_id' => $task_id));
- // Update task management
- $result = SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_task_system SET status='SOLVED' WHERE id=%d LIMIT 1",
- array(bigintval($id)), __FILE__, __LINE__);
+ // Remove all SQL commands
+ UNSET_SQLS();
// In normal mode return a true on success
- $ret = true; unset($SQLs);
- } else {
- // Rewrite SQL command to keep { and } inside
- foreach ($SQLs as $key => $sql) {
+ $ret = true;
+ } elseif ($dry_run) {
+ // Init SQLs and transfer ext->generic
+ INIT_SQLS();
+ SET_SQLS(GET_EXT_SQLS());
+
+ // Rewrite SQL command to keep { and } inside for dry-run
+ foreach (GET_SQLS() as $key => $sql) {
$sql = str_replace('{', "{", str_replace('}', "}", $sql));
- $SQLs[$key] = $sql;
+ SET_SQL_KEY($key, $sql);
} // END - foreach
// In "dry-run" mode return array with all SQL commands
- $ret = $SQLs;
+ $ret = GET_SQLS();
// Remove all SQL commands
- unset($SQLs);
+ UNSET_SQLS();
+ } else {
+ // Extension has been removed for updates, so all is fine!
+ $ret = true;
}
} else {
// No, an error occurs while registering extension :-(
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "".EXT_GET_CURR_NAME());
$ret = false;
}
- } elseif (($id > 0) && (!empty($ext_name))) {
+ } elseif (($task_id > 0) && (EXT_GET_CURR_NAME() != "")) {
+ //* DEBUG: */ print __FUNCTION__."[".__LINE__."]:currName=".EXT_GET_CURR_NAME()."<br />\n";
// Remove task from system when id and extension's name is valid
- $result = SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_task_system WHERE id=%d AND status='NEW' LIMIT 1",
- array(bigintval($id)), __FILE__, __LINE__);
+ SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_task_system` WHERE id=%s AND `status`='NEW' LIMIT 1",
+ array(bigintval($task_id)), __FUNCTION__, __LINE__);
}
// Is this the sql_patches?
- //* DEBUG: */ echo __LINE__.":{$ext_name}/{$EXT_LOAD_MODE}<br />\n";
- if (($ext_name == "sql_patches") && (($EXT_LOAD_MODE == "register") || ($EXT_LOAD_MODE == "remove")) && (!$dry_run) && ($test)) {
- // Then redirect to logout
- //* DEBUG: */ echo __LINE__.": LOAD!<br />\n";
- LOAD_URL("modules.php?module=admin&logout=1&".$EXT_LOAD_MODE."=sql_patches");
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":".EXT_GET_CURR_NAME()."/{$EXT_LOAD_MODE}");
+ if ((EXT_GET_CURR_NAME() == "sql_patches") && (($EXT_LOAD_MODE == "register") || ($EXT_LOAD_MODE == "remove")) && (!$dry_run) && ($test)) {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": LOAD!");
+ if ($logout === true) {
+ // Then redirect to logout
+ LOAD_URL("modules.php?module=admin&logout=1&".$EXT_LOAD_MODE."=sql_patches");
+ } else {
+ // Add temporary filter
+ REGISTER_FILTER('shutdown', 'REDIRECT_TO_LOGOUT_SQL_PATCHES', true, true);
+ $GLOBALS['ext_load_mode'] = $EXT_LOAD_MODE;
+ }
} // END - if
// Return status code
+ //* DEBUG: */ print __FUNCTION__."[".__LINE__."]:currName=".EXT_GET_CURR_NAME()." - LEFT!<br />\n";
+ //* DEBUG: */ var_dump($ret);
return $ret;
}
-//
-function EXTENSION_RUN_SQLS($id, $EXT_LOAD_MODE) {
- global $cacheInstance;
- $SQLs = array();
+// Run SQL queries for given extension id
+// @TODO Change from ext_id to ext_name (not just even the variable! ;-) )
+function EXTENSION_RUN_SQLS ($ext_id, $load_mode) {
// This shall never do a non-admin user!
if (!IS_ADMIN()) return false;
// Get extension's name
- $ext_name = GET_EXT_NAME($id);
- if (empty($ext_name)) return false;
+ $ext_name = GET_EXT_NAME($ext_id);
+
+ // If it is not set then maybe there is no extension for that ID number
+ if ($ext_name == "") return false;
+
+ // Set current SQL name
+ EXT_SET_CURR_NAME($ext_name);
+
+ // Init EXT_UPDATE_DEPENDS
+ EXT_INIT_UPDATE_DEPENDS();
+
+ // Init array
+ INIT_EXT_SQLS();
+
+ // By default no SQL has been executed
+ $sqlRan = false;
// Load extension in detected mode
- $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
- if (file_exists($file) && is_readable($file)) require($file);
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":ext_name[{$ext_id}]=".EXT_GET_CURR_NAME()."");
+ LOAD_EXTENSION(EXT_GET_CURR_NAME(), $load_mode, "", false);
- if ((is_array($SQLs) && (sizeof($SQLs) > 0))) {
- // Run SQL commands...
- foreach ($SQLs as $sql) {
- // Trim spaces away which we don't need
- $sql = trim($sql);
+ // Init these SQLs
+ INIT_SQLS();
+ SET_SQLS(GET_EXT_SQLS());
- // Is there still an SQL query?
- if (!empty($sql)) {
- // Run SQL command
- $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
- } // END - if
- } // END - foreach
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":SQLs::count=".COUNT_SQLS()."");
+ if ((IS_SQLS_VALID() && (COUNT_SQLS() > 0))) {
+ // Run SQL commands...
+ runFilterChain('run_sqls');
// Removal mode?
- if ($EXT_LOAD_MODE == "remove") {
+ if ($load_mode == "remove") {
// Delete this extension (remember to remove it from your server *before* you click on welcome!
- $result = SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_extensions WHERE id=%d LIMIT 1",
- array($id), __FILE__, __LINE__);
+ SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
+ array(EXT_GET_CURR_NAME()), __FUNCTION__, __LINE__);
} // END - if
+ } // END - if
- // Remove cache file(s) if extension is active
- 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();
- } // END - if
+ // Remove cache file(s) if extension is active
+ if (((EXT_IS_ACTIVE("cache")) || (GET_EXT_VERSION("cache") != "")) && (((SQL_AFFECTEDROWS() == 1)) || ($sqlRan === true) || ($load_mode == "activate") || ($load_mode == "deactivate"))) {
+ // Run filters
+ runFilterChain('post_extension_run_sql', EXT_GET_CURR_NAME());
+ } // END - if
- // Is this the sql_patches?
- //* DEBUG: */ echo __LINE__.": {$id}/{$ext_name}/{$EXT_LOAD_MODE}<br />\n";
- if (($ext_name == "sql_patches") && (($EXT_LOAD_MODE == "register") || ($EXT_LOAD_MODE == "remove"))) {
- // Then redirect to logout
- //* DEBUG: */ echo __LINE__.": LOAD!<br />\n";
- LOAD_URL("modules.php?module=admin&logout=1&".$EXT_LOAD_MODE."=sql_patches");
- } // END - if
+ // Is this the sql_patches?
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": id=".$ext_id.",currName=".EXT_GET_CURR_NAME().",loadMode=".$load_mode);
+ if ((EXT_GET_CURR_NAME() == "sql_patches") && (($load_mode == "register") || ($load_mode == "remove"))) {
+ // Then redirect to logout
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": LOAD!");
+ LOAD_URL("modules.php?module=admin&logout=1&".$load_mode."=sql_patches");
} // END - if
}
-// Check if given extension is active
-function EXT_IS_ACTIVE ($ext_name, $ignore_admin = false, $ignore_cache = false) {
- global $cacheArray, $_CONFIG;
+// Check if given extension is active
+function EXT_IS_ACTIVE ($ext_name) {
// Extensions are all inactive during installation
- if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing')) || (empty($ext_name))) return false;
+ if ((!isInstalled()) || (isInstalling()) || (empty($ext_name))) return false;
- // Extension's file name will also be checked
- $file = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
- if ((!file_exists($file)) && (!is_readable($file))) return false;
- //* DEBUG: */ echo "*".$ext_name."(".count($cacheArray).")<br />";
+ // Not active is the default
+ $active = "N";
- // Failed is the default
- $ret = false;
- if ((!empty($cacheArray['extensions']['ext_active'][$ext_name])) && (!$ignore_cache)) {
+ // Check cache
+ if (isset($GLOBALS['cache_array']['extensions']['ext_active'][$ext_name])) {
// Load from cache
- //* DEBUG: */ echo "CACHE!<br />\n";
- $active = $cacheArray['extensions']['ext_active'][$ext_name];
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "CACHE! ext_name={$ext_name}");
+ $active = $GLOBALS['cache_array']['extensions']['ext_active'][$ext_name];
// Count cache hits
- if (isset($_CONFIG['cache_hits'])) $_CONFIG['cache_hits']++;
- } else {
- //* DEBUG: */ echo "DB!<br />\n";
+ incrementConfigEntry('cache_hits');
+ } elseif (isset($GLOBALS['ext_loaded'][$ext_name])) {
+ // @TODO Extension is loaded, what next?
+ app_die(__FUNCTION__, __LINE__, "LOADED:$ext_name");
+ } elseif (($ext_name == "cache") || (GET_EXT_VERSION("cache") == "")) {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "DB! ext_name={$ext_name}");
// Load from database
- $result = SQL_QUERY_ESC("SELECT ext_active FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
- array($ext_name), __FILE__, __LINE__);
- if (SQL_NUMROWS($result) == 0) {
- // Extension was not found!
- return false;
- }
- list($active) = SQL_FETCHROW($result);
+ $result = SQL_QUERY_ESC("SELECT ext_active FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
+ array($ext_name), __FUNCTION__, __LINE__);
+
+ // Entry found?
+ if (SQL_NUMROWS($result) == 1) {
+ // Load entry
+ list($active) = SQL_FETCHROW($result);
+ } // END - if
+
+ // Free result
SQL_FREERESULT($result);
// Write cache array
- $cacheArray['extensions']['ext_active'][$ext_name] = $active;
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "ext_name=".$ext_name."[DB]: {$active}");
+ $GLOBALS['cache_array']['extensions']['ext_active'][$ext_name] = $active;
+ } else {
+ // Extension not active!
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "ext_name=".$ext_name.": Not active!");
+ $GLOBALS['cache_array']['extensions']['ext_active'][$ext_name] = "N";
}
+ // Debug message
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, " ext_name={$ext_name},active={$active}");
+
// Is this extension activated? (For admins we always have active extensions...)
- $inc = sprintf("%sinc/extensions/ext-%s.php", PATH, $ext_name);
- // Shorter way
- return (
- (
- ($active == "Y") || (
- (IS_ADMIN()) &&
- (!$ignore_admin) &&
- (!empty($active))
- )
- ) && (
- file_exists($inc)
- ) && (
- is_readable($inc)
- )
- );
+ return ($active == "Y");
}
// Get version from extensions
function GET_EXT_VERSION ($ext_name) {
- global $cacheArray, $_CONFIG, $cacheInstance;
- $ret = false;
+ // By default no extension is found
+ $ext_ver = false;
+
+ // Empty extension name should be fixed!
+ if (empty($ext_name)) {
+ // Please report this bug!
+ debug_report_bug(__FUNCTION__.": ext_name is empty which is not allowed here.");
+ } // END - if
// Extensions are all inactive during installation
- if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing'))) return "";
+ if ((!isInstalled()) || (isInstalling())) return "";
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": ext_name={$ext_name}");
// Is the cache written?
- if (!empty($cacheArray['extensions']['ext_version'][$ext_name])) {
+ if (isset($GLOBALS['cache_array']['extensions']['ext_version'][$ext_name])) {
// Load data from cache
- $ret = $cacheArray['extensions']['ext_version'][$ext_name];
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": CACHE!");
+ $ext_ver = $GLOBALS['cache_array']['extensions']['ext_version'][$ext_name];
// Count cache hits
- if (isset($_CONFIG['cache_hits'])) $_CONFIG['cache_hits']++; else $_CONFIG['cache_hits'] = 1;
- } elseif (!is_object($cacheInstance)) {
+ incrementConfigEntry('cache_hits');
+ } elseif (!isCacheInstanceValid()) {
// Load from database
- $result = SQL_QUERY_ESC("SELECT ext_version FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
- array($ext_name), __FILE__, __LINE__);
- list($ret) = SQL_FETCHROW($result);
+ $result = SQL_QUERY_ESC("SELECT ext_version FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
+ array($ext_name), __FUNCTION__, __LINE__);
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": DB - ".SQL_NUMROWS($result)."");
+
+ // Is the extension there?
+ if (SQL_NUMROWS($result) == 1) {
+ // Load entry
+ list($ext_ver) = SQL_FETCHROW($result);
+ } // END - if
+
+ // Free result
SQL_FREERESULT($result);
// Set cache
- $cacheArray['extensions']['ext_version'][$ext_name] = $ret;
+ $GLOBALS['cache_array']['extensions']['ext_version'][$ext_name] = $ext_ver;
}
- return $ret;
+
+ // Return result
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": ret={$ext_ver}");
+ return $ext_ver;
}
-//
-function EXTENSION_UPDATE($file, $ext, $EXT_VER, $dry_run=false)
-{
- // This shall never do a non-admin user!
- global $cacheInstance, $_CONFIG, $NOTES; $SQLs = array();
- if ((!IS_ADMIN()) || (empty($ext))) return false;
-
- // Load extension in update mode
- $EXT_LOAD_MODE = "update"; $EXT_UPDATE_DEPENDS = ""; $NOTES = "";
- include(PATH."inc/extensions/".$file);
- if (!empty($EXT_UPDATE_DEPENDS))
- {
- // Update another extension first!
- $test = EXTENSION_UPDATE(("ext-".$EXT_UPDATE_DEPENDS.".php"), $EXT_UPDATE_DEPENDS, GET_EXT_VERSION($EXT_UPDATE_DEPENDS), $dry_run);
- }
+
+// Updates a given extension with current extension version to latest version
+function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) {
+ // Only admins are allowed to update extensions
+ if ((!IS_ADMIN()) || (empty($ext_name))) return false;
+
+ // Set current SQL name
+ EXT_SET_CURR_NAME($ext_name);
+
+ // Init arrays
+ INIT_EXT_SQLS();
+ EXT_INIT_NOTES();
+ INIT_INC_POOL();
+
+ // Load extension in test mode
+ LOAD_EXTENSION($ext_name, "test", $ext_ver, $dry_run);
+
+ // Save version history
+ $history = EXT_GET_VER_HISTORY();
+
+ // Remove old SQLs array to prevent possible bugs
+ INIT_EXT_SQLS();
// Check if version is updated
- if ((($EXT_VERSION != $EXT_VER) || ($dry_run)) && (is_array($EXT_VER_HISTORY)))
- {
+ if (((EXT_GET_VERSION() != $ext_ver) || ($dry_run)) && (is_array($history))) {
// Search for starting point
- $start = array_search($EXT_VER, $EXT_VER_HISTORY);
- $NOTES = "";
+ $start = array_search($ext_ver, $history);
// And load SQL queries in order of version history
- for ($idx = ($start + 1); $idx < sizeof($EXT_VER_HISTORY); $idx++)
- {
- // Remove old SQLs array to prevent possible bugs
- if (!$dry_run) { unset($SQLs); $SQLs = array(); }
+ for ($idx = ($start + 1); $idx < count($history); $idx++) {
+ // Set extension version
+ $GLOBALS['cache_array']['update_ver'][EXT_GET_CURR_NAME()] = $history[$idx];
- // Set version
- $EXT_VER = $EXT_VER_HISTORY[$idx];
+ // Load again...
+ LOAD_EXTENSION(EXT_GET_CURR_NAME(), "update", $GLOBALS['cache_array']['update_ver'][EXT_GET_CURR_NAME()], $dry_run);
- // Include again...
- include(PATH."inc/extensions/".$file);
+ if (EXT_GET_UPDATE_DEPENDS() != "") {
+ // Is the extension there?
+ if (GET_EXT_VERSION(EXT_GET_UPDATE_DEPENDS()) != "") {
+ // Update another extension first!
+ $test = EXTENSION_UPDATE(EXT_GET_UPDATE_DEPENDS(), GET_EXT_VERSION(EXT_GET_UPDATE_DEPENDS()), $dry_run);
+ } else {
+ // Register new extension
+ $test = REGISTER_EXTENSION(EXT_GET_UPDATE_DEPENDS(), 0, $dry_run, false);
+ }
+ } // END - if
// Add notes
- if ($_CONFIG['verbose_sql'] == "Y")
- {
- $EXT_VER = $EXT_VER_HISTORY[$idx];
- if (!empty($UPDATE_NOTES))
- {
- // Update notes found
- $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br />".$UPDATE_NOTES."<br /><br />\n";
- $UPDATE_NOTES = "";
- }
- elseif ($EXT_VER == "0.0")
- {
- // Initial release
- $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br />".INITIAL_RELEASE."<br /><br />\n";
- }
- else
- {
- $NOTES .= "<STRONG>v".$EXT_VER.":</STRONG><br /><I>".NO_UPDATE_NOTES."</I><br /><br />\n";
- }
- }
+ ADD_EXTENSION_NOTES($GLOBALS['cache_array']['update_ver'][EXT_GET_CURR_NAME()]);
+ } // END - for
- // Run SQLs
- if ((is_array($SQLs)) && (!$dry_run))
- {
- // Run SQL commands
- foreach ($SQLs as $sql)
- {
- $sql = trim($sql);
- if (!empty($sql))
- {
- // Run SQL command...
- $result = SQL_QUERY($sql, __FILE__, __LINE__, false);
- }
- }
- } elseif (GET_EXT_VERSION("sql_patches") == "") {
- // Remove SQLs if extension is not installed
- $SQLs = array();
- }
- }
+ // In real-mode execute any existing includes
+ if (!$dry_run) {
+ $GLOBALS['cache_array']['inc_pool'][EXT_GET_CURR_NAME()] = GET_INC_POOL();
+ runFilterChain('load_includes');
+ SET_INC_POOL($GLOBALS['cache_array']['inc_pool'][EXT_GET_CURR_NAME()]);
+ unset($GLOBALS['cache_array']['inc_pool'][EXT_GET_CURR_NAME()]);
+ } // END - if
- if (!$dry_run)
- {
- // In normal mode insert task and update extension's version...
- $ext_subj = "[UPDATE-".$ext."-".$EXT_VERSION.":] ".ADMIN_UPDATE_EXT_SUBJ;
+ // Init these SQLs
+ INIT_SQLS();
+ SET_SQLS(GET_EXT_SQLS());
- // Create task
- $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_task_system WHERE subject='%s' LIMIT 1",
- array($ext_subj), __FILE__, __LINE__);
- if (SQL_NUMROWS($result) == 0)
- {
- // Task not created so it's a brand-new extension which we need to register and create a task for!
- $result = SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_task_system (assigned_admin, userid, status, task_type, subject, text, task_created) VALUES ('%s', '0', 'NEW', 'EXTENSION_UPDATE', '%s', '%s', UNIX_TIMESTAMP())",
- array(GET_ADMIN_ID(SQL_ESCAPE(get_session('admin_login'))), $ext_subj, addslashes($NOTES)), __FILE__, __LINE__);
- }
+ // Run SQLs
+ runFilterChain('run_sqls', array('dry_run' => $dry_run));
- // Free memory
- SQL_FREERESULT($result);
+ if (!$dry_run) {
+ // Create task
+ CREATE_EXTENSION_UPDATE_TASK(GET_CURRENT_ADMIN_ID(), EXT_GET_CURR_NAME(), $GLOBALS['cache_array']['update_ver'][EXT_GET_CURR_NAME()], SQL_ESCAPE(EXT_GET_NOTES(EXT_GET_NOTES())));
// Update extension's version
- $result = SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_extensions SET ext_version='%s' WHERE ext_name='%s' LIMIT 1",
- array($EXT_VERSION, $ext), __FILE__, __LINE__);
-
- // 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();
- }
+ SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_extensions` SET ext_version='%s' WHERE ext_name='%s' LIMIT 1",
+ array($GLOBALS['cache_array']['update_ver'][EXT_GET_CURR_NAME()], EXT_GET_CURR_NAME()), __FUNCTION__, __LINE__);
- // Remove array
- unset($SQLs);
- }
- else
- {
- // In "dry-run" mode return array with SQL commands
- return $SQLs;
- }
- }
+ // Remove arrays
+ UNSET_SQLS();
+ unset($GLOBALS['cache_array']['update_ver'][EXT_GET_CURR_NAME()]);
+
+ // Run filters on success extension update
+ runFilterChain('extension_update', EXT_GET_CURR_NAME());
+ } // END - if
+ } // END - if
}
-//
-function EXTENSION_VERBOSE_TABLE($SQLs, $title=ADMIN_SQLS_EXECUTED_ON_REMOVAL, $dashed="", $switch=false, $WIDTH="480")
-{
- global $_CONFIG;
- $S = false; $SW = 2; $i = 1;
+// Output verbose SQL table for extension
+function EXTENSION_VERBOSE_TABLE ($queries = array(), $title = "", $dashed = "", $switch = false, $width = "100%") {
+ // Empty title?
+ if (empty($title)) {
+ // Then fix it to default
+ $title = getMessage('ADMIN_SQLS_EXECUTED_ON_REMOVAL');
+ } // END - if
+
+ // Are there some queries in $queries?
+ if (count($queries) > 0) {
+ // Then use them instead!
+ SET_SQLS($queries);
+ } // END - if
+
+ // Init variables
+ $SW = 2; $i = 1;
$OUT = "";
- if ((is_array($SQLs)) && (GET_EXT_VERSION("sql_patches")) && ($_CONFIG['verbose_sql'] == "Y"))
- {
- $OUT = "<DIV align=\"center\">
-<TABLE border=\"0\" cellspacing=\"0\" cellpadding=\"0\" width=\"".$WIDTH."\" align=\"center\"".$dashed.">
-<TR>
- <TD colspan=\"2\" align=\"center\" class=\"admin_title bottom2\" height=\"24\">
- <STRONG>".$title.":</STRONG>
- </TD>
-</TR>\n";
- foreach ($SQLs as $idx=>$sql)
- {
+
+ // Do we have queries?
+ if ((IS_SQLS_VALID()) && (GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) {
+ foreach (GET_SQLS() as $idx => $sql) {
+ // Trim out spaces
$sql = trim($sql);
- if (!empty($sql))
- {
- $S = true;
- $OUT .= "<TR>
- <TD class=\"switch_sw".(3 - $SW)." bottom2\" style=\"padding-left: 2px\" width=\"30\">".$i.".</TD>
- <TD class=\"switch_sw".(3 - $SW)." bottom2\" style=\"padding-left: 5px; padding-right: 5px\">
- ".$sql."
- </TD>
-</TR>\n";
- if ($switch) $SW = 3 - $SW;
+
+ // Output command if set
+ if (!empty($sql)) {
+ // Prepare output for template
+ $content = array(
+ 'sw' => $SW,
+ 'i' => $i,
+ 'sql' => $sql
+ );
+
+ // Load row template
+ $OUT .= LOAD_TEMPLATE("admin_ext_sql_row", true, $content);
+
+ // Switch color and count up
+ $SW = 3 - $SW;
$i++;
- }
- }
- }
+ } // END - if
+ } // END - foreach
- if ((!$S) && (GET_EXT_VERSION("sql_patches")) && ($_CONFIG['verbose_sql'] == "Y"))
- {
+ // Prepare content for template
+ $content = array(
+ 'width' => $width,
+ 'dashed' => $dashed,
+ 'title' => $title,
+ 'out' => $OUT
+ );
+
+ // Load main template
+ $OUT = LOAD_TEMPLATE("admin_ext_sql_table", true, $content);
+ } elseif ((GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) {
// No addional SQL commands to run
- $OUT .= "<TR>
- <TD colspan=\"2\" align=\"center\" class=\"switch_sw2 bottom2\" height=\"24\">
- <FONT class=\"admin_note\">".ADMIN_NO_ADDIONAL_SQLS."</FONT>
- </TD>
-</TR>\n";
- }
+ $OUT = LOAD_TEMPLATE("admin_settings_saved", true, getMessage('ADMIN_NO_ADDITIONAL_SQLS'));
+ } // END - if
- if (!empty($OUT)) {
- // Add missing close-table tag
- $OUT .= "</TABLE>
-</DIV>\n";
- }
+ // Return output
return $OUT;
}
-//
-function GET_EXT_NAME($id)
-{
+
+// Get extension name from id
+function GET_EXT_NAME ($ext_id) {
+ // Init extension name
$ret = "";
- global $cacheArray, $_CONFIG;
- if (!empty($cacheArray['extensions']['ext_id'][$id]))
- {
+
+ // Is cache there?
+ if (isset($GLOBALS['cache_array']['extensions']['ext_name'][$ext_id])) {
// Load from cache
- $ret = $cacheArray['extensions']['ext_id'][$id];
+ $ret = $GLOBALS['cache_array']['extensions']['ext_name'][$ext_id];
// Count cache hits
- $_CONFIG['cache_hits']++;
- }
- else
- {
+ incrementConfigEntry('cache_hits');
+ } elseif (!EXT_IS_ACTIVE("cache")) {
// Load from database
- $result = SQL_QUERY_ESC("SELECT ext_name FROM "._MYSQL_PREFIX."_extensions WHERE id=%d LIMIT 1",
- array(bigintval($id)), __FILE__, __LINE__);
+ $result = SQL_QUERY_ESC("SELECT ext_name FROM `{!_MYSQL_PREFIX!}_extensions` WHERE id=%s LIMIT 1",
+ array(bigintval($ext_id)), __FUNCTION__, __LINE__);
list($ret) = SQL_FETCHROW($result);
SQL_FREERESULT($result);
}
return $ret;
}
-//
-function GET_EXT_ID($name)
-{
- $ret = "0";
- global $cacheArray, $_CONFIG;
- if ((isset($cacheArray['extensions']['ext_id'])) && (is_array($cacheArray['extensions']['ext_id'])))
- {
+
+// Get extension id from name
+function GET_EXT_ID ($ext_name) {
+ // Init ID number
+ $ret = 0;
+ if (isset($GLOBALS['cache_array']['extensions']['ext_id'][$ext_name])) {
// Load from cache
- $ret = array_search($name, $cacheArray['extensions']['ext_id']);
+ $ret = $GLOBALS['cache_array']['extensions']['ext_id'][$ext_name];
// Count cache hits
- $_CONFIG['cache_hits']++;
- }
- else
- {
+ incrementConfigEntry('cache_hits');
+ } elseif (!EXT_IS_ACTIVE("cache")) {
// Load from database
- $result = SQL_QUERY_ESC("SELECT id FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
- array($name), __FILE__, __LINE__);
+ $result = SQL_QUERY_ESC("SELECT id FROM `{!_MYSQL_PREFIX!}_extensions` WHERE ext_name='%s' LIMIT 1",
+ array($ext_name), __FUNCTION__, __LINE__);
list($ret) = SQL_FETCHROW($result);
SQL_FREERESULT($result);
}
+
+ // Return value
return $ret;
}
+
+// Activate given extension
+function ACTIVATE_EXTENSION ($ext_name) {
+ // Activate the extension
+ SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_extensions` SET ext_active='Y' WHERE ext_name='%s' LIMIT 1",
+ array($ext_name), __FUNCTION__, __LINE__);
+
+ // Extension has been activated?
+ if (SQL_AFFECTEDROWS() == 1) {
+ // Then run all queries
+ EXTENSION_RUN_SQLS(GET_EXT_ID($ext_name), "activate");
+ } // END - if
+}
+
+// Deactivate given extension
+function DEACTIVATE_EXTENSION($ext_name) {
+ // Activate the extension
+ SQL_QUERY_ESC("UPDATE `{!_MYSQL_PREFIX!}_extensions` SET ext_active='N' WHERE ext_name='%s' LIMIT 1",
+ array($ext_name), __FUNCTION__, __LINE__);
+
+ // Extension has been activated?
+ if (SQL_AFFECTEDROWS() == 1) {
+ // Then run all queries
+ EXTENSION_RUN_SQLS(GET_EXT_ID($ext_name), "deactivate");
+
+ // Create new task
+ CREATE_EXTENSION_DEACTIVATION_TASK($ext_name);
+
+ // Notify the admin
+ SEND_ADMIN_NOTIFICATION(
+ getMessage('ADMIN_SUBJECT_EXTENSION_DEACTIVATED'),
+ "admin_ext_deactivated",
+ array('ext_name' => $ext_name)
+ );
+ } // END - if
+}
+
+// Checks wether the extension is older than given
+function EXT_VERSION_IS_OLDER ($ext_name, $ext_ver) {
+ // Get current extension version
+ $currVersion = GET_EXT_VERSION($ext_name);
+
+ // Remove all dots from both versions
+ $currVersion = str_replace(".", "", $currVersion);
+ $ext_ver = str_replace(".", "", $ext_ver);
+
+ // Now compare both and return the result
+ return ($currVersion < $ext_ver);
+}
+
+// Creates a new task for updated extension
+function CREATE_EXTENSION_UPDATE_TASK ($admin_id, $ext_name, $ext_ver, $notes) {
+ // Create subject line
+ $subject = "[UPDATE-".$ext_name."-".$ext_ver.":] {--ADMIN_UPDATE_EXT_SUBJ--}";
+
+ // Is the extension there?
+ if (GET_EXT_VERSION($ext_name) != "") {
+ // Check if task is not there
+ if (DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) {
+ // Task not created so it's a brand-new extension which we need to register and create a task for!
+ SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_task_system` (assigned_admin, userid, status, task_type, subject, text, task_created) VALUES ('%s','0','NEW','EXTENSION_UPDATE','%s','%s', UNIX_TIMESTAMP())",
+ array($admin_id, $subject, $notes), __FUNCTION__, __LINE__);
+ } // END - if
+ } // END - if
+}
+
+// Creates a new task for newly installed extension
+function CREATE_NEW_EXTENSION_TASK ($admin_id, $subject, $ext) {
+ // Not installed and do we have created a task for the admin?
+ if ((DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) && (GET_EXT_VERSION($ext) == "")) {
+ // Template file
+ $tpl = sprintf("%stemplates/%s/html/ext/ext_%s.tpl",
+ constant('PATH'),
+ GET_LANGUAGE(),
+ $ext
+ );
+
+ // Set default message if ext-foo is missing
+ $msg = sprintf(getMessage('ADMIN_EXT_TEXT_FILE_MISSING'), $ext);
+
+ // Load text for task if found
+ if (FILE_READABLE($tpl)) {
+ // Load extension's own text template (HTML!)
+ $msg = LOAD_TEMPLATE("ext_" . $ext, true);
+ } else {
+ // Write this in debug.log as well
+ DEBUG_LOG(__FUNCTION__, __LINE__, $msg);
+ }
+
+ // Task not created so it's a brand-new extension which we need to register and create a task for!
+ SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_task_system` (assigned_admin, userid, status, task_type, subject, text, task_created)
+VALUES (%s, 0, 'NEW', 'EXTENSION', '%s', '%s', UNIX_TIMESTAMP())",
+ array(
+ $admin_id,
+ $subject,
+ smartAddSlashes($msg),
+ ), __FUNCTION__, __LINE__, true, false, false
+ );
+ } // END - if
+}
+
+// Creates a task for automatically deactivated (deprecated) extension
+function CREATE_EXTENSION_DEACTIVATION_TASK ($ext) {
+ // Create subject line
+ $subject = sprintf("[%s:] %s", $ext, getMessage('TASK_SUBJ_EXTENSION_DEACTIVATED'));
+
+ // Not installed and do we have created a task for the admin?
+ if ((DETERMINE_TASK_ID_BY_SUBJECT($subject) == 0) && (GET_EXT_VERSION($ext) != "")) {
+ // Task not created so add it
+ SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_task_system` (assigned_admin, userid, status, task_type, subject, text, task_created)
+VALUES (0, 0, 'NEW', 'EXTENSION_DEACTIVATION', '%s', '%s', UNIX_TIMESTAMP())",
+ array(
+ $subject,
+ SQL_ESCAPE(LOAD_TEMPLATE("task_ext_deactivated", true, $ext)),
+ ), __FUNCTION__, __LINE__, true, false
+ );
+ } // END - if
+}
+
+// Checks if the module has a menu
+function MODULE_HAS_MENU ($mod, $forceDb = false) {
+ // All is false by default
+ $ret = false;
+
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "mod={$mod},cache=".GET_EXT_VERSION("cache"));
+ if (GET_EXT_VERSION("cache") >= "0.1.2") {
+ // Cache version is okay, so let's check the cache!
+ if (isset($GLOBALS['cache_array']['modules']['has_menu'][$mod])) {
+ // Check module cache and count hit
+ $ret = ($GLOBALS['cache_array']['modules']['has_menu'][$mod] == "Y");
+ incrementConfigEntry('cache_hits');
+ } elseif (isset($GLOBALS['cache_array']['extensions']['ext_menu'][$mod])) {
+ // Check cache and count hit
+ $ret = ($GLOBALS['cache_array']['extensions']['ext_menu'][$mod] == "Y");
+ incrementConfigEntry('cache_hits');
+ } elseif ((IS_ADMIN()) && ($mod == "admin")) {
+ // Admin module has always a menu!
+ $ret = true;
+ }
+ } elseif ((GET_EXT_VERSION("sql_patches") >= "0.3.6") && ((!EXT_IS_ACTIVE("cache")) || ($forceDb === true))) {
+ // Check database for entry
+ $result = SQL_QUERY_ESC("SELECT has_menu FROM `{!_MYSQL_PREFIX!}_mod_reg` WHERE `module`='%s' LIMIT 1",
+ array($mod), __FUNCTION__, __LINE__);
+
+ // Entry found?
+ if (SQL_NUMROWS($result) == 1) {
+ // Load "has_menu" column
+ list($has_menu) = SQL_FETCHROW($result);
+
+ // Fake cache... ;-)
+ $GLOBALS['cache_array']['extensions']['ext_menu'][$mod] = $has_menu;
+
+ // Does it have a menu?
+ $ret = ($has_menu == "Y");
+ } // END - if
+
+ // Free memory
+ SQL_FREERESULT($result);
+ } elseif (GET_EXT_VERSION("sql_patches") == "") {
+ // No sql_patches installed, so maybe in admin area or no admin registered?
+ $ret = (((IS_ADMIN()) || (!isAdminRegistered())) && ($mod == "admin")); // Then there is a menu!
+ }
+
+ // Return status
+ //* DEBUG: */ print __FUNCTION__."[".__LINE__."]:currName=".EXT_GET_CURR_NAME().":"; var_dump($ret);
+ return $ret;
+}
+
+// Determines the task id for given extension
+function DETERMINE_EXTENSION_TASK_ID ($ext_name) {
+ // Default is not found
+ $task_id = 0;
+
+ // Search for extension task's id
+ $result = SQL_QUERY_ESC("SELECT id FROM `{!_MYSQL_PREFIX!}_task_system` WHERE task_type='EXTENSION' AND subject='[%s:]' LIMIT 1",
+ array($ext_name), __FUNCTION__, __LINE__);
+
+ // Entry found?
+ if (SQL_NUMROWS($result) == 1) {
+ // Task found so load task's ID and register extension...
+ list($task_id) = SQL_FETCHROW($result);
+ } // END - if
+
+ // Free result
+ SQL_FREERESULT($result);
+
+ // Return it
+ return $task_id;
+}
+
+// Determines the task id for given subject
+function DETERMINE_TASK_ID_BY_SUBJECT ($subject) {
+ // Default is not found
+ $task_id = 0;
+
+ // Search for task id
+ $result = SQL_QUERY_ESC("SELECT id FROM `{!_MYSQL_PREFIX!}_task_system` WHERE subject LIKE '%s%%' LIMIT 1",
+ array($subject), __FUNCTION__, __LINE__);
+
+ // Entry found?
+ if (SQL_NUMROWS($result) == 1) {
+ // Task found so load task's ID and register extension...
+ list($task_id) = SQL_FETCHROW($result);
+ } // END - if
+
+ // Free result
+ SQL_FREERESULT($result);
+
+ // Return it
+ return $task_id;
+}
+
+// Add updates notes for given version
+function ADD_EXTENSION_NOTES ($ver) {
+ // Init notes/content
+ $out = ""; $content = array();
+
+ // Is do we have verbose output enabled?
+ if ((getConfig('verbose_sql') == "Y") || (!EXT_IS_ACTIVE("sql_patches"))) {
+
+ // Update notes found?
+ if (EXT_GET_UPDATE_NOTES() != "") {
+ // Update notes found
+ $content = array(
+ 'ver' => $ver,
+ 'notes' => EXT_GET_UPDATE_NOTES()
+ );
+
+ // Reset them
+ EXT_SET_UPDATE_NOTES("");
+ } elseif (($ver == "0.0") || ($ver == "0.0.0")) {
+ // Initial release
+ $content = array(
+ 'ver' => $ver,
+ 'notes' => getMessage('INITIAL_RELEASE')
+ );
+ } else {
+ // No update notes found!
+ $content = array(
+ 'ver' => $ver,
+ 'notes' => getMessage('NO_UPDATE_NOTES')
+ );
+ }
+
+ // Load template
+ $out = LOAD_TEMPLATE("admin_ext_notes", true, $content);
+ } // END - if
+
+ // Add the notes
+ EXT_APPEND_NOTES($out);
+}
+
+// Getter for CSS files array
+function EXT_GET_CSS_FILES () {
+ // By default no additional CSS files are found
+ $cssFiles = array();
+
+ // Is the array there?
+ if (isset($GLOBALS['css_files'])) {
+ // Then use it
+ $cssFiles = $GLOBALS['css_files'];
+ } // END - if
+
+ // Return array
+ return $cssFiles;
+}
+
+// Init CSS files array
+function EXT_INIT_CSS_FILES () {
+ // Simply init it
+ $GLOBALS['css_files'] = array();
+}
+
+// Add new entry
+function EXT_ADD_CSS_FILE ($file) {
+ // Is the array there?
+ if (!isset($GLOBALS['css_files'])) {
+ // Then auto-init them
+ EXT_INIT_CSS_FILES();
+ } // END - if
+
+ // Add the entry
+ $GLOBALS['css_files'][] = $file;
+}
+
+// Setter for EXT_ALWAYS_ACTIVE flag
+function EXT_SET_ALWAYS_ACTIVE ($active) {
+ $GLOBALS['ext_always_active'][EXT_GET_CURR_NAME()] = (string) $active;
+}
+
+// Getter for EXT_ALWAYS_ACTIVE flag
+function EXT_GET_ALWAYS_ACTIVE () {
+ return $GLOBALS['ext_always_active'][EXT_GET_CURR_NAME()];
+}
+
+// Setter for EXT_VERSION flag
+function EXT_SET_VERSION ($version) {
+ $GLOBALS['ext_version'][EXT_GET_CURR_NAME()] = (float) $version;
+}
+
+// Getter for EXT_VERSION flag
+function EXT_GET_VERSION () {
+ return $GLOBALS['ext_version'][EXT_GET_CURR_NAME()];
+}
+
+// Setter for EXT_DEPRECATED flag
+function EXT_SET_DEPRECATED ($deprecated) {
+ $GLOBALS['ext_deprecated'][EXT_GET_CURR_NAME()] = (string) $deprecated;
+}
+
+// Getter for EXT_DEPRECATED flag
+function EXT_GET_DEPRECATED () {
+ return $GLOBALS['ext_deprecated'][EXT_GET_CURR_NAME()];
+}
+
+// Setter for EXT_UPDATE_DEPENDS flag
+function EXT_ADD_UPDATE_DEPENDS ($updateDepends) {
+ // Is the update depency empty? (NEED TO BE FIXED!)
+ if (empty($updateDepends)) {
+ // Please report this bug!
+ debug_report_bug("updateDepends is left empty!");
+ } // END - if
+
+ // Is it not yet added?
+ if (!in_array($updateDepends, $GLOBALS['ext_running_updates'])) {
+ //* DEBUG */ DEBUG_LOG(__FUNCTION__, __LINE__, "currName=".EXT_GET_CURR_NAME()."/".$updateDepends);
+ // Add it to the list of extension update depencies map
+ $GLOBALS['ext_update_depends'][EXT_GET_CURR_NAME()][] = (string) $updateDepends;
+
+ // Remember it in the list of running updates
+ $GLOBALS['ext_running_updates'][] = $updateDepends;
+ } // END - if
+}
+
+// Checks wether the given extension registration is in progress
+function EXT_IS_REGISTER_RUNNING ($ext_name) {
+ return ((isset($GLOBALS['ext_register_running'])) && (in_array($ext_name, $GLOBALS['ext_register_running'])));
+}
+
+// Init EXT_UPDATE_DEPENDS flag
+function EXT_INIT_UPDATE_DEPENDS () {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "currName=".EXT_GET_CURR_NAME());
+
+ // Init update depency map automatically if not found
+ if (!EXT_IS_UPDATE_DEPENDS_INIT()) {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "currName=".EXT_GET_CURR_NAME()." - INIT!");
+ $GLOBALS['ext_update_depends'][EXT_GET_CURR_NAME()] = array();
+ } // END - if
+
+ // Init running updates array
+ EXT_INIT_RUNNING_UPDATES();
+}
+
+// Adds an extension as "registration in progress"
+function EXT_ADD_RUNNING_REGISTRATION ($ext_name) {
+ // Is it running?
+ if (!EXT_IS_REGISTER_RUNNING($ext_name)) {
+ // Then add it!
+ $GLOBALS['ext_register_running'][] = $ext_name;
+ } // END - if
+}
+
+// Checks wether EXT_UPDATE_DEPENDS is initialized
+function EXT_IS_UPDATE_DEPENDS_INIT () {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "currName=".EXT_GET_CURR_NAME());
+ return (isset($GLOBALS['ext_update_depends'][EXT_GET_CURR_NAME()]));
+}
+
+// Initializes the list of running updates
+function EXT_INIT_RUNNING_UPDATES () {
+ // Auto-init ext_running_updates
+ if (!isset($GLOBALS['ext_running_updates'])) {
+ $GLOBALS['ext_running_updates'] = array();
+ $GLOBALS['ext_register_running'] = array();
+ } // END - if
+}
+
+// Getter for EXT_UPDATE_DEPENDS flag
+function EXT_GET_UPDATE_DEPENDS () {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "currName=".EXT_GET_CURR_NAME());
+ return $GLOBALS['ext_update_depends'][EXT_GET_CURR_NAME()];
+}
+
+// Getter for next iterator depency
+function EXT_GET_ITERATOR_UPDATE_DEPENDS () {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "currName=".EXT_GET_CURR_NAME());
+ return ($GLOBALS['ext_update_depends'][EXT_GET_CURR_NAME()][EXT_GET_UPDATE_ITERATOR()]);
+}
+
+// Counter for extension update depencies
+function EXT_COUNT_UPDATE_DEPENDS () {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "currName=".EXT_GET_CURR_NAME());
+ return count($GLOBALS['ext_update_depends'][EXT_GET_CURR_NAME()]);
+}
+
+// Removes given extension from update denpency list
+function EXT_REMOVE_UPDATE_DEPENDS ($ext_name) {
+ // Look it up
+ $key = array_search($ext_name, EXT_GET_UPDATE_DEPENDS());
+
+ // Is it valid?
+ if ($key !== false) {
+ // Then remove it
+ unset($GLOBALS['ext_update_depends'][EXT_GET_CURR_NAME()][$key]);
+
+ // And sort the array
+ ksort($GLOBALS['ext_update_depends'][EXT_GET_CURR_NAME()]);
+ } // END - if
+}
+
+// Init iterator for update depencies
+function EXT_INIT_UPDATE_ITERATOR () {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "currName=".EXT_GET_CURR_NAME());
+ $GLOBALS['ext_depend_iterator'][EXT_GET_CURR_NAME()] = 0;
+}
+
+// Getter for depency iterator
+function EXT_GET_UPDATE_ITERATOR () {
+ // Auto-init iterator
+ if (!isset($GLOBALS['ext_depend_iterator'][EXT_GET_CURR_NAME()])) EXT_INIT_UPDATE_ITERATOR();
+
+ // Return it
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "currName=".EXT_GET_CURR_NAME()."/".$GLOBALS['ext_depend_iterator'][EXT_GET_CURR_NAME()]);
+ return $GLOBALS['ext_depend_iterator'][EXT_GET_CURR_NAME()];
+}
+
+// Increments the update iterator
+function EXT_INCREMENT_UPDATE_INTERATOR () {
+ //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "currName=".EXT_GET_CURR_NAME());
+ $GLOBALS['ext_depend_iterator'][EXT_GET_CURR_NAME()]++;
+}
+
+// Setter for EXT_REPORTS_FAILURE flag
+function EXT_SET_REPORTS_FAILURE ($reportsFailure) {
+ $GLOBALS['ext_reports_failure'] = (bool) $reportsFailure;
+}
+
+// Getter for EXT_REPORTS_FAILURE flag
+function EXT_GET_REPORTS_FAILURE () {
+ return $GLOBALS['ext_reports_failure'];
+}
+
+// Setter for EXT_VER_HISTORY flag
+function EXT_SET_VER_HISTORY ($verHistory) {
+ $GLOBALS['ext_ver_history'] = (array) $verHistory;
+}
+
+// Getter for EXT_VER_HISTORY array
+function EXT_GET_VER_HISTORY () {
+ return $GLOBALS['ext_ver_history'];
+}
+
+// Setter for EXT_UPDATE_NOTES flag
+function EXT_SET_UPDATE_NOTES ($updateNotes) {
+ $GLOBALS['ext_update_notes'] = (string) $updateNotes;
+}
+
+// Getter for EXT_UPDATE_NOTES flag
+function EXT_GET_UPDATE_NOTES () {
+ return $GLOBALS['ext_update_notes'];
+}
+
+// Init extension notice
+function EXT_INIT_NOTES () {
+ $GLOBALS['ext_notes'] = "";
+}
+
+// Append extension notice
+function EXT_APPEND_NOTES ($notes) {
+ $GLOBALS['ext_notes'] .= (string) $notes;
+}
+
+// Getter for extension notes
+function EXT_GET_NOTES () {
+ return $GLOBALS['ext_notes'];
+}
+
+// Setter for current extension name
+function EXT_SET_CURR_NAME ($ext_name) {
+ $GLOBALS['curr_ext_name'] = (string) $ext_name;
+}
+
+// Getter for current extension name
+function EXT_GET_CURR_NAME () {
+ if (isset($GLOBALS['curr_ext_name'])) {
+ return $GLOBALS['curr_ext_name'];
+ } // END - if
+
+ // Not set!
+ debug_report_bug(__FUNCTION__.": curr_ext_name not initialized. Please execute INIT_EXT_SQLS() before calling this function.");
+}
+
+// Init SQLs array for current extension
+function INIT_EXT_SQLS () {
+ // Auto-init the array now...
+ if (!isset($GLOBALS['ext_sqls'][EXT_GET_CURR_NAME()])) {
+ $GLOBALS['ext_sqls'][EXT_GET_CURR_NAME()] = array();
+ } // END - if
+}
+
+// Adds SQLs to the SQLs array but "assigns" it with current extension name
+function ADD_EXT_SQL ($sql) {
+ $GLOBALS['ext_sqls'][EXT_GET_CURR_NAME()][] = $sql;
+}
+
+// Getter for SQLs array for current extension
+function GET_EXT_SQLS () {
+ // Output debug backtrace if not found (SHOULD NOT HAPPEN!)
+ if (!isset($GLOBALS['ext_sqls'][EXT_GET_CURR_NAME()])) {
+ // Not found, should not happen
+ debug_report_bug(sprintf("ext_sqls is empty, current extension: %s",
+ EXT_GET_CURR_NAME()
+ ));
+ } // END - if
+
+ // Return the array
+ return $GLOBALS['ext_sqls'][EXT_GET_CURR_NAME()];
+}
+
+// Removes SQLs for current extension
+function UNSET_EXT_SQLS () {
+ unset($GLOBALS['ext_sqls'][EXT_GET_CURR_NAME()]);
+}
+
+// Auto-initializes the removal list
+function EXT_INIT_REMOVAL_LIST () {
+ // Is the remove list there?
+ if (!isset($GLOBALS['ext_update_remove'])) {
+ // Then create it
+ $GLOBALS['ext_update_remove'] = array();
+ } // END - if
+}
+
+// Checks wether the current extension is on the removal list
+function EXT_IS_ON_REMOVAL_LIST () {
+ // Init removal list
+ EXT_INIT_REMOVAL_LIST();
+
+ // Is it there?
+ return (in_array(EXT_GET_CURR_NAME(), $GLOBALS['ext_update_remove']));
+}
+
+// Adds the current extension to the removal list
+function EXT_ADD_CURRENT_TO_REMOVAL_LIST () {
+ // Simply add it
+ $GLOBALS['ext_update_remove'][] = EXT_GET_CURR_NAME();
+}
+
+// Getter for removal list
+function EXT_GET_REMOVAL_LIST () {
+ // Return the removal list
+ return $GLOBALS['ext_update_remove'];
+}
+
//
?>
projects / mailer.git / blobdiff