X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fextensions-functions.php;h=8dfde689bd230f9bc3be134c47b29850ef740518;hp=714483dac359db6fb19c53ca17a067dd807d5c48;hb=35fd597b272983427fd88f541ea55642e0b42c9e;hpb=b622c2d9285f044f49328cbd98efbf2f1a24aa8e
diff --git a/inc/extensions-functions.php b/inc/extensions-functions.php
index 714483dac3..8dfde689bd 100644
--- a/inc/extensions-functions.php
+++ b/inc/extensions-functions.php
@@ -16,7 +16,7 @@
* $Author:: $ *
* -------------------------------------------------------------------- *
* Copyright (c) 2003 - 2009 by Roland Haeder *
- * Copyright (c) 2009 - 2012 by Mailer Developer Team *
+ * Copyright (c) 2009 - 2013 by Mailer Developer Team *
* For more information visit: http://mxchange.org *
* *
* This program is free software; you can redistribute it and/or modify *
@@ -41,17 +41,20 @@ if (!defined('__SECURITY')) {
} // END - if
// Load the extension and maybe found language and function files.
-function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = false) {
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_mode=' . $ext_mode . ',ext_ver=' . $ext_ver . ',dry_run=' . intval($dry_run) . ' - ENTERED!');
+function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $isDryRun = FALSE, $previousExtension = NULL) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_mode=' . $ext_mode . ',ext_ver=' . $ext_ver . ',isDryRun=' . intval($isDryRun) . ' - ENTERED!');
// Loading an extension in same mode, but not test/update, twice is not
// good, so is the extension $ext_name already loaded in mode $ext_mode?
if ((isset($GLOBALS['loaded_extension'][$ext_name][$ext_mode])) && (!in_array($ext_mode, array('update', 'test')))) {
// If this happens twice, we need the bug report from you, except for updates/tests
- reportBug(__FUNCTION__, __LINE__, __FUNCTION__ . '() is called twice: ext_name=' . $ext_name . ', ext_mode='. $ext_mode . ',ext_sqls=' . print_r(getExtensionSqls(), true) . ', ext_register_running=' . print_r($GLOBALS['ext_register_running'], true) . ', ext_running_updates=' . print_r($GLOBALS['ext_running_updates'], true));
+ reportBug(__FUNCTION__, __LINE__, __FUNCTION__ . '() is called twice: ext_name=' . $ext_name . ', ext_mode='. $ext_mode . ',ext_sqls=' . print_r(getExtensionSqls(), TRUE) . ', ext_register_running=' . print_r($GLOBALS['ext_register_running'], TRUE) . ', ext_running_updates=' . print_r($GLOBALS['ext_running_updates'], TRUE));
} // END - if
// Make sure this situation can only happen once
- $GLOBALS['loaded_extension'][$ext_name][$ext_mode] = true;
+ $GLOBALS['loaded_extension'][$ext_name][$ext_mode] = TRUE;
+
+ // Remember previous extension here
+ $GLOBALS['previous_extension'][$ext_name] = $previousExtension;
// Set extension mode
setExtensionMode($ext_mode);
@@ -70,7 +73,7 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = fal
setCurrentExtensionVersion('0.0.0');
// Is the extension installed?
- if ((isExtensionInstalled($ext_name)) && ($ext_mode != 'register')) {
+ if ((isExtensionInstalled($ext_name)) && ($ext_mode != 'setup')) {
// Get extension's version
setCurrentExtensionVersion(getExtensionVersion($ext_name));
} // END - if
@@ -78,12 +81,12 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = fal
// In all but test-mode we need these messages to debug! Please report all (together, e.g.)
if (($ext_mode != 'test') && (getCurrentExtensionVersion() == '0.0.0')) {
// Abort here, this must now always be set!
- reportBug(__FUNCTION__, __LINE__, 'Extension version is empty, setting to 0.0. ext_name=' . $ext_name . ', ext_mode=' . $ext_mode . ', dry_run=' . intval($dry_run));
+ reportBug(__FUNCTION__, __LINE__, 'Extension version is empty, setting to 0.0.0 ext_name=' . $ext_name . ', ext_mode=' . $ext_mode . ', isDryRun=' . intval($isDryRun));
} // END - if
}
// Set dry-run
- enableExtensionDryRun($dry_run);
+ enableExtensionDryRun($isDryRun);
// Init array
initIncludePool('extension');
@@ -101,33 +104,33 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = fal
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Loading extension ' . $ext_name . ', getExtensionMode()=' . getExtensionMode() . ', getCurrentExtensionVersion()=' . getCurrentExtensionVersion());
if ((isExtensionLoaded($ext_name)) && (getExtensionMode() == 'init')) {
// Debug message
- logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name));
+ logDebugMessage(__FUNCTION__, __LINE__, sprintf('Extension %s already loaded.', $ext_name));
// Abort here
- return false;
+ return FALSE;
} // END - if
// Is the extension file NOT there?
if (!isExtensionNameValid($ext_name)) {
// Debug message
- logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s not found or not readable or the PHP script is deprecated.", $ext_name));
+ logDebugMessage(__FUNCTION__, __LINE__, sprintf('Extension %s not found or not readable or the PHP script is deprecated.', $ext_name));
// Abort here
- return false;
+ return FALSE;
} // END - if
// Load extension's own language file if not in test mode
- if ((getExtensionMode() != 'test') && (ifExtensionHasLanguageFile($ext_name))) {
+ if ((getExtensionMode() != 'test') && (isExtensionLanguageFileReadable($ext_name))) {
// Load it
loadLanguageFile($ext_name);
} // END - if
- // Do we have cache?
+ // Is there cache?
if (isExtensionFunctionFileReadable($ext_name)) {
// Not yet loaded?
if ((($GLOBALS['cache_array']['extension']['ext_func'][$ext_name] == 'Y') || (!isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name]))) && (!isExtensionLibraryLoaded($ext_name))) {
// Construct IFN for functions file
- $funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
+ $funcsInclude = sprintf('inc/libs/%s_functions.php', $ext_name);
// Mark it as loaded
markExtensionLibraryAsLoaded($ext_name);
@@ -137,7 +140,7 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = fal
} // END - if
} elseif ((!isset($GLOBALS['cache_array']['extension']['ext_func'][$ext_name])) && (isDebugModeEnabled()) && (isHtmlOutputMode()) && ($ext_name != 'sql_patches') && (substr($ext_name, 0, 10) != 'admintheme') && (getExtensionMode() == 'test')) {
// No functions file is not so good...
- logDebugMessage(__FUNCTION__, __LINE__, sprintf("NOTICE: Extension %s has no own functions file or we cannot read from it. mode=%s",
+ logDebugMessage(__FUNCTION__, __LINE__, sprintf('NOTICE: Extension %s has no own functions file or we cannot read from it. mode=%s',
$ext_name,
getExtensionMode()
));
@@ -155,6 +158,9 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = fal
// Include the extension file
loadCurrentExtensionInclude();
+ // Load extra mode files
+ loadCurrentExtensionModeInclude();
+
// Is this extension deprecated?
if ((isExtensionDeprecated()) && (!in_array(getExtensionMode(), array('test', 'update', 'deactivate'))) && (isExtensionActive($ext_name))) {
// Deactivate the extension
@@ -162,7 +168,7 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = fal
// Abort here
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension load aborted, ext_name=' . $ext_name . ' - Extension is deprecated.');
- return false;
+ return FALSE;
} // END - if
// Mark it as loaded in normal mode
@@ -173,34 +179,34 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0.0', $dry_run = fal
// All fine!
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extension successfully loaded, ext_name=' . $ext_name);
- return true;
+ return TRUE;
}
// Registers an extension and possible update dependencies
-function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates = false) {
+function registerExtension ($ext_name, $taskId, $isDryRun = FALSE, $ignoreUpdates = FALSE, $previousExtension = NULL) {
// Set current extension name
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',task_id=' . intval($taskId) . ',dry_run=' . intval($dry_run) . ',ignoreUpdates=' . intval($ignoreUpdates) . ' - ENTERED!');
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId=' . intval($taskId) . ',isDryRun=' . intval($isDryRun) . ',ignoreUpdates=' . intval($ignoreUpdates) . ' - ENTERED!');
setCurrentExtensionName($ext_name);
// Enable dry-run
- enableExtensionDryRun($dry_run);
+ enableExtensionDryRun($isDryRun);
// By default all extensions are in productive phase
enableExtensionProductive();
// This shall never do a non-admin user or if the extension is active (already installed)
- if (((!isAdmin()) && (!isInstallationPhase())) || (isExtensionInstalled($ext_name))) {
+ if (((!isAdmin()) && (!isInstaller())) || (isExtensionInstalled($ext_name))) {
// Abort here with 'false'
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ABORTED: isAdmin()=' . intval(isAdmin()) . ',isInstallationPhase()=' . intval(isInstallationPhase()) . ',isExtensionInstalled()=' . intval(isExtensionInstalled($ext_name)));
- return false;
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ABORTED: isAdmin()=' . intval(isAdmin()) . ',isInstaller()=' . intval(isInstaller()) . ',isExtensionInstalled()=' . intval(isExtensionInstalled($ext_name)));
+ return FALSE;
} // END - if
// When this extension is already in registration/update phase, all is fine
- if ((isExtensionRegistrationRunning($ext_name)) || ((isExtensionUpdateRunning($ext_name)) && ($ignoreUpdates === false))) {
- // Then abort here with 'true' becaus it is fine
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in registration/update phase, all fine,taskId=' . $taskId . ',dry_run=' . intval($dry_run) . ',ignoreUpdates=' . intval($ignoreUpdates));
- //* BUG: */ reportBug(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId=' . $taskId . ',dry_run=' . intval($dry_run) . ',ignoreUpdates=' . intval($ignoreUpdates) . ' - Please investigate!');
- return true;
+ if ((isExtensionRegistrationRunning($ext_name)) || ((isExtensionUpdateRunning($ext_name)) && ($ignoreUpdates === FALSE))) {
+ // Then abort here with 'true' because it is fine
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in registration/update phase, all fine,isDryRun=' . intval($isDryRun) . ',ignoreUpdates=' . intval($ignoreUpdates));
+ //* BUG: */ reportBug(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',isDryRun=' . intval($isDryRun) . ',ignoreUpdates=' . intval($ignoreUpdates) . ' - Please investigate!');
+ return TRUE;
} // END - if
// This registration is running
@@ -213,19 +219,19 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
} // END - if
// Is the task id zero? Then we need to auto-fix it here
- if (($taskId == '0') && (!isInstallationPhase())) {
+ if ((!isValidId($taskId)) && (!isInstaller())) {
// Try to find the task
$taskId = determineExtensionTaskId(getCurrentExtensionName());
// Still zero and not in dry-run?
- if (($taskId == '0') && (!isExtensionDryRun())) {
+ if ((!isValidId($taskId)) && (!isExtensionDryRun())) {
// Now try to create a new task
$taskId = createNewExtensionTask(getCurrentExtensionName());
// Is it still zero?
- if ($taskId == '0') {
+ if (!isValidId($taskId)) {
// Then request a bug report
- reportBug(__FUNCTION__, __LINE__, sprintf("%s: task_id is still zero after determineExtensionTaskId(%s)",
+ reportBug(__FUNCTION__, __LINE__, sprintf('%s: task_id is still zero after determineExtensionTaskId/createNewExtensionTask(%s)',
__FUNCTION__,
getCurrentExtensionName()
));
@@ -238,16 +244,16 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
initExtensionNotes();
// Init variables
- $ret = false;
- $processResult = false;
+ $ret = FALSE;
+ $processResult = FALSE;
initIncludePool('extension');
- // By default we have no failures
+ // By default there is no failure
enableExtensionReportingFailure();
// Does this extension exists?
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ' - CALLING loadExtension() ...');
- if (loadExtension(getCurrentExtensionName(), 'register', '0.0.0', isExtensionDryRun())) {
+ if (loadExtension(getCurrentExtensionName(), 'setup', '0.0.0', isExtensionDryRun(), $previousExtension)) {
// Set current extension name again
setCurrentExtensionName($ext_name);
@@ -257,7 +263,7 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
foreach ($history as $ext_ver) {
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ', ext_ver=' . $ext_ver);
// Load extension in update mode
- loadExtension(getCurrentExtensionName(), 'update', $ext_ver, isExtensionDryRun());
+ loadExtension(getCurrentExtensionName(), 'update', $ext_ver, isExtensionDryRun(), $previousExtension);
// Add update notes to our output
addExtensionNotes($ext_ver);
@@ -273,7 +279,7 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
// Check if extension is not installed and not already in registration procedure and if loading it wents finally fine...
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',isExtensionRegistrationRunning(' . $ext_update . ')=' . intval(isExtensionRegistrationRunning($ext_update)));
- if ((!isExtensionInstalled($ext_update)) && (!isExtensionRegistrationRunning($ext_update)) && (loadExtension($ext_update, 'test', '', isExtensionDryRun()))) {
+ if ((!isExtensionInstalled($ext_update)) && (!isExtensionRegistrationRunning($ext_update)) && (loadExtension($ext_update, 'test', '', isExtensionDryRun(), $previousExtension))) {
// Set current extension name again
setCurrentExtensionName($ext_name);
@@ -285,17 +291,17 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
} // END - if
// Extension version set? If empty the extension is not registered
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_ver[' . gettype($ext_ver) . ']=' . $ext_ver . ',isInstallationPhase()=' . intval(isInstallationPhase()) . ',currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ' - EMPTY?');
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_ver[' . gettype($ext_ver) . ']=' . $ext_ver . ',isInstaller()=' . intval(isInstaller()) . ',currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ' - EMPTY?');
if (empty($ext_ver)) {
// Extension not registered so far so first load task's id...
- $taskId = determineExtensionTaskId($ext_update);
+ $updateTaskId = determineExtensionTaskId($ext_update);
// Entry found?
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'taskId=' . $taskId . ',isInstallationPhase()=' . intval(isInstallationPhase()) . ',currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ' - CHECKING!');
- if (($taskId > 0) || (isInstallationPhase())) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'updateTaskId=' . $updateTaskId . ',isInstaller()=' . intval(isInstaller()) . ',currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ' - CHECKING!');
+ if ((isValidId($updateTaskId)) || (isInstaller())) {
// Try to register the extension
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ',taskId=' . $taskId . ',isExtensionDryRun()=' . isExtensionDryRun());
- $processResult = registerExtension($ext_update, $taskId, isExtensionDryRun(), true);
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',ext_update=' . $ext_update . ',updateTaskId=' . $updateTaskId . ',isExtensionDryRun()=' . intval(isExtensionDryRun()));
+ $processResult = registerExtension($ext_update, $updateTaskId, isExtensionDryRun(), TRUE, $ext_name);
// Reset extension name
setCurrentExtensionName($ext_name);
@@ -314,14 +320,14 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',currVer=' . getCurrentExtensionVersion());
// All okay!
- $processResult = true;
+ $processResult = TRUE;
} else {
// Nothing to register / update before...
- $processResult = true;
+ $processResult = TRUE;
}
} else {
// Required file for update does not exists!
- $processResult = true;
+ $processResult = TRUE;
// But this is fine for the first time...
}
@@ -332,93 +338,106 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
// Is there no update?
if (countExtensionUpdateDependencies(getCurrentExtensionName()) == 0) {
// Then test is passed!
- $processResult = true;
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',processResult=true,countExtensionUpdateDependencies()=0 - Test passed!');
+ $processResult = TRUE;
} // END - if
// Switch back to register mode
- setExtensionMode('register');
+ setExtensionMode('setup');
// Remains true if extension registration reports no failures
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',processResult=' . intval($processResult));
- $processResult = (($processResult === true) && (isExtensionReportingFailure() === false));
+ $processResult = (($processResult === TRUE) && (isExtensionReportingFailure() === FALSE));
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . ',processResult=' . intval($processResult));
// Does everthing before wents ok?
- if ($processResult === true) {
+ if ($processResult === TRUE) {
// "Dry-run-mode" activated?
- if ((isExtensionDryRun() === false) && (!isExtensionOnRemovalList())) {
+ if ((isExtensionDryRun() === FALSE) && (!isExtensionOnRemovalList())) {
// Init SQLs and transfer ext->generic
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName());
initSqls();
setSqlsArray(getExtensionSqls());
+ // Copy current name to save calls
+ $currentName = getCurrentExtensionName();
+
+ // Mark it as NOT installed
+ $GLOBALS['ext_is_installed'][$currentName] = FALSE;
+
// Run installation pre-installation filters
- runFilterChain('pre_extension_installed', array('dry_run' => isExtensionDryRun(), 'enable_codes' => false));
+ runFilterChain('pre_extension_installed', array('dry_run' => isExtensionDryRun(), 'ext_installing' => TRUE, 'enable_codes' => FALSE));
// Register extension
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'insert=' . getCurrentExtensionName() . '/' . getCurrentExtensionVersion() . ' - INSERT!');
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'insert=' . $currentName . '/' . getCurrentExtensionVersion() . ' - INSERT!');
if (isExtensionInstalledAndNewer('sql_patches', '0.0.6')) {
// New way, with CSS
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getThisExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion() . 'ext_css=' . getExtensionHasCss());
- SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`,`ext_active`,`ext_version`,`ext_has_css`) VALUES ('%s','%s','%s','%s')",
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $currentName . ',always_active=' . getThisExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion() . 'ext_css=' . getExtensionHasCss());
+ sqlQueryEscaped("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`, `ext_active`, `ext_version`, `ext_has_css`) VALUES ('%s','%s','%s','%s')",
array(
- getCurrentExtensionName(),
+ $currentName,
getThisExtensionAlwaysActive(),
getCurrentExtensionVersion(),
getExtensionHasCss()
), __FUNCTION__, __LINE__);
} else {
// Old way, no CSS
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getThisExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion());
- SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`,`ext_active`,`ext_version`) VALUES ('%s','%s','%s')",
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $currentName . ',always_active=' . getThisExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion());
+ sqlQueryEscaped("INSERT INTO `{?_MYSQL_PREFIX?}_extensions` (`ext_name`, `ext_active`, `ext_version`) VALUES ('%s','%s','%s')",
array(
- getCurrentExtensionName(),
+ $currentName,
getThisExtensionAlwaysActive(),
getCurrentExtensionVersion()
), __FUNCTION__, __LINE__);
}
- // Use the insert id as extension id and cache it for early usage
- $GLOBALS['cache_array']['extension']['ext_id'][getCurrentExtensionName()] = SQL_INSERTID();
- $GLOBALS['cache_array']['extension']['ext_name'][SQL_INSERTID()] = getCurrentExtensionName();
+ /*
+ * Use the insert id as extension id and "cache" all data for
+ * this extension for early usage.
+ */
+ copyExtensionDataToCacheArray($currentName, getSqlInsertId());
// Mark it as installed
- $GLOBALS['ext_is_installed'][getCurrentExtensionName()] = true;
+ $GLOBALS['ext_is_installed'][$currentName] = TRUE;
- // Remove cache file(s) if extension is active
+ /*
+ * Run filter chain after extension has been "installed" which
+ * means that the extension has been registered in 'extensions'
+ * table and marked as "installed".
+ */
runFilterChain('post_extension_installed', array(
'pool' => 'extension',
- 'ext_name' => getCurrentExtensionName(),
+ 'ext_name' => $currentName,
'task_id' => $taskId
));
// Re-init queries and notes
- initExtensionSqls(true);
- initExtensionNotes(true);
+ initExtensionSqls(TRUE);
+ initExtensionNotes(TRUE);
// In normal mode return a true on success
- $ret = true;
- } elseif (isExtensionDryRun() === true) {
+ $ret = TRUE;
+ } elseif (isExtensionDryRun() === TRUE) {
// In "dry-run" mode do always return a true
- $ret = true;
+ $ret = TRUE;
} else {
// Extension has been removed for updates, so all is fine!
- $ret = true;
+ $ret = TRUE;
}
} else {
// No, an error occurs while registering extension :-(
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName());
- $ret = false;
+ $ret = FALSE;
}
- } elseif (($taskId > 0) && (getCurrentExtensionName() != '')) {
+ } elseif ((isValidId($taskId)) && (getCurrentExtensionName() != '')) {
// Remove task from system when id and extension's name is valid
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName());
- SQL_QUERY_ESC("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `id`=%s AND `status`='NEW' LIMIT 1",
+ sqlQueryEscaped("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `id`=%s AND `status`='NEW' LIMIT 1",
array(bigintval($taskId)), __FUNCTION__, __LINE__);
}
// @TODO This redirect is still needed to register sql_patches! Please try to avoid it
- if (($ret === true) && ($dry_run === false) && ($ext_name == 'sql_patches') && (!isInstallationPhase())) {
+ if (($ret === TRUE) && ($isDryRun === FALSE) && ($ext_name == 'sql_patches') && (!isInstaller())) {
/*
* This is a really dirty hack to prevent an error about a missing
* configuration entry which should be there after registration of
@@ -428,7 +447,7 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
} // END - if
// Return status code
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',currName=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',processResult=' . intval($processResult) . ',ret=' . intval($ret) . ' - EXIT!');
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',currName=' . getCurrentExtensionName() . ',processResult=' . intval($processResult) . ',ret=' . intval($ret) . ' - EXIT!');
return $ret;
}
@@ -436,9 +455,9 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $ignoreUpdates
// @TODO Change from ext_id to ext_name (not just even the variable! ;-) )
function doExtensionSqls ($ext_id, $load_mode) {
// This shall never do a non-admin user but installation phase is okay
- if ((!isAdmin()) && (!isInstallationPhase())) {
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_id=' . $ext_id. ',load_mode=' . $load_mode . ',isAdmin()=' . intval(isAdmin()) . ',isInstallationPhase()=' . intval(isInstallationPhase()) . ' - ABORT!');
- return false;
+ if ((!isAdmin()) && (!isInstaller())) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_id=' . $ext_id. ',load_mode=' . $load_mode . ',isAdmin()=' . intval(isAdmin()) . ',isInstaller()=' . intval(isInstaller()) . ' - ABORT!');
+ return FALSE;
} // END - if
// Get extension's name
@@ -454,14 +473,14 @@ function doExtensionSqls ($ext_id, $load_mode) {
} // END - if
// Init array
- initExtensionSqls(true);
+ initExtensionSqls(TRUE);
// By default no SQL has been executed
- $sqlRan = false;
+ $sqlRan = FALSE;
// Load extension in detected mode
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name[' . $ext_id . ']=' . getCurrentExtensionName() . ',load_mode=' . $load_mode);
- loadExtension(getCurrentExtensionName(), $load_mode, '0.0.0', false);
+ loadExtension(getCurrentExtensionName(), $load_mode, '0.0.0', FALSE);
// Init these SQLs
initSqls();
@@ -470,8 +489,8 @@ function doExtensionSqls ($ext_id, $load_mode) {
// Debug message
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SQLs::count=' . countSqls());
- // Do we have entries?
- if (isSqlsValid()) {
+ // Are there entries?
+ if (ifSqlsRegistered()) {
// Run SQL commands...
runFilterChain('run_sqls');
} // END - if
@@ -480,14 +499,14 @@ function doExtensionSqls ($ext_id, $load_mode) {
runFilterChain('extension_' . $load_mode);
// Remove cache file(s) if extension is active
- if (((isExtensionActive('cache')) && ((!SQL_HASZEROAFFECTED()) || ($sqlRan === true) || ($load_mode == 'activate') || ($load_mode == 'deactivate')))) {
+ if (((isExtensionActive('cache')) && ((!ifSqlHasZeroAffectedRows()) || ($sqlRan === TRUE) || ($load_mode == 'activate') || ($load_mode == 'deactivate')))) {
// Run filters
runFilterChain('post_extension_run_sql', getCurrentExtensionName());
} // END - if
// Is this the sql_patches?
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'id=' . $ext_id . ',currName=' . getCurrentExtensionName() . ',loadMode=' . $load_mode);
- if ((getCurrentExtensionName() == 'sql_patches') && (($load_mode == 'register') || ($load_mode == 'remove'))) {
+ if ((getCurrentExtensionName() == 'sql_patches') && (($load_mode == 'setup') || ($load_mode == 'remove'))) {
// Then redirect to logout
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, ': LOAD!');
redirectToUrl('modules.php?module=admin&logout=1&' . $load_mode . '=sql_patches');
@@ -504,7 +523,7 @@ function isExtensionInstalled ($ext_name) {
} // END - if
// By default non is installed
- $isInstalled = false;
+ $isInstalled = FALSE;
// Check if there is a cache entry
if (isset($GLOBALS['ext_is_installed'][$ext_name])) {
@@ -514,27 +533,27 @@ function isExtensionInstalled ($ext_name) {
} elseif (isset($GLOBALS['cache_array']['extension']['ext_id'][$ext_name])) {
// Found!
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - FOUND!');
- $isInstalled = true;
+ $isInstalled = TRUE;
// Count cache hits
incrementStatsEntry('cache_hits');
- } elseif (isInstallationPhase()) {
+ } elseif ((isInstaller()) && (!isSqlLinkUp())) {
// Extensions are all inactive/not installed during installation
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - installation phase detected.');
} else {
// Look in database
$ext_id = getExtensionId($ext_name);
- // Do we have a record?
- $isInstalled = ($ext_id > 0);
+ // Is there a record?
+ $isInstalled = isValidId($ext_id);
// Log debug message
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_id=' . $ext_id . ',isInstalled=' . intval($isInstalled));
// Is it installed, then cache the entry
- if ($isInstalled === true) {
+ if ($isInstalled === TRUE) {
// Dummy call (get is okay here)
- getExtensionId($ext_name, true);
+ getExtensionId($ext_name, TRUE);
} // END - if
// Remember the status
@@ -548,17 +567,17 @@ function isExtensionInstalled ($ext_name) {
// Check if given extension is active
function isExtensionActive ($ext_name) {
- if (isInstallationPhase()) {
+ if ((isInstaller()) && (!isSqlLinkUp())) {
// Extensions are all inactive during installation
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Extensions are always inactive while installation phase. ext_name=' . $ext_name);
- return false;
+ return FALSE;
} elseif (empty($ext_name)) {
// Empty extension names must befixed
reportBug(__FUNCTION__, __LINE__, 'Empty extension name provided.');
} elseif (!isExtensionInstalled($ext_name)) {
// Not installed extensions are always inactive
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Not installed extensions are always inactive. ext_name=' . $ext_name);
- return false;
+ return FALSE;
}
// Not active is the default
@@ -578,21 +597,20 @@ function isExtensionActive ($ext_name) {
} elseif (($ext_name == 'cache') || (!isExtensionInstalled('cache'))) {
//* DEBUG: */ logDebugMessage(__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",
+ $result = sqlQueryEscaped("SELECT * FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
array($ext_name), __FUNCTION__, __LINE__);
// Entry found?
- if (SQL_NUMROWS($result) == 1) {
+ if (sqlNumRows($result) == 1) {
// Load entry
- $data = SQL_FETCHARRAY($result);
+ $data = sqlFetchArray($result);
+
+ // Set cache
+ setExtensionCacheRow($ext_name, $data);
} // END - if
// Free result
- SQL_FREERESULT($result);
-
- // Write cache array
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . '[DB]: ' . $data['ext_active']);
- $GLOBALS['cache_array']['extension']['ext_active'][$ext_name] = $data['ext_active'];
+ sqlFreeResult($result);
} else {
// Extension not active!
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ': Not active!');
@@ -606,8 +624,34 @@ function isExtensionActive ($ext_name) {
return ($data['ext_active'] == 'Y');
}
+// Sets extension cache row
+function setExtensionCacheRow ($ext_name, &$data) {
+ // Add all
+ foreach ($data as $key => $value) {
+ // Is key=id?
+ if ($key == 'id') {
+ $data['ext_id'] = $value;
+ $key == 'ext_id';
+ } // END - if
+
+ // Is key=ext_has_css?
+ if ($key == 'ext_has_css') {
+ $data['ext_css'] = $value;
+ $key == 'ext_css';
+ } // END - if
+
+ // Set all entries
+ if ($key == 'ext_name') {
+ $GLOBALS['cache_array']['extension']['ext_name'][$data['id']] = $value;
+ } else {
+ // Add ordinary entry
+ $GLOBALS['cache_array']['extension'][$key][$ext_name] = $value;
+ }
+ } // END - foreach
+}
+
// Get version from extensions
-function getExtensionVersion ($ext_name, $force = false) {
+function getExtensionVersion ($ext_name, $force = FALSE) {
// By default no extension is found
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
$data['ext_version'] = 'false';
@@ -619,7 +663,7 @@ function getExtensionVersion ($ext_name, $force = false) {
} // END - if
// Extensions are all inactive during installation
- if (isInstallationPhase()) {
+ if ((isInstaller()) && (!isSqlLinkUp())) {
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',force=' . intval($force) . ' - Installation phase detected, returning empty version.');
return '';
} // END - if
@@ -633,32 +677,32 @@ function getExtensionVersion ($ext_name, $force = false) {
// Count cache hits
incrementStatsEntry('cache_hits');
- } elseif ((!isCacheInstanceValid()) || (isset($GLOBALS['cache_array']['extension'])) || (!isHtmlOutputMode())) {
+ } elseif ((!isValidCacheInstance()) || (isset($GLOBALS['cache_array']['extension'])) || (!isHtmlOutputMode())) {
// Load from database
- $result = SQL_QUERY_ESC("SELECT `ext_version` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
+ $result = sqlQueryEscaped("SELECT * FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
array($ext_name), __FUNCTION__, __LINE__);
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ': DB - '.SQL_NUMROWS($result).'');
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ': DB - '.sqlNumRows($result).'');
// Is the extension there?
- if (SQL_NUMROWS($result) == 1) {
+ if (sqlNumRows($result) == 1) {
// Load entry
- $data = SQL_FETCHARRAY($result);
+ $data = sqlFetchArray($result);
// Set cache
- $GLOBALS['cache_array']['extension']['ext_version'][$ext_name] = $data['ext_version'];
+ setExtensionCacheRow($ext_name, $data);
} elseif (isDebugModeEnabled()) {
// Not found, may happen while an extension is uninstalled
- logDebugMessage(__FUNCTION__, __LINE__, sprintf("Cannot find extension %s in database!", $ext_name));
+ logDebugMessage(__FUNCTION__, __LINE__, sprintf('Cannot find extension %s in database!', $ext_name));
}
// Free result
- SQL_FREERESULT($result);
+ sqlFreeResult($result);
}
// Extension version should not be invalid
- if (($data['ext_version'] == 'false') && ($force === false)) {
+ if (($data['ext_version'] == 'false') && ($force === FALSE)) {
// Please report this trouble
- reportBug(__FUNCTION__, __LINE__, sprintf("Extension %s has empty version!", $ext_name));
+ reportBug(__FUNCTION__, __LINE__, sprintf('Extension %s has empty version!', $ext_name));
} // END - if
// Return result
@@ -667,9 +711,9 @@ function getExtensionVersion ($ext_name, $force = false) {
}
// Updates a given extension with current extension version to latest version
-function updateExtension ($ext_name, $ext_ver, $dry_run = false, $ignoreDependencies = false) {
+function updateExtension ($ext_name, $ext_ver, $isDryRun = FALSE, $ignoreDependencies = FALSE) {
// Only admins are allowed to update extensions
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',dry_run=' . intval($dry_run) . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - ENTERED!');
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',isDryRun=' . intval($isDryRun) . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - ENTERED!');
if ((!isAdmin()) || (empty($ext_name))) {
// Called as non-admin or empty extension
reportBug(__FUNCTION__, __LINE__, 'Called as non-admin (isAdmin()=' . intval(isAdmin()) . '), or empty extension name. ext_name=' . $ext_name);
@@ -679,11 +723,11 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false, $ignoreDependen
setCurrentExtensionName($ext_name);
// Is this extension update already running?
- if ((isExtensionUpdateRunning($ext_name, $ignoreDependencies)) && ($dry_run === false)) {
+ if ((isExtensionUpdateRunning($ext_name, $ignoreDependencies)) && ($isDryRun === FALSE)) {
// This is fine but needs logging ATM
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in update phase, all fine.');
//* BUG: */ reportBug(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - already in update phase, please investigate!');
- return true;
+ return TRUE;
} // END - if
// Init arrays
@@ -721,7 +765,7 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false, $ignoreDependen
$depencies = getExtensionUpdateDependencies();
// Nothing to apply?
- if (count($depencies) > 0) {
+ if (isFilledArray($depencies)) {
// Apply all extension depencies
foreach ($depencies as $ext_depend) {
// Did we already update/register this?
@@ -730,15 +774,15 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false, $ignoreDependen
setCurrentExtensionName($ext_depend);
// Mark it as already updated before we update it
- $GLOBALS['ext_updated'][$ext_depend] = true;
+ $GLOBALS['ext_updated'][$ext_depend] = TRUE;
// Is the extension there?
if (isExtensionInstalled($ext_depend)) {
// Update another extension first!
- $processResult = updateExtension($ext_depend, getExtensionVersion($ext_depend), isExtensionDryRun(), true);
+ $processResult = updateExtension($ext_depend, getExtensionVersion($ext_depend), isExtensionDryRun(), TRUE);
} else {
// Register new extension
- $processResult = registerExtension($ext_depend, 0, isExtensionDryRun());
+ $processResult = registerExtension($ext_depend, NULL, isExtensionDryRun());
}
} // END - if
} // END - foreach
@@ -755,7 +799,7 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false, $ignoreDependen
} // END - for
// In real-mode execute any existing includes
- if (isExtensionDryRun() === false) {
+ if (isExtensionDryRun() === FALSE) {
$GLOBALS['ext_inc_pool'][getCurrentExtensionName()] = getIncludePool('extension');
runFilterChain('load_includes', 'extension');
setIncludePool('extension', $GLOBALS['ext_inc_pool'][getCurrentExtensionName()]);
@@ -767,15 +811,15 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false, $ignoreDependen
setSqlsArray(getExtensionSqls());
// Run SQLs
- runFilterChain('run_sqls', array('dry_run' => isExtensionDryRun(), 'enable_codes' => false));
+ runFilterChain('run_sqls', array('dry_run' => isExtensionDryRun(), 'ext_installing' => TRUE, 'enable_codes' => FALSE));
- if (isExtensionDryRun() === false) {
+ if (isExtensionDryRun() === FALSE) {
// Run filters on success extension update
runFilterChain('extension_update', getCurrentExtensionName());
} // END - if
} // END - if
- //* DEBUG: */logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',dry_run=' . intval($dry_run) . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - EXIT!');
+ //* DEBUG: */logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_ver=' . $ext_ver . ',isDryRun=' . intval($isDryRun) . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - EXIT!');
}
// Output verbose SQL table for extension
@@ -789,9 +833,9 @@ function addExtensionVerboseSqlTable ($title = '{--ADMIN_SQLS_EXECUTED_ON_REMOVA
// Init variables
$OUT = '';
- // Do we have queries?
+ // Is there queries?
if (isVerboseSqlEnabled()) {
- // Do we have entries?
+ // Are there entries?
if (countExtensionSqls() > 0) {
// Init counter
$idx = 0;
@@ -811,7 +855,7 @@ function addExtensionVerboseSqlTable ($title = '{--ADMIN_SQLS_EXECUTED_ON_REMOVA
);
// Load row template
- $OUT .= loadTemplate('admin_extension_sql_row', true, $content);
+ $OUT .= loadTemplate('admin_extension_sql_row', TRUE, $content);
// Count up
$idx++;
@@ -826,10 +870,10 @@ function addExtensionVerboseSqlTable ($title = '{--ADMIN_SQLS_EXECUTED_ON_REMOVA
);
// Load main template
- $OUT = loadTemplate('admin_extension_sql_table', true, $content);
+ $OUT = loadTemplate('admin_extension_sql_table', TRUE, $content);
} else {
// No addional SQL commands to run
- $OUT = displayMessage('{--ADMIN_EXTENSION_VERBOSE_SQLS_404--}', true);
+ $OUT = displayMessage('{--ADMIN_EXTENSION_VERBOSE_SQLS_404--}', TRUE);
}
} // END - if
@@ -851,17 +895,17 @@ function getExtensionName ($ext_id) {
incrementStatsEntry('cache_hits');
} elseif (!isExtensionActive('cache')) {
// Load from database
- $result = SQL_QUERY_ESC("SELECT `ext_name` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `id`=%s LIMIT 1",
+ $result = sqlQueryEscaped("SELECT `ext_name` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `id`=%s LIMIT 1",
array(bigintval($ext_id)), __FUNCTION__, __LINE__);
// Is the entry there?
- if (SQL_NUMROWS($result) == 1) {
+ if (sqlNumRows($result) == 1) {
// Get the extension's name from database
- $data = SQL_FETCHARRAY($result);
+ $data = sqlFetchArray($result);
} // END - if
// Free result
- SQL_FREERESULT($result);
+ sqlFreeResult($result);
}
// Did we find some extension?
@@ -879,7 +923,7 @@ function getExtensionId ($ext_name) {
// Init id number
$data['ext_id'] = '0';
- // Do we have cache?
+ // Is there cache?
if (isset($GLOBALS['cache_array']['extension']['ext_id'][$ext_name])) {
// Load from cache
$data['ext_id'] = $GLOBALS['cache_array']['extension']['ext_id'][$ext_name];
@@ -888,20 +932,20 @@ function getExtensionId ($ext_name) {
incrementStatsEntry('cache_hits');
} else {
// Load from database
- $result = SQL_QUERY_ESC("SELECT `id` AS `ext_id` FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
+ $result = sqlQueryEscaped("SELECT * FROM `{?_MYSQL_PREFIX?}_extensions` WHERE `ext_name`='%s' LIMIT 1",
array($ext_name), __FUNCTION__, __LINE__);
// Is the entry there?
- if (SQL_NUMROWS($result) == 1) {
+ if (sqlNumRows($result) == 1) {
// Get the extension's id from database
- $data = SQL_FETCHARRAY($result);
+ $data = sqlFetchArray($result);
+
+ // Set cache
+ setExtensionCacheRow($ext_name, $data);
} // END - if
// Free result
- SQL_FREERESULT($result);
-
- // Cache it
- $GLOBALS['cache_array']['extension']['ext_id'][$ext_name] = $data['ext_id'];
+ sqlFreeResult($result);
}
// Return value
@@ -910,7 +954,7 @@ function getExtensionId ($ext_name) {
// Determines whether the given extension name is valid
function isExtensionNameValid ($ext_name) {
- // Do we have cache?
+ // Is there cache?
if (!isset($GLOBALS['ext_name_valid'][$ext_name])) {
// Generate include file name
$INC = sprintf("inc/extensions/ext-%s.php", $ext_name);
@@ -926,18 +970,18 @@ function isExtensionNameValid ($ext_name) {
// Determines whether the given extension id is valid
function isExtensionIdValid ($ext_id) {
// Default is nothing valid
- $isValid = false;
+ $isValid = FALSE;
// Check in cache then in database
if (isset($GLOBALS['cache_array']['extension']['ext_name'][$ext_id])) {
// Valid!
- $isValid = true;
+ $isValid = TRUE;
// Count cache hits
incrementStatsEntry('cache_hits');
} else {
// Query database
- $isValid = (countSumTotalData($ext_id, 'extensions', 'id', 'id', true) == 1);
+ $isValid = (countSumTotalData($ext_id, 'extensions', 'id', 'id', TRUE) == 1);
}
// Return result
@@ -953,7 +997,7 @@ function doActivateExtension ($ext_name) {
} // END - if
// Activate the extension
- SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='Y' WHERE `ext_name`='%s' LIMIT 1",
+ sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='Y' WHERE `ext_name`='%s' LIMIT 1",
array($ext_name), __FUNCTION__, __LINE__);
// Then run all queries
@@ -961,7 +1005,7 @@ function doActivateExtension ($ext_name) {
}
// Deactivate given extension
-function doDeactivateExtension ($ext_name, $inRebuild = false) {
+function doDeactivateExtension ($ext_name, $inRebuild = FALSE) {
// Is the extension installed?
if (!isExtensionInstalled($ext_name)) {
// Non-installed extensions cannot be activated
@@ -969,7 +1013,7 @@ function doDeactivateExtension ($ext_name, $inRebuild = false) {
} // END - if
// Activate the extension
- SQL_QUERY_ESC("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='N' WHERE `ext_name`='%s' LIMIT 1",
+ sqlQueryEscaped("UPDATE `{?_MYSQL_PREFIX?}_extensions` SET `ext_active`='N' WHERE `ext_name`='%s' LIMIT 1",
array($ext_name), __FUNCTION__, __LINE__);
// Then run all queries
@@ -979,7 +1023,7 @@ function doDeactivateExtension ($ext_name, $inRebuild = false) {
createExtensionDeactivationTask($ext_name);
// Do not rebuild cache if it is already been rebuild
- if ($inRebuild === false) {
+ if ($inRebuild === FALSE) {
// Rebuild cache
rebuildCache('extension', 'extension');
} // END - if
@@ -992,19 +1036,6 @@ function doDeactivateExtension ($ext_name, $inRebuild = false) {
);
}
-// Checks whether the extension is older than given
-function isExtensionOlder ($ext_name, $ext_ver) {
- // Get current extension version
- $currVersion = getExtensionVersion($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 createExtensionUpdateTask ($adminId, $ext_name, $ext_ver, $notes) {
// Create subject line
@@ -1016,7 +1047,7 @@ function createExtensionUpdateTask ($adminId, $ext_name, $ext_ver, $notes) {
// Is the extension there?
if (isExtensionInstalled($ext_name)) {
// Check if task is not there
- if ($taskId == '0') {
+ if (!isValidId($taskId)) {
// Create extension update-task
$taskId = createNewTask($subject, $notes, 'EXTENSION_UPDATE', 0, $adminId);
} // END - if
@@ -1038,28 +1069,28 @@ function createNewExtensionTask ($ext_name) {
$taskId = determineTaskIdBySubject($subject);
// Not installed and do we have created a task for the admin?
- if (($taskId == '0') && (!isExtensionInstalled($ext_name))) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId[' . gettype($taskId) . ']=' . $taskId);
+ if ((!isValidId($taskId)) && (!isExtensionInstalled($ext_name))) {
// Set default message if ext-foo is missing
$message = '{%message,ADMIN_EXTENSION_TEXT_FILE_MISSING=' . $ext_name . '%}';
// Template file
- $FQFN = sprintf("%stemplates/%s/html/ext/ext_%s.tpl",
- getPath(),
- getLanguage(),
+ $FQFN = sprintf('%s/ext/ext_%s.tpl',
+ getTemplateBasePath('html'),
$ext_name
);
// Load text for task if found
if (isFileReadable($FQFN)) {
// Load extension's description template (but do not compile the code)
- $message = loadTemplate('ext_' . $ext_name, true, array(), false);
+ $message = '{OPEN_TEMPLATE}template,LoadTemplate=ext_' . $ext_name . '{CLOSE_TEMPLATE}';
} else {
// Write this in debug.log as well
logDebugMessage(__FUNCTION__, __LINE__, $message);
}
// Task not created so it's a brand-new extension which we need to register and create a task for!
- $taskId = createNewTask($subject, $message, 'EXTENSION', 0, getCurrentAdminId(), false);
+ $taskId = createNewTask($subject, $message, 'EXTENSION', 0, getCurrentAdminId(), FALSE);
} // END - if
// Return task id
@@ -1075,9 +1106,10 @@ function createExtensionDeactivationTask ($ext_name) {
$taskId = determineTaskIdBySubject($subject);
// Not installed and do we have created a task for the admin?
- if (($taskId == '0') && (isExtensionInstalled($ext_name))) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',taskId[' . gettype($taskId) . ']=' . $taskId);
+ if ((!isValidId($taskId)) && (isExtensionInstalled($ext_name))) {
// Task not created so add it
- $taskId = createNewTask($subject, SQL_ESCAPE(loadTemplate('task_EXTENSION_deactivated', true, $ext_name)), 'EXTENSION_DEACTIVATION');
+ $taskId = createNewTask($subject, sqlEscapeString(loadTemplate('task_EXTENSION_deactivated', TRUE, $ext_name)), 'EXTENSION_DEACTIVATION');
} // END - if
// Return task id
@@ -1086,21 +1118,27 @@ function createExtensionDeactivationTask ($ext_name) {
// Determines the task id for given extension
function determineExtensionTaskId ($ext_name) {
+ // Is it installation phase and table task_system is not found?
+ if ((isInstaller()) && (!ifSqlTableExists('task_system'))) {
+ // Then return NULL (not found)
+ return NULL;
+ } // END - if
+
// Default is not found
- $data['task_id'] = '0';
+ $data['task_id'] = NULL;
// Search for extension task's id
- $result = SQL_QUERY_ESC("SELECT `id` AS task_id FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `task_type`='EXTENSION' AND `subject`='[%s:]' LIMIT 1",
+ $result = sqlQueryEscaped("SELECT `id` AS `task_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) {
+ if (sqlNumRows($result) == 1) {
// Task found so load task's id and register extension...
- $data = SQL_FETCHARRAY($result);
+ $data = sqlFetchArray($result);
} // END - if
// Free result
- SQL_FREERESULT($result);
+ sqlFreeResult($result);
// Return it
return $data['task_id'];
@@ -1112,17 +1150,17 @@ function determineTaskIdBySubject ($subject) {
$data['task_id'] = '0';
// Search for task id
- $result = SQL_QUERY_ESC("SELECT `id` AS task_id FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `subject` LIKE '%s%%' LIMIT 1",
+ $result = sqlQueryEscaped("SELECT `id` AS `task_id` FROM `{?_MYSQL_PREFIX?}_task_system` WHERE `subject` LIKE '%s%%' LIMIT 1",
array($subject), __FUNCTION__, __LINE__);
// Entry found?
- if (SQL_NUMROWS($result) == 1) {
+ if (sqlNumRows($result) == 1) {
// Task found so load task's id and register extension...
- $data = SQL_FETCHARRAY($result);
+ $data = sqlFetchArray($result);
} // END - if
// Free result
- SQL_FREERESULT($result);
+ sqlFreeResult($result);
// Return it
return $data['task_id'];
@@ -1152,25 +1190,25 @@ function addExtensionNotes ($ext_ver) {
// Initial release
$content = array(
'ver' => $ext_ver,
- 'notes' => '{--INITIAL_RELEASE--}'
+ 'notes' => '{--ADMIN_EXTENSION_INITIAL_RELEASE--}'
);
} else {
// Not productive
$content = array(
'ver' => $ext_ver,
- 'notes' => '{--DEVELOPER_RELEASE--}'
+ 'notes' => '{--ADMIN_EXTENSION_DEVELOPER_RELEASE--}'
);
}
} else {
// No update notes found
$content = array(
'ver' => $ext_ver,
- 'notes' => '{--NO_UPDATE_NOTICES--}'
+ 'notes' => '{--ADMIN_EXTENSION_UPDATE_NOTICES_404--}'
);
}
// Load template
- $out = loadTemplate('admin_extension_notes', true, $content);
+ $out = loadTemplate('admin_extension_notes', TRUE, $content);
} // END - if
// Add the notes
@@ -1270,7 +1308,7 @@ function addExtensionDependency ($updateDepends) {
* Double-adding happens when the extension and an update of the same
* extension requires the same other extension again.
*/
- logDebugMessage(__FUNCTION__, __LINE__, 'updateDepends=' . $updateDepends . ',extensionMode=' . getExtensionMode() . ',currentExtension=' . getCurrentExtensionName() . ' - called twice.');
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'updateDepends=' . $updateDepends . ',extensionMode=' . getExtensionMode() . ',currentExtension=' . getCurrentExtensionName() . ' - called twice.');
return;
} // END - if
@@ -1341,20 +1379,26 @@ function isExtensionUpdateDependenciesInitialized () {
}
// Checks whether an update is already running for given extension
-function isExtensionUpdateRunning ($ext_name, $ignoreDependencies = false) {
+function isExtensionUpdateRunning ($ext_name, $ignoreDependencies = FALSE) {
+ // 'ext_running_updates' must be there
+ if ((!isset($GLOBALS['ext_running_updates'])) || (!is_array($GLOBALS['ext_running_updates']))) {
+ // Is not there
+ reportBug(__FUNCTION__, __LINE__, 'Required array ext_running_updates not found. ext_name=' . $ext_name . ',ignoreDependencies=' . intval($ignoreDependencies));
+ } // END - if
+
// Current and given extensions means whole array
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currentExtension=' . getCurrentExtensionName() . ',ext_name=' . $ext_name . ',ignoreDependencies=' . intval($ignoreDependencies) . ' - ENTERED!');
if ($ext_name == getCurrentExtensionName()) {
// Default is not found
- $isRunning = false;
+ $isRunning = FALSE;
// Walk through whole array
foreach ($GLOBALS['ext_running_updates'] as $ext1 => $depends) {
// Is it found?
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',depends=' . print_r($depends, true));
- if (($ext1 == $ext_name) || ((in_array($ext_name, $depends)) && ($ignoreDependencies === false))) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',depends=' . print_r($depends, TRUE));
+ if (($ext1 == $ext_name) || ((in_array($ext_name, $depends)) && ($ignoreDependencies === FALSE))) {
// Found
- $isRunning = true;
+ $isRunning = TRUE;
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',isRunning=true - FOUND!');
break;
} // END - if
@@ -1409,7 +1453,7 @@ function removeExtensionDependency ($ext_name) {
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',key[' . gettype($key) . ']=' . $key);
// Is it valid?
- if ($key !== false) {
+ if ($key !== FALSE) {
// Then remove it
unset($GLOBALS['ext_update_depends'][getCurrentExtensionName()][$key]);
@@ -1444,7 +1488,7 @@ function incrementExtensionUpdateIterator () {
}
// Setter for EXT_REPORTS_FAILURE flag
-function enableExtensionReportingFailure ($reportsFailure = false) {
+function enableExtensionReportingFailure ($reportsFailure = FALSE) {
$GLOBALS['ext_reports_failure'] = (bool) $reportsFailure;
}
@@ -1492,9 +1536,9 @@ function isExtensionUpdateNoteSet ($ext_ver) {
}
// Init extension notice
-function initExtensionNotes ($force = false) {
+function initExtensionNotes ($force = FALSE) {
// Is it already initialized?
- if (($force === false) && (isset($GLOBALS['ext_notes'][getCurrentExtensionName()]))) {
+ if (($force === FALSE) && (isset($GLOBALS['ext_notes'][getCurrentExtensionName()]))) {
// This is mostly not wanted, so please report it
reportBug(__FUNCTION__, __LINE__, 'ext_notes already set for extension ' . getCurrentExtensionName());
} // END - if
@@ -1531,9 +1575,9 @@ function getCurrentExtensionName () {
}
// Init SQLs array for current extension
-function initExtensionSqls ($force = false) {
+function initExtensionSqls ($force = FALSE) {
// Auto-init the array or if forced
- if (($force === true) || (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()]))) {
+ if (($force === TRUE) || (!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()]))) {
// Set the array
$GLOBALS['ext_sqls'][getCurrentExtensionName()] = array();
@@ -1544,15 +1588,29 @@ function initExtensionSqls ($force = false) {
// Adds SQLs to the SQLs array but "assigns" it with current extension name
function addExtensionSql ($sql) {
+ // Copy current name/version to local variable
+ $currentName = getCurrentExtensionName();
+ $currentVersion = getCurrentExtensionVersion();
+
// Is is the array there?
- if ((!isset($GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()])) || (!is_array($GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()]))) {
+ if ((!isset($GLOBALS['ext_sqls'][$currentName][$currentVersion])) || (!is_array($GLOBALS['ext_sqls'][$currentName][$currentVersion]))) {
// Init array
- $GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()] = array();
+ $GLOBALS['ext_sqls'][$currentName][$currentVersion] = array();
+ } // END - if
+
+ // Is the SQL statement empty?
+ if (empty($sql)) {
+ /*
+ * Abort here as this may happen if getExtensionMode() is 'activate' or
+ * 'deactivate'. This means that for 'mode' are no SQL statements
+ * specified.
+ */
+ return;
} // END - if
// Add it
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',ext_version=' . getCurrentExtensionVersion() . ',sql=' . $sql);
- array_push($GLOBALS['ext_sqls'][getCurrentExtensionName()][getCurrentExtensionVersion()], $sql);
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $currentName . ',ext_version=' . $currentVersion . ',sql=' . $sql);
+ array_push($GLOBALS['ext_sqls'][$currentName][$currentVersion], $sql);
}
// Getter for SQLs array for current extension
@@ -1633,15 +1691,15 @@ function FILTER_INIT_EXTENSIONS () {
// Init notification pool
initIncludePool('notify');
- // Do we have some entries?
+ // Are there some entries?
if (isset($GLOBALS['cache_array']['extension']['ext_name'])) {
// Load all found extensions if found
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - START!');
foreach ($GLOBALS['cache_array']['extension']['ext_name'] as $key => $ext_name) {
// Load it
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name='.$ext_name.' - START');
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - START');
loadExtension($ext_name, 'init', getExtensionVersion($ext_name));
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name='.$ext_name.' - END');
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - END');
} // END - foreach
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - END!');
} // END - if
@@ -1663,14 +1721,14 @@ function getExtensionMode () {
}
// Setter for dry-run
-function enableExtensionDryRun ($dry_run = true) {
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()='.getCurrentExtensionName().',dry_run='.intval($dry_run));
- $GLOBALS['ext_dry_run'] = (bool) $dry_run;
+function enableExtensionDryRun ($isDryRun = TRUE) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getCurrentExtensionName()='.getCurrentExtensionName().',isDryRun='.intval($isDryRun));
+ $GLOBALS['ext_isDryRun'] = (bool) $isDryRun;
}
// Getter for dry-run
function isExtensionDryRun () {
- return $GLOBALS['ext_dry_run'];
+ return $GLOBALS['ext_isDryRun'];
}
// Setter for current extension version
@@ -1709,7 +1767,7 @@ function removeExtensionFromArray () {
$key = array_search($ext_name, $cacheArray);
// Is it there?
- if ($key !== false) {
+ if ($key !== FALSE) {
// Found, so remove it
unset($cacheArray[$key]);
$GLOBALS['cache_array']['extension'][$cacheName] = $cacheArray;
@@ -1724,12 +1782,11 @@ function removeExtensionFromArray () {
// "Getter" for 'extension has a CSS file' (with same name, of course)
function getExtensionHasCss () {
- // Do we have cache?
+ // Is there cache?
if (!isset($GLOBALS[__FUNCTION__][getCurrentExtensionName()][getCurrentTheme()])) {
// Construct FQFN for check
- $FQFN = sprintf("%stheme/%s/css/%s.css",
- getPath(),
- getCurrentTheme(),
+ $FQFN = sprintf('%s%s.css',
+ getBasePathFromTheme(getCurrentTheme()),
getCurrentExtensionName()
);
@@ -1741,9 +1798,9 @@ function getExtensionHasCss () {
return $GLOBALS[__FUNCTION__][getCurrentExtensionName()][getCurrentTheme()];
}
-// Checks whether the given extension has a language file
-function ifExtensionHasLanguageFile ($ext_name) {
- // Do we have cache?
+// Checks whether the given extension's language file is readable
+function isExtensionLanguageFileReadable ($ext_name) {
+ // Is there cache?
if (isset($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name])) {
// Count cache hits
incrementStatsEntry('cache_hits');
@@ -1771,6 +1828,18 @@ function loadCurrentExtensionInclude () {
loadInclude($INC);
}
+// Load current extension's mode include file
+function loadCurrentExtensionModeInclude () {
+ // Generate INC name
+ $INC = sprintf("inc/extensions/%s/mode-%s.php", getCurrentExtensionName(), getExtensionMode());
+
+ // Is the include readable?
+ if (isIncludeReadable($INC)) {
+ // Load it as it is optional
+ loadInclude($INC);
+ } // END - if
+}
+
// Checks whether an extension is readable
function isExtensionIncludeReadable ($ext_name = '') {
// If empty, use current
@@ -1828,8 +1897,8 @@ CHARACTER SET utf8
COLLATE utf8_general_ci
COMMENT ' . chr(39) . $comment . chr(39));
} else {
- // Is already there, which should not happen
- reportBug(__FUNCTION__, __LINE__, 'The table ' . $tableName . ' is already created which should not happen.');
+ // Is already there
+ logDebugMessage(__FUNCTION__, __LINE__, 'The table ' . $tableName . ' is already created.');
}
}
@@ -1837,12 +1906,30 @@ COMMENT ' . chr(39) . $comment . chr(39));
function addDropTableSql ($tableName) {
// Is the table there?
if (ifSqlTableExists($tableName)) {
- // Then add it, non-existing tables can be ignored because it will
- // happen with every newly installed extension.
+ /*
+ * Then add it, non-existing tables can be ignored because it will
+ * happen with every newly installed extension.
+ */
addExtensionSql('DROP TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '`');
// Mark it as gone
- $GLOBALS['ifSqlTableExists'][$tableName] = false;
+ $GLOBALS['ifSqlTableExists'][$tableName] = FALSE;
+ } // END - if
+}
+
+// Adds a RENAME TABLE stament if 'from' table exist and 'to' table not
+function addRenameTableSql ($fromTable, $toTable) {
+ // Make sure both are not the same
+ assert($fromTable != $toTable);
+
+ // Is renaming required?
+ if ((ifSqlTableExists($fromTable)) && (!ifSqlTableExists($toTable))) {
+ // Add it
+ addExtensionSql('RENAME TABLE `{?_MYSQL_PREFIX?}_' . $fromTable . '` TO `{?_MYSQL_PREFIX?}_' . $toTable . '`');
+
+ // Mark both tables
+ $GLOBALS['ifSqlTableExists'][$fromTable] = FALSE;
+ $GLOBALS['ifSqlTableExists'][$toTable] = TRUE;
} // END - if
}
@@ -1853,7 +1940,7 @@ function addAdminMenuSql ($action, $what, $title, $descr, $sort) {
// Is what null?
if (is_null($what)) {
// Add main menu
- $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES ('%s',NULL,'%s','%s',%s)",
+ $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`, `what`, `title`, `descr`, `sort`) VALUES ('%s',NULL,'%s','%s',%s)",
$action,
$title,
$descr,
@@ -1861,7 +1948,7 @@ function addAdminMenuSql ($action, $what, $title, $descr, $sort) {
);
} else {
// Add sub menu
- $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`,`what`,`title`,`descr`,`sort`) VALUES ('%s','%s','%s','%s',%s)",
+ $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_admin_menu` (`action`, `what`, `title`, `descr`, `sort`) VALUES ('%s','%s','%s','%s',%s)",
$action,
$what,
$title,
@@ -1885,14 +1972,14 @@ function addGuestMenuSql ($action, $what, $title, $sort) {
// Is what null?
if (is_null($what)) {
// Add main menu
- $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('%s',NULL,'%s','N','Y',%s)",
+ $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`, `what`, `title`, `visible`, `locked`, `sort`) VALUES ('%s',NULL,'%s','N','Y',%s)",
$action,
$title,
bigintval($sort)
);
} else {
// Add sub menu
- $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('%s','%s','%s','N','Y',%s)",
+ $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_guest_menu` (`action`, `what`, `title`, `visible`, `locked`, `sort`) VALUES ('%s','%s','%s','N','Y',%s)",
$action,
$what,
$title,
@@ -1915,14 +2002,14 @@ function addMemberMenuSql ($action, $what, $title, $sort) {
// Is what null?
if (is_null($what)) {
// Add main menu
- $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('%s',NULL,'%s','N','Y',%s)",
+ $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`, `what`, `title`, `visible`, `locked`, `sort`) VALUES ('%s',NULL,'%s','N','Y',%s)",
$action,
$title,
bigintval($sort)
);
} else {
// Add sub menu
- $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`,`what`,`title`,`visible`,`locked`,`sort`) VALUES ('%s','%s','%s','N','Y',%s)",
+ $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_member_menu` (`action`, `what`, `title`, `visible`, `locked`, `sort`) VALUES ('%s','%s','%s','N','Y',%s)",
$action,
$what,
$title,
@@ -1945,7 +2032,7 @@ function addSponsorMenuSql ($action, $what, $title, $active, $sort) {
// Is what null?
if (is_null($what)) {
// Add main menu
- $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`,`what`,`title`,`active`,`sort`) VALUES ('%s',NULL,'%s','%s',%s)",
+ $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`, `what`, `title`, `active`, `sort`) VALUES ('%s',NULL,'%s','%s',%s)",
$action,
$title,
$active,
@@ -1953,7 +2040,7 @@ function addSponsorMenuSql ($action, $what, $title, $active, $sort) {
);
} else {
// Add sub menu
- $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`,`what`,`title`,`active`,`sort`) VALUES ('%s','%s','%s','%s',%s)",
+ $sql = sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_sponsor_menu` (`action`, `what`, `title`, `active`, `sort`) VALUES ('%s','%s','%s','%s',%s)",
$action,
$what,
$title,
@@ -1970,40 +2057,244 @@ function addSponsorMenuSql ($action, $what, $title, $active, $sort) {
}
}
-// Add configuration entry if not found for actual extension
-function addConfigAddSql ($columnName, $columnSql) {
+// Add ALTER TABLE `foo` ADD sql if not found
+function addExtensionAddTableColumnSql ($tableName, $columnName, $columnSql) {
+ // Assert on all
+ assert((!empty($tableName)) && (!empty($columnName)) && (!empty($columnSql)));
+ assert($columnName != $columnSql);
+
// Is the column there?
- if (!isSqlTableColumnFound('{?_MYSQL_PREFIX?}_config', $columnName)) {
- // Not found, so add it
- addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` ADD `' . $columnName . '` ' . $columnSql);
+ if (!ifSqlTableColumnExists('{?_MYSQL_PREFIX?}_' . $tableName, $columnName, isInstaller())) {
+ // Debug message
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',columnName=' . $columnName . ',columnSql=' . $columnSql);
+
+ // Then add it
+ addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` ADD `' . $columnName . '` ' . $columnSql);
} elseif (isDebugModeEnabled()) {
// Add debug line
- logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' already created. columnSql=' . $columnSql);
+ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',columnName=' . $columnName . ',columnSql=' . $columnSql . ': does already exist.');
}
}
-// Drop configuration entry if found for actual extension
-function addConfigDropSql ($columnName) {
+// Add ALTER TABLE `foo` ADD INDEX sql if not found
+function addExtensionAddTableIndexSql ($tableName, $indexName, $columnSql) {
+ // Assert on all
+ assert((!empty($tableName)) && (!empty($indexName)) && (!empty($columnSql)));
+ assert($indexName != $columnSql);
+
+ // Is the column there?
+ if (!ifSqlTableIndexExist('{?_MYSQL_PREFIX?}_' . $tableName, $indexName, isInstaller())) {
+ // Debug message
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',indexName=' . $indexName . ',columnSql=' . $columnSql);
+
+ // Then add it
+ addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` ADD INDEX `' . $indexName . '` ' . $columnSql);
+ } elseif (isDebugModeEnabled()) {
+ // Add debug line
+ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',indexName=' . $indexName . ',columnSql=' . $columnSql . ': does already exist.');
+ }
+}
+
+// Add ALTER TABLE `foo` ADD UNIQUE INDEX sql if not found
+function addExtensionAddTableUniqueSql ($tableName, $indexName, $columnSql) {
+ // Assert on all
+ assert((!empty($tableName)) && (!empty($indexName)) && (!empty($columnSql)));
+ assert($indexName != $columnSql);
+
// Is the column there?
- if (isSqlTableColumnFound('{?_MYSQL_PREFIX?}_config', $columnName)) {
- // Found, so add it
- addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` DROP `' . $columnName . '`');
+ if (!ifSqlTableIndexExist('{?_MYSQL_PREFIX?}_' . $tableName, $indexName, isInstaller())) {
+ // Debug message
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',indexName=' . $indexName . ',columnSql=' . $columnSql);
+
+ // Then add it
+ addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` ADD UNIQUE INDEX `' . $indexName . '` ' . $columnSql);
} elseif (isDebugModeEnabled()) {
- // Add debug line, reportBug() would cause some extenion updates fail
- logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' not found.');
+ // Add debug line
+ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',indexName=' . $indexName . ',columnSql=' . $columnSql . ': does already exist.');
}
}
+// Add ALTER TABLE `foo` ADD FULLTEXT sql if not found
+function addExtensionAddTableFulltextSql ($tableName, $indexName, $columnSql) {
+ // Assert on all
+ assert((!empty($tableName)) && (!empty($indexName)) && (!empty($columnSql)));
+ assert($indexName != $columnSql);
+
+ // Is the column there and MyISAM engine? (InnoDB doesn't support FULLTEXT)
+ if ((getTableType() == 'MyISAM') && (!ifSqlTableIndexExist('{?_MYSQL_PREFIX?}_' . $tableName, $indexName, isInstaller()))) {
+ // Debug message
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',indexName=' . $indexName . ',columnSql=' . $columnSql);
+
+ // Then add it
+ addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` ADD FULLTEXT `' . $indexName . '` ' . $columnSql);
+ } elseif (isDebugModeEnabled()) {
+ // Add debug line
+ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',indexName=' . $indexName . ',columnSql=' . $columnSql . ': does already exist.');
+ }
+}
+
+// Add ALTER TABLE `foo` CHANGE sql if not found
+function addExtensionChangeTableColumnSql ($tableName, $fromColumnName, $toColumnName, $columnSql) {
+ // Assert on all
+ assert((!empty($tableName)) && (!empty($fromColumnName)) && (!empty($toColumnName)) && (!empty($columnSql)));
+ assert(($fromColumnName != $columnSql) && ($toColumnName != $columnSql));
+
+ // Is the column there?
+ if ((ifSqlTableColumnExists('{?_MYSQL_PREFIX?}_' . $tableName, $fromColumnName)) && (($fromColumnName == $toColumnName) || (!ifSqlTableColumnExists('{?_MYSQL_PREFIX?}_' . $tableName, $toColumnName, isInstaller())))) {
+ // Debug message
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',fromColumnName=' . $fromColumnName . ',toColumnName=' . $toColumnName . ',columnSql=' . $columnSql);
+
+ // Then add it
+ addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` CHANGE `' . $fromColumnName . '` `' . $toColumnName . '` ' . $columnSql);
+ } elseif (isDebugModeEnabled()) {
+ // Add debug line
+ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',fromColumnName=' . $fromColumnName . ',toColumnName=' . $toColumnName . ',columnSql=' . $columnSql . ': Cannot be changed.');
+ }
+}
+
+// Add ALTER TABLE `foo` DROP sql if not found
+function addExtensionDropTableColumnSql ($tableName, $columnName) {
+ // Assert on all
+ assert((!empty($tableName)) && (!empty($columnName)));
+
+ // Is the column there?
+ if (ifSqlTableColumnExists('{?_MYSQL_PREFIX?}_' . $tableName, $columnName, isInstaller())) {
+ // Debug message
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',columnName=' . $columnName);
+
+ // Then add it
+ addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` DROP `' . $columnName . '`');
+ } elseif (isDebugModeEnabled()) {
+ // Add debug line
+ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',columnName=' . $columnName . ': does not exist.');
+ }
+}
+
+// Add ALTER TABLE `foo` DROP INDEX sql if not found
+function addExtensionDropTableIndexSql ($tableName, $indexName) {
+ // Assert on all
+ assert((!empty($tableName)) && (!empty($indexName)));
+
+ // Is the column there?
+ if (ifSqlTableColumnExists('{?_MYSQL_PREFIX?}_' . $tableName, $indexName, isInstaller())) {
+ // Debug message
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',indexName=' . $indexName);
+
+ // Then add it
+ addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` DROP INDEX `' . $indexName . '`');
+ } elseif (isDebugModeEnabled()) {
+ // Add debug line
+ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',indexName=' . $indexName . ': does not exist.');
+ }
+}
+
+// Add configuration entry if not found for actual extension
+function addConfigAddSql ($columnName, $columnSql) {
+ // Call inner function
+ addExtensionAddTableColumnSql('config', $columnName, $columnSql);
+}
+
+// Drop configuration entry if found for actual extension
+function addConfigDropSql ($columnName) {
+ // Call inner function
+ addExtensionDropTableColumnSql('config', $columnName);
+}
+
// Change configuration entry for actual extension
function addConfigChangeSql ($oldColumnName, $newColumnName, $columnSql) {
// Add the SQL statement
- addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` CHANGE `' . $oldColumnName . '` `' . $newColumnName . '` ' . $columnSql);
+ addExtensionChangeTableColumnSql('config', $oldColumnName, $newColumnName, $columnSql);
+}
+
+/**
+ * Checks if given subject is found and if not, adds an SQL query to the
+ * extension registration queue.
+ */
+function registerExtensionPointsData ($subject, $columnName, $lockedMode, $paymentMethod) {
+ // Assert on all
+ assert((!empty($subject)) && (!empty($columnName)) && (!empty($lockedMode)) && (!empty($paymentMethod)));
+ assert((in_array($lockedMode, array('LOCKED', 'UNLOCKED'))) && (in_array($paymentMethod, array('DIRECT', 'REFERRAL'))));
+
+ // Is the suffix '_ref' not set?
+ if (!ifSubjectHasReferralSuffix($subject)) {
+ // Register this first
+ registerExtensionPointsData($subject . '_ref', $columnName, $lockedMode, $paymentMethod);
+ } // END - if
+
+ // Default is old extension version
+ $add = '';
+
+ // Is the extension equal or newer 0.8.9?
+ if (((isInstaller()) && ((getExtensionMode() == 'setup') || (getExtensionMode() == 'update'))) || (isExtensionInstalledAndNewer('sql_patches', '0.8.9'))) {
+ // Then add provider
+ $add = " AND `account_provider`='EXTENSION'";
+ } // END - if
+
+ // Is the 'subject' there?
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ifSqlTableExists(points_data)=' . ifSqlTableExists('points_data') . ',getExtensionMode()=' . getExtensionMode() . ',add=' . $add);
+ if (((!ifSqlTableExists('points_data')) && ((getExtensionMode() == 'setup') || (getExtensionMode() == 'update'))) || (countSumTotalData($subject, 'points_data', 'id', 'subject', TRUE, $add) == 0)) {
+ // Not found so:
+ if ((!isInstaller()) && (isset($GLOBALS['previous_extension'][getCurrentExtensionName()])) && (!ifSqlTableExists('points_data'))) {
+ // This may happen (but when?)
+ // @TODO Is this really neccessary?
+ $dummy = $GLOBALS['previous_extension'][getCurrentExtensionName()];
+ reportBug(__FUNCTION__, __LINE__, 'dummy[' . gettype($dummy) . ']=' . $dummy . ',getCurrentExtensionName()=' . getCurrentExtensionName() . ' - Under development, please report this!');
+ } // END - if
+
+ // With or without account_provider?
+ if (((isInstaller()) && ((getExtensionMode() == 'setup') || (getExtensionMode() == 'update'))) || (isExtensionInstalledAndNewer('sql_patches', '0.8.9'))) {
+ // Add account_provider
+ addExtensionSql(sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_points_data` (`subject`, `column_name`, `locked_mode`, `payment_method`, `account_provider`) VALUES ('%s','%s','%s','%s','EXTENSION')",
+ $subject,
+ $columnName,
+ $lockedMode,
+ $paymentMethod
+ ));
+ } else {
+ // ... add an SQL query
+ addExtensionSql(sprintf("INSERT INTO `{?_MYSQL_PREFIX?}_points_data` (`subject`, `column_name`, `locked_mode`, `payment_method`) VALUES ('%s','%s','%s','%s')",
+ $subject,
+ $columnName,
+ $lockedMode,
+ $paymentMethod
+ ));
+ }
+ } // END - if
+}
+
+/**
+ * Checks if given subject is found and if so, adds an SQL query to the
+ * extension unregistration queue.
+ */
+function unregisterExtensionPointsData ($subject) {
+ // Is the suffix '_ref' not set?
+ if (!ifSubjectHasReferralSuffix($subject)) {
+ // Unregister this first
+ unregisterExtensionPointsData($subject . '_ref');
+ } // END - if
+
+ // Default is old extension version
+ $add = '';
+
+ // Is the extension equal or newer 0.8.9?
+ if (isExtensionInstalledAndNewer('sql_patches', '0.8.9')) {
+ // Then add provider
+ $add = " AND `account_provider`='EXTENSION'";
+ } // END - if
+
+ // Is the 'subject' there?
+ if (countSumTotalData($subject, 'points_data', 'id', 'subject', TRUE, $add) == 1) {
+ // Found one or more, so add an SQL query
+ addExtensionSql(sprintf("DELETE LOW_PRIORITY FROM `{?_MYSQL_PREFIX?}_points_data` WHERE `subject`='%s'" . $add . " LIMIT 1",
+ $subject
+ ));
+ } // END - if
}
// Enables/disables productive mode for current extension (used only while
// registration).
// @TODO This should be rewrittten to allow, more development states, e.g. 'planing','alpha','beta','beta2','stable'
-function enableExtensionProductive ($isProductive = true) {
+function enableExtensionProductive ($isProductive = TRUE) {
// Log debug message
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',isProductive=', intval($isProductive));
@@ -2021,7 +2312,7 @@ function isExtensionProductive ($ext_name = '') {
} // END - if
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ' - ENTERED!');
- // Do we have cache?
+ // Is there cache?
if (!isset($GLOBALS[__FUNCTION__][$ext_name])) {
// Load extension only if not yet loaded
if (!isset($GLOBALS['ext_productive'][$ext_name])) {
@@ -2030,7 +2321,7 @@ function isExtensionProductive ($ext_name = '') {
} // END - if
// Determine it
- $GLOBALS[__FUNCTION__][$ext_name] = ((isset($GLOBALS['ext_productive'][$ext_name])) && ($GLOBALS['ext_productive'][$ext_name] === true));
+ $GLOBALS[__FUNCTION__][$ext_name] = ((isset($GLOBALS['ext_productive'][$ext_name])) && ($GLOBALS['ext_productive'][$ext_name] === TRUE));
} // END - if
// Return result
@@ -2048,13 +2339,13 @@ function markExtensionAsLoaded ($ext_name) {
// Mark it
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_loaded=true');
- $GLOBALS['ext_loaded']['ext_name'][$ext_name] = true;
+ $GLOBALS['ext_loaded']['ext_name'][$ext_name] = TRUE;
}
// Determine whether the given extension is already loaded
function isExtensionLoaded ($ext_name) {
// Is it there?
- return ((isset($GLOBALS['ext_loaded']['ext_name'][$ext_name])) && ($GLOBALS['ext_loaded']['ext_name'][$ext_name] === true));
+ return ((isset($GLOBALS['ext_loaded']['ext_name'][$ext_name])) && ($GLOBALS['ext_loaded']['ext_name'][$ext_name] === TRUE));
}
// Mark extension's library file as loaded
@@ -2066,13 +2357,45 @@ function markExtensionLibraryAsLoaded ($ext_name) {
} // END - if
// Mark it
- $GLOBALS['ext_loaded']['library'][$ext_name] = true;
+ $GLOBALS['ext_loaded']['library'][$ext_name] = TRUE;
}
// Determine whether the given extension's library is already loaded
function isExtensionLibraryLoaded ($ext_name) {
// Is it there?
- return ((isset($GLOBALS['ext_loaded']['library'][$ext_name])) && ($GLOBALS['ext_loaded']['library'][$ext_name] === true));
+ return ((isset($GLOBALS['ext_loaded']['library'][$ext_name])) && ($GLOBALS['ext_loaded']['library'][$ext_name] === TRUE));
+}
+
+// Copies the given extension's data to cache_array (USE THIS ONLY IN REGISTRATION PHASE!)
+function copyExtensionDataToCacheArray ($ext_name, $ext_id) {
+ // Copy all data
+ $GLOBALS['cache_array']['extension']['ext_id'][$ext_name] = $ext_id;
+ $GLOBALS['cache_array']['extension']['ext_name'][$ext_id] = $ext_name;
+ $GLOBALS['cache_array']['extension']['ext_version'][$ext_name] = getCurrentExtensionVersion();
+ $GLOBALS['cache_array']['extension']['ext_active'][$ext_name] = getThisExtensionAlwaysActive();
+ $GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] = convertBooleanToYesNo(isExtensionLanguageFileReadable($ext_name));
+ $GLOBALS['cache_array']['extension']['ext_func'][$ext_name] = convertBooleanToYesNo(isExtensionFunctionFileReadable($ext_name));
+ $GLOBALS['cache_array']['extension']['ext_menu'][$ext_name] = convertBooleanToYesNo(ifModuleHasMenu($ext_name, isInstaller()));
+ $GLOBALS['cache_array']['extension']['ext_css'][$ext_name] = convertBooleanToYesNo(getExtensionHasCss());
+ $GLOBALS['cache_array']['extension']['ext_deprecated'][$ext_name] = 'N';
+}
+
+// "Getter" for "checked="checked" from given session data
+function getExtensionSelectedFromSession ($ext_name, $sessionName, $separator = ':') {
+ // Get the data and explode it
+ $selections = explode($separator, getSession($sessionName));
+
+ // Default is not checked
+ $checked = '';
+
+ // Is it there?
+ if (in_array($ext_name, $selections)) {
+ // It is, so mark it
+ $checked = ' checked="checked"';
+ } // END - if
+
+ // Return result
+ return $checked;
}
// [EOF]