X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fmodule-functions.php;h=15d2f304656b7d1e51e3de190c211e8f2cdb53ce;hb=f0f3e41ec19e9cf73caeaad80b5396e49c4ee559;hp=445c8505d453d7944c22afd555d79fb238806b2f;hpb=bb902775e3ba4ef820a764fc5f3c725a8f03e45c;p=mailer.git

diff --git a/inc/module-functions.php b/inc/module-functions.php
index 445c8505d4..15d2f30465 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 - 2012 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 *
@@ -42,56 +42,62 @@ if (!defined('__SECURITY')) {
 
 // "Getter" for module title
 function getModuleTitle ($module) {
-	// Init variables
-	$data['title'] = '';
-	$result = false;
-
-	// Is the script installed?
-	if ((isInstalled()) && ($module != 'error')) {
-		// Check if cache is valid
-		if ((isExtensionInstalledAndNewer('cache', '0.1.2')) && (isset($GLOBALS['cache_array']['modules']['module'])) && (in_array($module, $GLOBALS['cache_array']['modules']['module']))) {
-			// Load from cache
-			$data['title'] = $GLOBALS['cache_array']['modules']['title'][$module];
-
-			// Update cache hits
-			incrementStatsEntry('cache_hits');
-		} elseif (!isExtensionActive('cache')) {
-			// Load from database
-			$result = SQL_QUERY_ESC("SELECT `title` FROM `{?_MYSQL_PREFIX?}_mod_reg` WHERE `module`='%s' LIMIT 1",
-				array($module), __FUNCTION__, __LINE__);
-
-			// Is the entry there?
-			if (SQL_NUMROWS($result)) {
-				// Get the title from database
-				$data = SQL_FETCHARRAY($result);
-			} // END - if
+	// Do we have cache?
+	if (!isset($GLOBALS[__FUNCTION__][$module])) {
+		// Init variables
+		$data['title'] = '';
+		$result = false;
+
+		// Is the script installed?
+		if ((isInstalled()) && ($module != 'error')) {
+			// Check if cache is valid
+			if ((isExtensionInstalledAndNewer('cache', '0.1.2')) && (isset($GLOBALS['cache_array']['modules']['module'])) && (in_array($module, $GLOBALS['cache_array']['modules']['module']))) {
+				// Load from cache
+				$data['title'] = $GLOBALS['cache_array']['modules']['title'][$module];
+
+				// Update cache hits
+				incrementStatsEntry('cache_hits');
+			} elseif (!isExtensionActive('cache')) {
+				// Load from database
+				$result = SQL_QUERY_ESC("SELECT `title` FROM `{?_MYSQL_PREFIX?}_mod_reg` WHERE `module`='%s' LIMIT 1",
+					array($module), __FUNCTION__, __LINE__);
+
+				// Is the entry there?
+				if (SQL_NUMROWS($result) == 1) {
+					// Get the title from database
+					$data = SQL_FETCHARRAY($result);
+				} // END - if
+
+				// Free the result
+				SQL_FREERESULT($result);
+			}
+		} // END - if
 
-			// Free the result
-			SQL_FREERESULT($result);
-		}
-	} // END - if
+		// Trim name
+		$data['title'] = trim($data['title']);
+
+		// Still no luck or empty title?
+		if (empty($data['title'])) {
+			// Is it 'error'?
+			if ($module == 'error') {
+				// Error (real module was not found)
+				$data['title'] = '{--MODULE_ERROR_404--}';
+			}  else {
+				// No name found
+				$data['title'] = '{%message,UNKNOWN_MODULE_DETECTED_TITLE=' . $module . '%}';
+				if ((is_resource($result)) && (SQL_HASZERONUMS($result))) {
+					// Add module to database and ignore return value
+					checkModulePermissions($module);
+				} // END - if
+			}
+		} // END - if
 
-	// Trim name
-	$data['title'] = trim($data['title']);
-
-	// Still no luck or empty title?
-	if (empty($data['title'])) {
-		// Is it 'error'?
-		if ($module == 'error') {
-			// Error (real module was not found)
-			$data['title'] = getMessage('MODULE_ERROR_404');
-		}  else {
-			// No name found
-			$data['title'] = getMaskedMessage('UNKNOWN_MODULE_DETECTED', $module);
-			if ((is_resource($result)) && (SQL_HASZERONUMS($result))) {
-				// Add module to database
-				$dummy = checkModulePermissions($module);
-			} // END - if
-		}
+		// Store in cache
+		$GLOBALS[__FUNCTION__][$module] = $data['title'];
 	} // END - if
 
-	// Return name
-	return $data['title'];
+	// Return it
+	return $GLOBALS[__FUNCTION__][$module];
 }
 
 // Checks if module_status entry is there
@@ -110,14 +116,14 @@ function getModuleStatus ($module) {
 	// Is the module_status entry there?
 	if (!isModuleStatusSet($module)) {
 		// Abort
-		debug_report_bug('Module status not set. module=' . $module);
+		reportBug('Module status not set. module=' . $module);
 	} // END - if
 
 	// Return it
 	return $GLOBALS['module_status'][$module];
 }
 
-// Checks wether the given module is registered
+// Checks whether the given module is registered
 function isModuleRegistered ($module) {
 	// By default nothing is found
 	$found  = false;
@@ -139,14 +145,14 @@ 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
 			$data = SQL_FETCHARRAY($result);
 
 			// Set all entries
-			foreach ($data as $key=>$value) {
+			foreach ($data as $key => $value) {
 				$GLOBALS['cache_array']['modules'][$key][$module] = $value;
 			} // END - foreach
 
@@ -154,7 +160,7 @@ function isModuleRegistered ($module) {
 			$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
@@ -165,7 +171,7 @@ function isModuleRegistered ($module) {
 	return $found;
 }
 
-// Checks wether the given module is locked by just checking the cache
+// Checks whether 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'));
@@ -174,7 +180,7 @@ function isModuleLocked ($module) {
 	return $return;
 }
 
-// Checks wether the given module is hidden by just checking the cache
+// Checks whether 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'));
@@ -183,7 +189,7 @@ function isModuleHidden ($module) {
 	return $return;
 }
 
-// Checks wether the given module is mem_only by just checking the cache
+// Checks whether 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'));
@@ -192,7 +198,7 @@ function isModuleMemberOnly ($module) {
 	return $return;
 }
 
-// Checks wether the given module is admin_only by just checking the cache
+// Checks whether 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'));
@@ -223,7 +229,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
@@ -286,19 +292,19 @@ function checkModulePermissions ($module = '') {
 				 * 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`)
+(`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`)
+(`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';
@@ -322,7 +328,7 @@ VALUES
 		rebuildCache('modules', 'modules');
 	} elseif ($found === false) {
 		// Problem with module detected
-		logDebugMessage(__FUNCTION__, __LINE__, sprintf("Problem in module %s detected. ret=%s,locked=%d,hidden=%d,mem=%d,admin=%d,output_mode=%s",
+		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)),
@@ -334,7 +340,7 @@ VALUES
 	}
 
 	// Debug log
-	logDebugMessage(__FUNCTION__, __LINE__, sprintf("module=%s, status=%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);
@@ -392,11 +398,11 @@ function ifModuleHasMenu ($module, $forceDb = false) {
 }
 
 // Adds a SQL for given module
-function addModuleSql ($module, $locked, $hidden, $adminOnly, $memOnly) {
+function addModuleSql ($module, $title, $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`,`title`,`locked`,`hidden`,`admin_only`,`mem_only`) VALUES ('" . $module . "','" . $title . "','" . $locked . "','" . $hidden . "','" . $adminOnly . "','" . $memOnly . "')");
 	} else {
 		// Already registered
 		logDebugMessage(__FUNCTION__, __LINE__, sprintf("Already registered: module=%s,locked=%s,hidden=%s,admin=%s,mem=%s",
@@ -409,5 +415,118 @@ 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_LOCKED_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--}');
+	}
+
+	// Is the module valid?
+	if (($isModuleValid === true) && (!is_null($GLOBALS['module_inc']))) {
+		// Run pre-filter
+		runFilterChain('pre_module_load');
+
+		// Everything is okay so we can load the module
+		loadIncludeOnce($GLOBALS['module_inc']);
+
+		// Run post-filter
+		runFilterChain('post_module_load');
+	} // END - if
+
+	// Add the footer (this will call doShutdown())
+	loadIncludeOnce('inc/footer.php');
+}
+
 // [EOF]
 ?>