0) {
// Try to register the extension
$test = EXTENSION_REGISTER($ext_update, $task, $dry_run, false);
} // END - if
} elseif ($ext_ver != $EXT_VERSION) {
// Ok, update this extension now
EXTENSION_UPDATE($ext_update, $ext_ver, $dry_run);
// All okay!
$test = true;
} else {
// Nothing to register / update before...
$test = true;
}
} 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);
} else {
// Does not depend on an other extension
$test = true;
}
// Switch back to register mode
$EXT_LOAD_MODE = "register";
// Remains true if extension registration reports no failures
$test = ($test && !$EXT_REPORTS_FAILURE);
// Does everthing before wents ok?
if ($test) {
// "Dry-run-mode" activated?
if (!$dry_run) {
// Run installation pre-installation filters
RUN_FILTER('pre_extension_installed', array('dry_run' => $dry_run, 'sqls' => $SQLs));
// Register extension
SQL_QUERY_ESC("INSERT INTO "._MYSQL_PREFIX."_extensions (ext_name, ext_active, ext_version) VALUES ('%s','%s','%s')",
array($ext_name, $EXT_ALWAYS_ACTIVE, $EXT_VERSION), __FILE__, __LINE__);
// Remove cache file(s) if extension is active
RUN_FILTER('post_extension_installed', array('ext_name' => $ext_name, 'task_id' => $task_id, 'inc_pool' => $INC_POOL));
// In normal mode return a true on success
$ret = true;
} else {
// Rewrite SQL command to keep { and } inside
foreach ($SQLs as $key => $sql) {
$sql = str_replace('{', "{", str_replace('}', "}", $sql));
$SQLs[$key] = $sql;
} // END - foreach
// In "dry-run" mode return array with all SQL commands
$ret = $SQLs;
// Remove all SQL commands
unset($SQLs);
}
} else {
// No, an error occurs while registering extension :-(
$ret = false;
}
} elseif (($task_id > 0) && (!empty($ext_name))) {
// Remove task from system when id and extension's name is valid
SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_task_system WHERE id=%s AND status='NEW' LIMIT 1",
array(bigintval($task_id)), __FILE__, __LINE__);
}
// Is this the sql_patches?
//* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":{$ext_name}/{$EXT_LOAD_MODE}");
if (($ext_name == "sql_patches") && (($EXT_LOAD_MODE == "register") || ($EXT_LOAD_MODE == "remove")) && (!$dry_run) && ($test)) {
//* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": LOAD!");
if ($logout) {
// 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
return $ret;
}
// 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) {
global $cacheInstance;
// This shall never do a non-admin user!
if (!IS_ADMIN()) return false;
// Init array
$SQLs = array();
// By default no SQL has been executed
$sqlRan = false;
// Get extension's name
$ext_name = GET_EXT_NAME($ext_id);
// If it is not set then maybe there is no extension for that ID number
if (empty($ext_name)) return false;
// Load extension in detected mode
//* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":ext_name[{$ext_id}]={$ext_name}");
LOAD_EXTENSION($ext_name, $load_mode, "", false, $SQLs);
//* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ":SQLs::count=".count($SQLs)."");
if ((is_array($SQLs) && (sizeof($SQLs) > 0))) {
// Run SQL commands...
RUN_FILTER('run_sqls', array('dry_run' => false, 'sqls' => $SQLs));
// Removal mode?
if ($load_mode == "remove") {
// Delete this extension (remember to remove it from your server *before* you click on welcome!
SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM "._MYSQL_PREFIX."_extensions WHERE ext_name='%s' LIMIT 1",
array($ext_name), __FILE__, __LINE__);
} // 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) || ($load_mode == "activate") || ($load_mode == "deactivate"))) {
// Run filters
RUN_FILTER('post_extension_run_sql', $ext_name);
} // END - if
// Is this the sql_patches?
//* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": {$ext_id}/{$ext_name}/{$load_mode}");
if (($ext_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) {
global $cacheArray;
// Extensions are all inactive during installation
if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing')) || (empty($ext_name))) return false;
// Not active is the default
$active = "N";
// Check cache
if (isset($cacheArray['extensions']['ext_active'][$ext_name])) {
// Load from cache
//* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "CACHE! ext_name={$ext_name}");
$active = $cacheArray['extensions']['ext_active'][$ext_name];
// Count cache hits
incrementConfigEntry('cache_hits');
} 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__);
// Entry found?
if (SQL_NUMROWS($result) == 1) {
// Load entry
list($active) = SQL_FETCHROW($result);
} // END - if
// Free result
SQL_FREERESULT($result);
// Write cache array
//* DEBUG: */ echo $ext_name."[DB]: {$active}");
$cacheArray['extensions']['ext_active'][$ext_name] = $active;
} else {
// Extension not active!
//* DEBUG: */ echo $ext_name.": Not active!");
$cacheArray['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...)
return ($active == "Y");
}
// Get version from extensions
function GET_EXT_VERSION ($ext_name) {
global $cacheArray, $cacheInstance;
$ext_ver = false;
// Extensions are all inactive during installation
if ((!isBooleanConstantAndTrue('mxchange_installed')) || (isBooleanConstantAndTrue('mxchange_installing'))) return "";
//* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": ext_name={$ext_name}");
// Is the cache written?
if (isset($cacheArray['extensions']['ext_version'][$ext_name])) {
// Load data from cache
//* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": CACHE!");
$ext_ver = $cacheArray['extensions']['ext_version'][$ext_name];
// Count cache hits
incrementConfigEntry('cache_hits');
} elseif (!is_object($cacheInstance)) {
// 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__);
// 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] = $ext_ver;
}
// Return result
//* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, ": ret={$ext_ver}");
return $ext_ver;
}
// Updates a given extension with current extension version to latest version
function EXTENSION_UPDATE ($ext_name, $ext_ver, $dry_run = false) {
// This shall never do a non-admin user!
global $cacheInstance, $UPDATE_NOTES, $NOTES, $EXT_VER_HISTORY;
global $EXT_UPDATE_DEPENDS, $EXT_VERSION, $INC_POOL, $cacheArray, $SQLs;
// Init arrays
$SQLs = array(); $INC_POOL = array();
// Init notes
$NOTES = "";
// Only admins are allowed to update extensions
if ((!IS_ADMIN()) || (empty($ext_name))) return false;
// Load extension in test mode
LOAD_EXTENSION($ext_name, "test", $ext_ver, $dry_run, $SQLs);
// Save version history
$history = $EXT_VER_HISTORY;
// Remove old SQLs array to prevent possible bugs
$SQLs = array();
// Check if version is updated
if ((($EXT_VERSION != $ext_ver) || ($dry_run)) && (is_array($history))) {
// Search for starting point
$start = array_search($ext_ver, $history);
// And load SQL queries in order of version history
for ($idx = ($start + 1); $idx < sizeof($history); $idx++) {
// Set extension version
$cacheArray['update_ver'][$ext_name] = $history[$idx];
// Load again...
LOAD_EXTENSION($ext_name, "update", $cacheArray['update_ver'][$ext_name], $dry_run, $SQLs);
if (!empty($EXT_UPDATE_DEPENDS)) {
// Backup current SQL queries
$cacheArray['update_sqls'][$ext_name] = $SQLs;
// Is the extension there?
if (GET_EXT_VERSION($EXT_UPDATE_DEPENDS) != "") {
// Update another extension first!
$test = EXTENSION_UPDATE($EXT_UPDATE_DEPENDS, GET_EXT_VERSION($EXT_UPDATE_DEPENDS), $dry_run);
} else {
// Register new extension
$test = EXTENSION_REGISTER($EXT_UPDATE_DEPENDS, 0, $dry_run, false);
}
// Restore previous SQL queries
$SQLs = $cacheArray['update_sqls'][$ext_name];
unset($cacheArray['update_sqls'][$ext_name]);
} // END - if
// Add notes
$NOTES .= ADD_EXTENSION_NOTES($cacheArray['update_ver'][$ext_name], $UPDATE_NOTES);
} // END - for
// In real-mode execute any existing includes
if (!$dry_run) {
$cacheArray['inc_pool'][$ext_name] = $INC_POOL;
RUN_FILTER('load_includes', $INC_POOL);
$INC_POOL = $cacheArray['inc_pool'][$ext_name];
unset($cacheArray['inc_pool'][$ext_name]);
} // END - if
// Run SQLs
RUN_FILTER('run_sqls', array('dry_run' => $dry_run, 'sqls' => $SQLs));
if (!$dry_run) {
// Create task
CREATE_EXTENSION_UPDATE_TASK(GET_CURRENT_ADMIN_ID(), $ext_name, $cacheArray['update_ver'][$ext_name], addslashes($NOTES));
// Update extension's version
SQL_QUERY_ESC("UPDATE "._MYSQL_PREFIX."_extensions SET ext_version='%s' WHERE ext_name='%s' LIMIT 1",
array($cacheArray['update_ver'][$ext_name], $ext_name), __FILE__, __LINE__);
// Remove arrays
unset($SQLs);
unset($cacheArray['update_ver'][$ext_name]);
// Run filters on success extension update
RUN_FILTER('extension_update', $ext_name);
} else {
// In "dry-run" mode return array with SQL commands
return $SQLs;
}
} // END - if
}
// Output verbose SQL table for extension
function EXTENSION_VERBOSE_TABLE ($queries = array(), $title = ADMIN_SQLS_EXECUTED_ON_REMOVAL, $dashed = "", $switch = false, $width = "100%") {
global $SQLs;
// Are there some queries in $queries?
if (count($queries) > 0) {
// Then use them instead!
$SQLs = $queries;
} // END - if
// Init variables
$SW = 2; $i = 1;
$OUT = "";
// Do we have queries?
if ((is_array($SQLs)) && (GET_EXT_VERSION("sql_patches") >= "0.0.7") && (getConfig('verbose_sql') == "Y")) {
foreach ($SQLs as $idx => $sql) {
// Trim out spaces
$sql = trim($sql);
// 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
// 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 = LOAD_TEMPLATE("admin_settings_saved", true, ADMIN_NO_ADDITIONAL_SQLS);
} // END - if
// Return output
return $OUT;
}
// Get extension name from id
function GET_EXT_NAME ($ext_id) {
global $cacheArray;
// Init extension name
$ret = "";
// Is cache there?
if (isset($cacheArray['extensions']['ext_name'][$ext_id])) {
// Load from cache
$ret = $cacheArray['extensions']['ext_name'][$ext_id];
// Count cache hits
incrementConfigEntry('cache_hits');
} elseif (!EXT_IS_ACTIVE("cache")) {
// Load from database
$result = SQL_QUERY_ESC("SELECT ext_name FROM "._MYSQL_PREFIX."_extensions WHERE id=%s LIMIT 1",
array(bigintval($ext_id)), __FILE__, __LINE__);
list($ret) = SQL_FETCHROW($result);
SQL_FREERESULT($result);
}
return $ret;
}
// Get extension id from name
function GET_EXT_ID ($ext_name) {
global $cacheArray;
// Init ID number
$ret = 0;
if (isset($cacheArray['extensions']['ext_id'][$ext_name])) {
// Load from cache
$ret = $cacheArray['extensions']['ext_id'][$ext_name];
// Count cache hits
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($ext_name), __FILE__, __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), __FILE__, __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), __FILE__, __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(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), __FILE__, __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",
PATH,
GET_LANGUAGE(),
$ext
);
// Load text for task
if (FILE_READABLE($tpl)) {
// Load extension's own text template (HTML!)
$msg = LOAD_TEMPLATE("ext_".$ext, true);
} else {
// Load default message
$msg = LOAD_TEMPLATE("admin_new_ext", "", 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','%s','%s',UNIX_TIMESTAMP())",
array(
$admin_id,
$subject,
addslashes($msg),
), __FILE__, __LINE__, true, 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, 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,
addslashes(LOAD_TEMPLATE("task_ext_deactivated", true, $ext)),
), __FILE__, __LINE__, true, false
);
} // END - if
}
// Checks if the module has a menu
function MODULE_HAS_MENU ($mod, $forceDb = false) {
global $cacheArray;
// All is false by default
$ret = false;
//* DEBUG: */ print __FUNCTION__."(".__LINE__."):mod={$mod},cache=".GET_EXT_VERSION("cache")."
\n";
if (GET_EXT_VERSION("cache") >= "0.1.2") {
// Cache version is okay, so let's check the cache!
if (isset($cacheArray['modules']['has_menu'][$mod])) {
// Check module cache and count hit
$ret = ($cacheArray['modules']['has_menu'][$mod] == "Y");
incrementConfigEntry('cache_hits');
} elseif (isset($cacheArray['extensions']['ext_menu'][$mod])) {
// Check cache and count hit
$ret = ($cacheArray['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), __FILE__, __LINE__);
// Entry found?
if (SQL_NUMROWS($result) == 1) {
// Load "has_menu" column
list($has_menu) = SQL_FETCHROW($result);
// Fake cache... ;-)
$cacheArray['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?
$ret = ((IS_ADMIN()) && ($mod == "admin")); // Then there is a menu!
}
// Return status
//* DEBUG: */ 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), __FILE__, __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), __FILE__, __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, &$UPDATE_NOTES) {
// 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 (!empty($UPDATE_NOTES)) {
// Update notes found
$content = array(
'ver' => $ver,
'notes' => $UPDATE_NOTES
);
$UPDATE_NOTES = "";
} elseif (($ver == "0.0") || ($ver == "0.0.0")) {
// Initial release
$content = array(
'ver' => $ver,
'notes' => INITIAL_RELEASE
);
} else {
// No update notes found!
$content = array(
'ver' => $ver,
'notes' => NO_UPDATE_NOTES
);
}
// Load template
$out = LOAD_TEMPLATE("admin_ext_notes", true, $content);
} // END - if
// Return the output
return $out;
}
//
?>