X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fmodule-functions.php;h=8af427efc37fd9f660ecba039b53932c03192842;hp=1d96f5e0f827e676a609b564e4afb0df99cee9b7;hb=fc9a6d12d5143014c74aa0e9ed0810b93f20b118;hpb=433a86a6c27009ba3c48a17b5befcc671b45d9a5

diff --git a/inc/module-functions.php b/inc/module-functions.php
index 1d96f5e0f8..8af427efc3 100644
--- a/inc/module-functions.php
+++ b/inc/module-functions.php
@@ -6,9 +6,9 @@
  * -------------------------------------------------------------------- *
  * File              : module-functions.php                             *
  * -------------------------------------------------------------------- *
- * Short description : All MySQL-related functions                      *
+ * Short description : Module functions                                 *
  * -------------------------------------------------------------------- *
- * Kurzbeschreibung  : Alle MySQL-Relevanten Funktionen                 *
+ * Kurzbeschreibung  : Modulfunktionen                                  *
  * -------------------------------------------------------------------- *
  * $Revision::                                                        $ *
  * $Date::                                                            $ *
@@ -16,8 +16,8 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
- * For more information visit: http://www.mxchange.org                  *
+ * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
+ * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
  * it under the terms of the GNU General Public License as published by *
@@ -61,7 +61,7 @@ function getModuleTitle ($module) {
 				array($module), __FUNCTION__, __LINE__);
 
 			// Is the entry there?
-			if (SQL_NUMROWS($result)) {
+			if (SQL_NUMROWS($result) == 1) {
 				// Get the title from database
 				$data = SQL_FETCHARRAY($result);
 			} // END - if
@@ -79,13 +79,13 @@ function getModuleTitle ($module) {
 		// Is it 'error'?
 		if ($module == 'error') {
 			// Error (real module was not found)
-			$data['title'] = getMessage('MODULE_ERROR_404');
+			$data['title'] = '{--MODULE_ERROR_404--}';
 		}  else {
 			// No name found
-			$data['title'] = getMaskedMessage('UNKNOWN_MODULE_DETECTED', $module);
+			$data['title'] = '{%message,UNKNOWN_MODULE_DETECTED_TITLE=' . $module . '%}';
 			if ((is_resource($result)) && (SQL_HASZERONUMS($result))) {
-				// Add module to database
-				$dummy = checkModulePermissions($module);
+				// Add module to database and ignore return value
+				checkModulePermissions($module);
 			} // END - if
 		}
 	} // END - if
@@ -139,16 +139,22 @@ function isModuleRegistered ($module) {
 	} elseif (!isExtensionActive('cache')) {
 		// Check for module in database
 		//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using database.');
-		$result = SQL_QUERY_ESC("SELECT `locked`, `hidden`, `admin_only`, `mem_only` FROM `{?_MYSQL_PREFIX?}_mod_reg` WHERE `module`='%s' LIMIT 1",
+		$result = SQL_QUERY_ESC("SELECT `locked`,`hidden`,`admin_only`,`mem_only` FROM `{?_MYSQL_PREFIX?}_mod_reg` WHERE `module`='%s' LIMIT 1",
 			array($module), __FUNCTION__, __LINE__);
 		if (SQL_NUMROWS($result) == 1) {
 			// Read data
-			//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Entry found.');
-			$GLOBALS['cache_array']['modules'][$module] = SQL_FETCHARRAY($result);
+			$data = SQL_FETCHARRAY($result);
+
+			// Set all entries
+			foreach ($data as $key => $value) {
+				$GLOBALS['cache_array']['modules'][$key][$module] = $value;
+			} // END - foreach
+
+			// Mark as found
 			$found = true;
 		} elseif (isDebugModeEnabled()) {
 			// Debug message only in debug-mode...
-			logDebugMessage(__FUNCTION__, __LINE__, 'Module ' . $module . ' not found!');
+			logDebugMessage(__FUNCTION__, __LINE__, 'Module ' . $module . ' not found.');
 		}
 
 		// Free result
@@ -159,10 +165,49 @@ function isModuleRegistered ($module) {
 	return $found;
 }
 
+// Checks wether the given module is locked by just checking the cache
+function isModuleLocked ($module) {
+	// Determine if there a cache entry and is it set
+	$return = ((isset($GLOBALS['cache_array']['modules']['locked'][$module])) && ($GLOBALS['cache_array']['modules']['locked'][$module] == 'Y'));
+
+	// Return determined value
+	return $return;
+}
+
+// Checks wether the given module is hidden by just checking the cache
+function isModuleHidden ($module) {
+	// Determine if there a cache entry and is it set
+	$return = ((isset($GLOBALS['cache_array']['modules']['hidden'][$module])) && ($GLOBALS['cache_array']['modules']['hidden'][$module] == 'Y'));
+
+	// Return determined value
+	return $return;
+}
+
+// Checks wether the given module is mem_only by just checking the cache
+function isModuleMemberOnly ($module) {
+	// Determine if there a cache entry and is it set
+	$return = ((isset($GLOBALS['cache_array']['modules']['mem_only'][$module])) && ($GLOBALS['cache_array']['modules']['mem_only'][$module] == 'Y'));
+
+	// Return determined value
+	return $return;
+}
+
+// Checks wether the given module is admin_only by just checking the cache
+function isModuleAdminOnly ($module) {
+	// Determine if there a cache entry and is it set
+	$return = ((isset($GLOBALS['cache_array']['modules']['admin_only'][$module])) && ($GLOBALS['cache_array']['modules']['admin_only'][$module] == 'Y'));
+
+	// Return determined value
+	return $return;
+}
+
 // Check validity of a given module name (no file extension)
 function checkModulePermissions ($module = '') {
 	// Is it empty (default), then take the current one
-	if (empty($module)) $module = getModule();
+	if (empty($module)) {
+		// Use current module
+		$module = getModule();
+	} // END - if
 
 	// Do we have cache?
 	if (isModuleStatusSet($module)) {
@@ -178,7 +223,7 @@ function checkModulePermissions ($module = '') {
 	$extension = ''; $module_chk = $module;
 	//* DEBUG: */ debugOutput(__LINE__.'*'.count($modSplit).'/'.$module.'*');
 	if (count($modSplit) == 2) {
-		// Okay, there is a seperator (_) in the name so is the first part a module?
+		// Okay, there is a separator (_) in the name so is the first part a module?
 		//* DEBUG: */ debugOutput(__LINE__.'*'.$modSplit[0].'*');
 		if (isExtensionActive($modSplit[0])) {
 			// The prefix is an extension's name, so let's set it
@@ -192,7 +237,6 @@ function checkModulePermissions ($module = '') {
 	// Check if script is installed if not return a 'done' to prevent some errors
 	if ((isInstallationPhase()) || (!isAdminRegistered())) {
 		// Not installed or no admin registered or in installation phase
-		// Set status
 		setModuleStatus($module_chk, 'done');
 
 		// Return status
@@ -207,49 +251,54 @@ function checkModulePermissions ($module = '') {
 		// Check returned values against current access permissions
 		//
 		// Admin access                                                              ----- Guest access -----                                                                                                                         --- Guest   or   member? ---
-		if ((isAdmin()) || (($GLOBALS['cache_array']['modules']['locked'][$module_chk] != 'Y') && ($GLOBALS['cache_array']['modules']['admin_only'][$module_chk] != 'Y') && (($GLOBALS['cache_array']['modules']['mem_only'][$module_chk] != 'Y') || (isMember())))) {
+		if ((isAdmin()) || ((!isModuleLocked($module_chk)) && (!isModuleAdminOnly($module_chk)) && ((!isModuleMemberOnly($module_chk)) || (isMember())))) {
 			// If you are admin you are welcome for everything!
 			setModuleStatus($module_chk, 'done');
-		} elseif ($GLOBALS['cache_array']['modules']['locked'][$module_chk] == 'Y') {
+		} elseif (isModuleLocked($module_chk)) {
 			// Module is locked
 			setModuleStatus($module_chk, 'locked');
-		} elseif (($GLOBALS['cache_array']['modules']['mem_only'][$module_chk] == 'Y') && (!isMember())) {
+		} elseif ((isModuleMemberOnly($module_chk)) && (!isMember())) {
 			// You have to login first!
 			setModuleStatus($module_chk, 'mem_only');
-		} elseif (($GLOBALS['cache_array']['modules']['admin_only'][$module_chk] == 'Y') && (!isAdmin())) {
+		} elseif ((isModuleAdminOnly($module_chk)) && (!isAdmin())) {
 			// Only the Admin is allowed to enter this module!
 			setModuleStatus($module_chk, 'admin_only');
 		} else {
 			// @TODO Nothing helped???
-			logDebugMessage(__FUNCTION__, __LINE__, sprintf("ret=%s,locked=%s,admin=%s,mem=%s",
+			logDebugMessage(__FUNCTION__, __LINE__, sprintf("ret=%s,locked=%d,hidden=%d,mem=%d,admin=%d",
 				getModuleStatus($module_chk),
-				$GLOBALS['cache_array']['modules']['locked'][$module_chk],
-				$GLOBALS['cache_array']['modules']['admin_only'][$module_chk],
-				$GLOBALS['cache_array']['modules']['mem_only'][$module_chk]
+				intval(isModuleLocked($module_chk)),
+				intval(isModuleHidden($module_chk)),
+				intval(isModuleMemberOnly($module_chk)),
+				intval(isModuleAdminOnly($module_chk))
 			));
 		}
 	} // END - if
 
 	// Still no luck or not found?
 	if (($found === false) && (!isExtensionActive('cache')) && (getModuleStatus($module_chk) != 'done'))  {
-		//              ----- Legacy module -----                                  ---- Module in base folder  ----                       --- Module with extension's name ---
+		//              ----- Default module -----                                  ---- Module in base folder  ----                       --- Module with extension's name ---
 		if ((isIncludeReadable(sprintf("inc/modules/%s.php", $module))) || (isIncludeReadable(sprintf("%s.php", $module))) || (isIncludeReadable(sprintf("%s/%s.php", $extension, $module)))) {
 			// Data is missing so we add it
 			if (isExtensionInstalledAndNewer('sql_patches', '0.3.6')) {
-				// Since 0.3.6 we have a has_menu column, this took me a half hour
-				// to find a loop here... *sigh*
+				/*
+				 * Since 0.3.6 we have a has_menu column, this took me a half
+				 * hour to find a loop here... *sigh*
+				 */
 				SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_mod_reg`
-(`module`, `locked`, `hidden`, `mem_only`, `admin_only`, `has_menu`) VALUES
+(`module`,`locked`,`hidden`,`mem_only`,`admin_only`,`has_menu`)
+VALUES
 ('%s','Y','N','N','N','N')", array($module_chk), __FUNCTION__, __LINE__);
 			} else {
 				// Wrong/missing sql_patches!
 				SQL_QUERY_ESC("INSERT INTO `{?_MYSQL_PREFIX?}_mod_reg`
-(`module`, `locked`, `hidden`, `mem_only`, `admin_only`) VALUES
+(`module`,`locked`,`hidden`,`mem_only`,`admin_only`)
+VALUES
 ('%s','Y','N','N','N')", array($module_chk), __FUNCTION__, __LINE__);
 			}
 
 			// Everthing is fine?
-			if (SQL_AFFECTEDROWS() < 1) {
+			if (SQL_HASZEROAFFECTED()) {
 				// Something bad happend!
 				setModuleStatus($module_chk, 'major');
 				return 'major';
@@ -257,7 +306,9 @@ function checkModulePermissions ($module = '') {
 
 			// Destroy cache here
 			// @TODO Rewrite this to a filter
-			if ((isHtmlOutputMode()) || (isRawOutputMode())) rebuildCache('modules', 'modules');
+			if ((isHtmlOutputMode()) || (isRawOutputMode())) {
+				rebuildCache('modules', 'modules');
+			} // END - if
 
 			// And reload data
 			unset($GLOBALS['module_status'][$module_chk]);
@@ -271,48 +322,48 @@ function checkModulePermissions ($module = '') {
 		rebuildCache('modules', 'modules');
 	} elseif ($found === false) {
 		// Problem with module detected
-		logDebugMessage(__FUNCTION__, __LINE__, sprintf("Problem in module %s detected. ret=%s, locked=%s, hidden=%s, mem=%s, admin=%s, output_mode=%s",
-			$module,
-			getModuleStatus($module),
-			$GLOBALS['cache_array']['modules']['locked'][$module_chk],
-			$GLOBALS['cache_array']['modules']['hidden'][$module_chk],
-			$GLOBALS['cache_array']['modules']['mem_only'][$module_chk],
-			$GLOBALS['cache_array']['modules']['admin_only'][$module_chk],
+		logDebugMessage(__FUNCTION__, __LINE__, sprintf("Problem in module %s detected. getModuleStatus()=%s,locked=%d,hidden=%d,mem=%d,admin=%d,output_mode=%s",
+			$module_chk,
+			getModuleStatus($module_chk),
+			intval(isModuleLocked($module_chk)),
+			intval(isModuleHidden($module_chk)),
+			intval(isModuleMemberOnly($module_chk)),
+			intval(isModuleAdminOnly($module_chk)),
 			getScriptOutputMode()
 		));
 	}
 
 	// Debug log
-	logDebugMessage(__FUNCTION__, __LINE__, sprintf("module=%s, statyus=%s", $module_chk, getModuleStatus($module_chk)));
+	//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("module=%s, status=%s", $module_chk, getModuleStatus($module_chk)));
 
 	// Return the value
 	return getModuleStatus($module_chk);
 }
 
 // Checks if the module has a menu
-function ifModuleHasMenu ($mod, $forceDb = false) {
+function ifModuleHasMenu ($module, $forceDb = false) {
 	// All is false by default
 	$ret = false;
 
 	// Extension installed and newer than or has version 0.1.2?
 	if (isExtensionInstalledAndNewer('cache', '0.1.2')) {
 		// Cache version is okay, so let's check the cache!
-		if (isset($GLOBALS['cache_array']['modules']['has_menu'][$mod])) {
+		if (isset($GLOBALS['cache_array']['modules']['has_menu'][$module])) {
 			// Check module cache and count hit
-			$ret = ($GLOBALS['cache_array']['modules']['has_menu'][$mod] == 'Y');
+			$ret = ($GLOBALS['cache_array']['modules']['has_menu'][$module] == 'Y');
 			incrementStatsEntry('cache_hits');
-		} elseif (isset($GLOBALS['cache_array']['extension']['ext_menu'][$mod])) {
+		} elseif (isset($GLOBALS['cache_array']['extension']['ext_menu'][$module])) {
 			// Check cache and count hit
-			$ret = ($GLOBALS['cache_array']['extension']['ext_menu'][$mod] == 'Y');
+			$ret = ($GLOBALS['cache_array']['extension']['ext_menu'][$module] == 'Y');
 			incrementStatsEntry('cache_hits');
 		} else {
 			// Admin/guest/member/sponsor modules have always a menu!
-			$ret = in_array($mod, array('admin', 'index', 'login', 'sponsor'));
+			$ret = in_array($module, array('admin', 'index', 'login', 'sponsor'));
 		}
 	} elseif ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && ((!isExtensionActive('cache')) || ($forceDb === true))) {
 		// Check database for entry
 		$result = SQL_QUERY_ESC("SELECT `has_menu` FROM `{?_MYSQL_PREFIX?}_mod_reg` WHERE `module`='%s' LIMIT 1",
-			array($mod), __FUNCTION__, __LINE__);
+			array($module), __FUNCTION__, __LINE__);
 
 		// Entry found?
 		if (SQL_NUMROWS($result) == 1) {
@@ -320,7 +371,7 @@ function ifModuleHasMenu ($mod, $forceDb = false) {
 			$data = SQL_FETCHARRAY($result);
 
 			// Fake cache... ;-)
-			$GLOBALS['cache_array']['extension']['ext_menu'][$mod] = $data['has_menu'];
+			$GLOBALS['cache_array']['extension']['ext_menu'][$module] = $data['has_menu'];
 
 			// Does it have a menu?
 			$ret = ($data['has_menu'] == 'Y');
@@ -330,7 +381,7 @@ function ifModuleHasMenu ($mod, $forceDb = false) {
 		SQL_FREERESULT($result);
 	} elseif (!isExtensionInstalled('sql_patches')) {
 		// No sql_patches installed, so maybe in admin/guest/member/sponsor area or no admin registered?
-		$ret = in_array($mod, array('admin', 'index', 'login', 'sponsor')); // Then there is a menu!
+		$ret = in_array($module, array('admin', 'index', 'login', 'sponsor')); // Then there is a menu!
 	} else {
 		// Unsupported state!
 		logDebugMessage(__FUNCTION__, __LINE__, 'This should never be reached.');
@@ -345,7 +396,7 @@ function addModuleSql ($module, $locked, $hidden, $adminOnly, $memOnly) {
 	// Is the module already registered?
 	if (!isModuleRegistered($module)) {
 		// Add it
-		addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_mod_reg` (`module`,`locked`,`hidden`,`admin_only`,`mem_only`) VALUES('" . $module . "','" . $locked . "','" . $hidden . "','" . $adminOnly . "','" . $memOnly . "')");
+		addExtensionSql("INSERT INTO `{?_MYSQL_PREFIX?}_mod_reg` (`module`,`locked`,`hidden`,`admin_only`,`mem_only`) VALUES ('" . $module . "','" . $locked . "','" . $hidden . "','" . $adminOnly . "','" . $memOnly . "')");
 	} else {
 		// Already registered
 		logDebugMessage(__FUNCTION__, __LINE__, sprintf("Already registered: module=%s,locked=%s,hidden=%s,admin=%s,mem=%s",
@@ -358,5 +409,111 @@ function addModuleSql ($module, $locked, $hidden, $adminOnly, $memOnly) {
 	}
 }
 
+// Load the currently set module
+function loadModule () {
+	// By default all modules are invalid
+	$isModuleValid = false;
+
+	// Init module state as 'failed' (always failed first)
+	$moduleState = 'failed';
+
+	// Construct module name
+	$GLOBALS['module_inc'] =  sprintf("inc/modules/%s.php", getModule());
+
+	// Check module permission (again)
+	$moduleState = checkModulePermissions();
+
+	// Which permission/error state do we have?
+	switch ($moduleState) {
+		case 'cache_miss': // The cache is gone
+		case 'admin_only': // Admin-only access
+		case 'mem_only': // Member-only access
+		case 'done': // All fine!
+			// Does the module exists on local file system?
+			if ((isIncludeReadable($GLOBALS['module_inc'])) && (!ifFatalErrorsDetected())) {
+				// Module is valid, active and located on the local disk...
+				$isModuleValid = true;
+			} elseif (!ifFatalErrorsDetected()) {
+				// Set HTTP status
+				setHttpStatus('404');
+
+				// Module not found
+				addFatalMessage(__FUNCTION__, __LINE__, '{--MODULE_REGISTRY_404--}');
+
+				// Set module to error module (non-existent!)
+				setModule('error');
+			}
+			break;
+
+		case '404':
+			// Set HTTP status
+			setHttpStatus('404');
+
+			// Add fatal message
+			addFatalMessage(__FUNCTION__, __LINE__, '{--MODULE_REGISTRY_404--}');
+			break;
+
+		case 'locked':
+			// Set HTTP status
+			setHttpStatus('403 FORBIDDEN');
+
+			if (!isIncludeReadable($GLOBALS['module_inc'])) {
+				// Set HTTP status again
+				setHttpStatus('404 NOT FOUND');
+
+				// Module does addionally not exists
+				addFatalMessage(__FUNCTION__, __LINE__, '{--MODULE_REGISTRY_404--}');
+			} // END - if
+
+			// Add fatal message
+			addFatalMessage(__FUNCTION__, __LINE__, '{--MODULE_REGISTRY_IS_LOCKED--}');
+			break;
+
+		default:
+			// Unknown module status
+			logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown status %s return from module check. Module=%s", $moduleState, getModule()));
+			addFatalMessage(__FUNCTION__, __LINE__, '{%message,UNKNOWN_MODULE_STATUS=' . $moduleState . '%}');
+			break;
+	} // END - switch
+
+	// Return status
+	return $isModuleValid;
+}
+
+// Include module
+function doIncludeModule () {
+	// Set content type
+	setContentType('text/html');
+
+	// The header file
+	loadIncludeOnce('inc/header.php');
+
+	// Modules are by default not valid!
+	$isModuleValid = false;
+
+	// By default NULL is used
+	$GLOBALS['module_inc'] = NULL;
+
+	// Is the maintenance mode active or goes all well?
+	if ((isExtensionActive('maintenance')) && (isMaintenanceEnabled()) && (!isAdmin()) && (getModule() != 'admin')) {
+		// Maintain mode is active and you are no admin
+		addFatalMessage(__FUNCTION__, __LINE__, '{--MAILER_DOWN_FOR_MAINTENANCE--}');
+	} elseif ((SQL_IS_LINK_UP()) && (!ifFatalErrorsDetected())) {
+		// Do the small "load module" call
+		$isModuleValid = loadModule();
+	} elseif (!ifFatalErrorsDetected()) {
+		// SQL problems detected
+		addFatalMessage(__FUNCTION__, __LINE__, '{--MYSQL_ERRORS--}');
+	}
+
+	if (($isModuleValid === true) && (!is_null($GLOBALS['module_inc']))) {
+		// Everything is okay so we can load the module
+		loadIncludeOnce($GLOBALS['module_inc']);
+	} // END - if
+
+	// Add the footer (this will call shutdown())
+	loadIncludeOnce('inc/footer.php');
+}
+
 // [EOF]
 ?>