X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fextensions-functions.php;h=9aca9cf4141a34308c0e1864be12ac31ec312c21;hp=bc17810735ad1127475e3d6e9b247528b8c3c593;hb=500f1a8d2913512f1f5621c2a0320ad81f5133a1;hpb=c8d76610eb94093d4eed4fcd8a6cb72e74c8f6d8

diff --git a/inc/extensions-functions.php b/inc/extensions-functions.php
index bc17810735..9aca9cf414 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, 2010 by Mailer Developer Team                    *
+ * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -98,7 +98,7 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0', $dry_run = false
 
 	// Is the extension already loaded?
 	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Loading extension ' . $ext_name . ', mode=' . getExtensionMode() . ', ver=' . getCurrentExtensionVersion());
-	if ((isset($GLOBALS['ext_loaded']['ext'][$ext_name])) && (getExtensionMode() == 'init')) {
+	if ((isExtensionLoaded($ext_name)) && (getExtensionMode() == 'init')) {
 		// Debug message
 		logDebugMessage(__FUNCTION__, __LINE__, sprintf("Extension %s already loaded.", $ext_name));
 
@@ -124,12 +124,12 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0', $dry_run = false
 	// Do we have 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]))) && (!isset($GLOBALS['ext_loaded']['funcs'][$ext_name]))) {
+		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);
 
 			// Mark it as loaded
-			$GLOBALS['ext_loaded']['funcs'][$ext_name] = true;
+			markExtensionLibraryAsLoaded($ext_name);
 
 			// Download functions file
 			loadIncludeOnce($funcsInclude);
@@ -142,6 +142,9 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0', $dry_run = false
 		));
 	}
 
+	// Load extension's filter library if present
+	loadExtensionFilters($ext_name);
+
 	// Extensions are not deprecated by default
 	setExtensionDeprecated('N');
 
@@ -167,7 +170,7 @@ function loadExtension ($ext_name, $ext_mode, $ext_ver = '0.0', $dry_run = false
 	// Mark it as loaded in normal mode
 	if (getExtensionMode() == '') {
 		// Mark it now...
-		$GLOBALS['ext_loaded']['ext'][$ext_name] = true;
+		markExtensionAsLoaded($ext_name);
 	} // END - if
 
 	// All fine!
@@ -341,8 +344,8 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $logout = true
 		if ($test === true) {
 			// "Dry-run-mode" activated?
 			if ((isExtensionDryRun() === false) && (!isExtensionOnRemovalList())) {
-				//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName());
 				// Init SQLs and transfer ext->generic
+				//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName());
 				initSqls();
 				setSqlsArray(getExtensionSqls());
 
@@ -352,22 +355,22 @@ function registerExtension ($ext_name, $taskId, $dry_run = false, $logout = true
 				// Register extension
 				//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'insert=' . getCurrentExtensionName() . '/' . getCurrentExtensionVersion() . ' - INSERT!');
 				if (isExtensionInstalledAndNewer('sql_patches', '0.0.6')) {
-					//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion() . 'ext_css=' . getExtensionHasCss());
 					// 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')",
 						array(
 							getCurrentExtensionName(),
-							getExtensionAlwaysActive(),
+							getThisExtensionAlwaysActive(),
 							getCurrentExtensionVersion(),
 							getExtensionHasCss()
 						), __FUNCTION__, __LINE__);
 				} else {
-					//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . getCurrentExtensionName() . ',always_active=' . getExtensionAlwaysActive() . ', ext_ver=' . getCurrentExtensionVersion());
 					// 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')",
 						array(
 							getCurrentExtensionName(),
-							getExtensionAlwaysActive(),
+							getThisExtensionAlwaysActive(),
 							getCurrentExtensionVersion()
 						), __FUNCTION__, __LINE__);
 				}
@@ -475,7 +478,7 @@ function doExtensionSqls ($ext_id, $load_mode) {
 	runFilterChain('extension_' . $load_mode);
 
 	// Remove cache file(s) if extension is active
-	if (((isExtensionActive('cache')) && ((SQL_AFFECTEDROWS() == 1)) || ($sqlRan === true) || ($load_mode == 'activate') || ($load_mode == 'deactivate'))) {
+	if (((isExtensionActive('cache')) && ((!SQL_HASZEROAFFECTED())) || ($sqlRan === true) || ($load_mode == 'activate') || ($load_mode == 'deactivate'))) {
 		// Run filters
 		runFilterChain('post_extension_run_sql', getCurrentExtensionName());
 	} // END - if
@@ -560,7 +563,7 @@ function isExtensionActive ($ext_name) {
 
 		// Count cache hits
 		incrementStatsEntry('cache_hits');
-	} elseif (isset($GLOBALS['ext_loaded'][$ext_name])) {
+	} elseif (isExtensionLoaded($ext_name)) {
 		// @TODO Extension is loaded, what next?
 		debug_report_bug(__FUNCTION__, __LINE__, 'LOADED:' . $ext_name);
 	} elseif (($ext_name == 'cache') || (!isExtensionInstalled('cache'))) {
@@ -653,7 +656,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) {
 	// Only admins are allowed to update extensions
-	if ((!isAdmin()) || (empty($ext_name))) return false;
+	if ((!isAdmin()) || (empty($ext_name))) {
+		return false;
+	} // END - if
 
 	// Set current SQL name
 	setCurrentExtensionName($ext_name);
@@ -673,7 +678,7 @@ function updateExtension ($ext_name, $ext_ver, $dry_run = false) {
 	initExtensionSqls();
 
 	// Check if version is updated
-	//* DEBUG: */ debugOutput(getCurrentExtensionName().'/'.$ext_name.':'.getThisExtensionVersion().'/'.$ext_ver.'/'.intval(is_array($history)));
+	//* DEBUG: */ debugOutput(getCurrentExtensionName() . '/' . $ext_name . ':' . getThisExtensionVersion() . '/' . $ext_ver . '/' . intval(is_array($history)));
 	if (((getThisExtensionVersion() != $ext_ver) || (isExtensionDryRun())) && (is_array($history))) {
 		// Search for starting point
 		$start = array_search($ext_ver, $history);
@@ -798,7 +803,7 @@ function addExtensionVerboseSqlTable ($title = '', $dashed = '', $switch = false
 			$OUT = loadTemplate('admin_extension_sql_table', true, $content);
 		} else {
 			// No addional SQL commands to run
-			$OUT = loadTemplate('admin_settings_saved', true, '{--ADMIN_NO_ADDITIONAL_SQLS--}');
+			$OUT = displayMessage('{--ADMIN_NO_ADDITIONAL_SQLS--}', true);
 		}
 	} // END - if
 
@@ -1006,16 +1011,16 @@ function createNewExtensionTask ($ext_name) {
 		$message = getMaskedMessage('ADMIN_EXTENSION_TEXT_FILE_MISSING', $ext_name);
 
 		// Template file
-		$tpl = sprintf("%stemplates/%s/html/ext/ext_%s.tpl",
+		$FQFN = sprintf("%stemplates/%s/html/ext/ext_%s.tpl",
 			getPath(),
 			getLanguage(),
 			$ext_name
 		);
 
 		// Load text for task if found
-		if (isFileReadable($tpl)) {
-			// Load extension's own text template (HTML!)
-			$message = loadTemplate('ext_' . $ext_name, true);
+		if (isFileReadable($FQFN)) {
+			// Load extension's description template (but do not compile the code)
+			$message = loadTemplate('ext_' . $ext_name, true, array(), false);
 		} else {
 			// Write this in debug.log as well
 			logDebugMessage(__FUNCTION__, __LINE__, $message);
@@ -1116,7 +1121,7 @@ function addExtensionNotes ($ext_ver) {
 				'notes' => '{--INITIAL_RELEASE--}'
 			);
 		} else {
-			// No update notes found!
+			// No update notes found
 			$content = array(
 				'ver'   => $ext_ver,
 				'notes' => '{--NO_UPDATE_NOTES--}'
@@ -1170,13 +1175,13 @@ function setExtensionAlwaysActive ($active) {
 }
 
 // Getter for EXT_ALWAYS_ACTIVE flag
-function getExtensionAlwaysActive () {
+function getThisExtensionAlwaysActive () {
 	return $GLOBALS['ext_always_active'][getCurrentExtensionName()];
 }
 
 // Checks wether the current extension is always active
-function isExtensionAlwaysActive () {
-	return (getExtensionAlwaysActive() == 'Y');
+function isThisExtensionAlwaysActive () {
+	return (getThisExtensionAlwaysActive() == 'Y');
 }
 
 // Setter for EXT_VERSION flag
@@ -1200,8 +1205,8 @@ function isExtensionDeprecated () {
 }
 
 // Setter for EXT_UPDATE_DEPENDS flag
-function addExtensionUpdateDependency ($updateDepends) {
-	//* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ' - ENTERED!');
+function addExtensionDependency ($updateDepends) {
+	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ' - ENTERED!');
 	// Is the update depency empty? (NEED TO BE FIXED!)
 	if (empty($updateDepends)) {
 		// Please report this bug!
@@ -1221,7 +1226,7 @@ function addExtensionUpdateDependency ($updateDepends) {
 
 	// Remember it in the list of running updates
 	$GLOBALS['ext_running_updates'][getCurrentExtensionName()][] = $updateDepends;
-	//* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ' - EXIT!');
+	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'currName=' . getCurrentExtensionName() . '/' . $updateDepends . ' - EXIT!');
 }
 
 // Getter for running updates
@@ -1288,7 +1293,7 @@ function isExtensionUpdateRunning ($ext_name) {
 		foreach ($GLOBALS['ext_running_updates'] as $ext1=>$depends) {
 			// Is it found?
 			if (($ext1 == $ext_name) || ($isRunning === true)) {
-				// Found!
+				// found
 				logDebugMessage(__FUNCTION__, __LINE__, 'ext1=' . $ext1 . ',ext_name=' . $ext_name . ',isRunning=' . intval($isRunning));
 				$isRunning = true;
 				break;
@@ -1336,7 +1341,7 @@ function countExtensionUpdateDependencies () {
 }
 
 // Removes given extension from update denpency list
-function removeExtensionUpdateDependency ($ext_name) {
+function removeExtensionDependency ($ext_name) {
 	// Look it up
 	$key = array_search($ext_name, getExtensionUpdateDependencies());
 
@@ -1546,19 +1551,19 @@ function redirectOnUninstalledExtension ($ext_name) {
 // Filter for initialization of all extensions by loading them in 'init' mode
 function FILTER_INIT_EXTENSIONS () {
 	// Do we have some entries?
-	//* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY!');
+	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ENTRY!');
 	if (isset($GLOBALS['cache_array']['extension']['ext_name'])) {
 		// Load all found extensions if found
-		//* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - START!');
+		//* 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!');
+		//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'CACHE - END!');
 	} // END - if
-	//* DEBUG */ logDebugMessage(__FUNCTION__, __LINE__, 'EXIT!');
+	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'EXIT!');
 }
 
 // Setter for extension mode
@@ -1651,14 +1656,8 @@ function getExtensionHasCss () {
 
 // Checks wether the given extension has a language file
 function ifExtensionHasLanguageFile ($ext_name) {
-	// Default is no language file
-	$hasLanguage = false;
-
 	// Do we have cache?
 	if (isset($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name])) {
-		// Then use it
-		$hasLanguage = ($GLOBALS['cache_array']['extension']['ext_lang'][$ext_name] == 'Y');
-
 		// Count cache hits
 		incrementStatsEntry('cache_hits');
 	} else {
@@ -1726,7 +1725,7 @@ function isExtensionFunctionFileReadable ($ext_name) {
 		$funcsInclude = sprintf("inc/libs/%s_functions.php", $ext_name);
 
 		// Is this include there?
-		if ((isFileReadable($funcsInclude)) && (!isset($GLOBALS['ext_loaded']['funcs'][$ext_name])) && (getExtensionMode() == 'test')) {
+		if ((isFileReadable($funcsInclude)) && (!isExtensionLibraryLoaded($ext_name)) && (getExtensionMode() == 'test')) {
 			// Cache it!
 			//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ext_name=' . $ext_name . ',ext_func=Y - FOUND!');
 			$GLOBALS['cache_array']['extension']['ext_func'][$ext_name] = 'Y';
@@ -1742,6 +1741,31 @@ function isExtensionFunctionFileReadable ($ext_name) {
 	return ($GLOBALS['cache_array']['extension']['ext_func'][$ext_name] == 'Y');
 }
 
+// Adds a CREATE TABLE statement if the requested table is not there
+function addCreateTableSql ($tableName, $sql) {
+	// Is the table not there?
+	if (!isSqlTableCreated($tableName)) {
+		// Is not found, so add it
+		addExtensionSql('CREATE TABLE `{?_MYSQL_PREFIX?}_' . $tableName . '` ' . $sql);
+	} else {
+		// Is already there, which should not happen
+		debug_report_bug(__FUNCTION__, __LINE__, 'The table ' . $tableName . ' is already created which should not happen.');
+	}
+}
+
+// Adds a DROP TABLE statement if the requested tabled is there
+function addDropTableSql ($tableName) {
+	// Is the table there?
+	if (isSqlTableCreated($tableName)) {
+		// 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['isSqlTableCreated'][$tableName] = false;
+	} // END - if
+}
+
 // Adds an admin menu to the SQL queue of the menu entry is not found
 function addAdminMenuSql ($action, $what, $title, $descr, $sort) {
 	// Now check if this menu is there
@@ -1804,7 +1828,7 @@ function addGuestMenuSql ($action, $what, $title, $visible, $locked, $sort) {
 		addExtensionSql($sql);
 	} elseif (isDebugModeEnabled()) {
 		// Double menus should be located and fixed!
-		logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double guest menu action=%s,what=%s,title=%s,active=%s detected.", $action, $what, $title, $active));
+		logDebugMessage(__FUNCTION__, __LINE__, sprintf("Double guest menu action=%s,what=%s,title=%s,locked=%s,visible=%s detected.", $action, $what, $title, $locked, $visible));
 	}
 }
 
@@ -1874,8 +1898,39 @@ function addSponsorMenuSql ($action, $what, $title, $active, $sort) {
 	}
 }
 
+// Add configuration entry if not found for actual extension
+function addConfigAddSql ($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);
+	} else {
+		// Add debug line
+		logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' already created. columnSql=' . $columnSql);
+	}
+}
+
+// Drop configuration entry if found for actual extension
+function addConfigDropSql ($columnName) {
+	// Is the column there?
+	if (isSqlTableColumnFound('{?_MYSQL_PREFIX?}_config', $columnName)) {
+		// Found, so add it
+		addExtensionSql('ALTER TABLE `{?_MYSQL_PREFIX?}_config` DROP `' . $columnName . '`');
+	} else {
+		// Add debug line, debug_report_bug() would cause some extenion updates fail
+		logDebugMessage(__FUNCTION__, __LINE__, 'Configuration entry ' . $columnName . ' not found.');
+	}
+}
+
+// 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);
+}
+
 // 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) {
 	// Log debug message
 	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("ext_name=%s,isProductive=%d", getCurrentExtensionName(), intval($isProductive)));
@@ -1912,5 +1967,41 @@ function isExtensionProductive ($ext_name = '') {
 	return $GLOBALS[__FUNCTION__][$ext_name];
 }
 
+// Mark extension file as loaded
+function markExtensionAsLoaded ($ext_name) {
+	// Is it already loaded?
+	if (isExtensionLoaded($ext_name)) {
+		// Then abort here
+		debug_report_bug(__FUNCTION__, __LINE__, 'Extension ' . $ext_name . ' is already marked as loaded!');
+	} // END - if
+
+	// Mark it
+	$GLOBALS['ext_loaded']['ext_name'][$ext_name] = true;
+}
+
+// Determine wether 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));
+}
+
+// Mark extension's library file as loaded
+function markExtensionLibraryAsLoaded ($ext_name) {
+	// Is it already loaded?
+	if (isExtensionLibraryLoaded($ext_name)) {
+		// Then abort here
+		debug_report_bug(__FUNCTION__, __LINE__, 'Extension library ' . $ext_name . ' is already marked as loaded!');
+	} // END - if
+
+	// Mark it
+	$GLOBALS['ext_loaded']['library'][$ext_name] = true;
+}
+
+// Determine wether 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));
+}
+
 // [EOF]
 ?>