X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fmodule-functions.php;h=39fab38c7ae6e8e2885eb1a9ed7623f745028c4b;hp=d0f00c8fa60c1f2602cd434fd4c4741d4f6ae60b;hb=da5c63bacddced77a951cbe7b223f314885a6c87;hpb=c9b17a86f4d62b50b8b1fbe6f9d88e6092430526 diff --git a/inc/module-functions.php b/inc/module-functions.php index d0f00c8fa6..39fab38c7a 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 - 2013 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 + // Is there 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_TITLE--}'; + } 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,17 +116,17 @@ function getModuleStatus ($module) { // Is the module_status entry there? if (!isModuleStatusSet($module)) { // Abort - debug_report_bug('Module status not set. module=' . $module); + reportBug(__FUNCTION__, __LINE__, '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; + $found = FALSE; // Check if cache is latest version if (isExtensionInstalledAndNewer('cache', '0.1.2')) { @@ -131,7 +137,7 @@ function isModuleRegistered ($module) { incrementStatsEntry('cache_hits'); // Is found - $found = true; + $found = TRUE; } else { // No, then we have to update it! setModuleStatus($module, 'cache_miss'); @@ -146,15 +152,15 @@ function isModuleRegistered ($module) { $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 // Mark as found - $found = true; + $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')); @@ -209,7 +215,7 @@ function checkModulePermissions ($module = '') { $module = getModule(); } // END - if - // Do we have cache? + // Is there cache? if (isModuleStatusSet($module)) { // Then use it return getModuleStatus($module); @@ -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 @@ -247,7 +253,7 @@ function checkModulePermissions ($module = '') { $found = isModuleRegistered($module_chk); // Is the module found? - if ($found === true) { + if ($found === TRUE) { // Check returned values against current access permissions // // Admin access ----- Guest access ----- --- Guest or member? --- @@ -276,13 +282,13 @@ function checkModulePermissions ($module = '') { } // END - if // Still no luck or not found? - if (($found === false) && (!isExtensionActive('cache')) && (getModuleStatus($module_chk) != 'done')) { + if (($found === FALSE) && (!isExtensionActive('cache')) && (getModuleStatus($module_chk) != 'done')) { // ----- 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 + * Since 0.3.6 there is 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` @@ -320,9 +326,9 @@ VALUES } elseif ((getModuleStatus($module_chk) == 'cache_miss') && (isHtmlOutputMode())) { // Rebuild the cache files rebuildCache('modules', 'modules'); - } elseif ($found === false) { + } 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,16 +340,16 @@ 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); } // Checks if the module has a menu -function ifModuleHasMenu ($module, $forceDb = false) { +function ifModuleHasMenu ($module, $forceDb = FALSE) { // All is false by default - $ret = false; + $ret = FALSE; // Extension installed and newer than or has version 0.1.2? if (isExtensionInstalledAndNewer('cache', '0.1.2')) { @@ -360,7 +366,7 @@ function ifModuleHasMenu ($module, $forceDb = false) { // Admin/guest/member/sponsor modules have always a menu! $ret = in_array($module, array('admin', 'index', 'login', 'sponsor')); } - } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.3.6')) && ((!isExtensionActive('cache')) || ($forceDb === true))) { + } 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($module), __FUNCTION__, __LINE__); @@ -380,11 +386,11 @@ function ifModuleHasMenu ($module, $forceDb = false) { // Free memory SQL_FREERESULT($result); } elseif (!isExtensionInstalled('sql_patches')) { - // No sql_patches installed, so maybe in admin/guest/member/sponsor area or no admin registered? + // No ext-sql_patches installed, so maybe in admin/guest/member/sponsor area or no admin registered? $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.'); + } elseif (!isInstallationPhase()) { + // Unsupported state, but ignored in installation phase + logDebugMessage(__FUNCTION__, __LINE__, 'This should never be reached, module[' . gettype($module) . ']=' . $module . ',forceDb=' . intval($forceDb)); } // Return status @@ -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,145 @@ function addModuleSql ($module, $locked, $hidden, $adminOnly, $memOnly) { } } +// Load the currently set module +function loadModule () { + // By default all modules are invalid + $isModuleValid = FALSE; + + // 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'); +} + +// "Getter" for menu mode from given module +function getMenuModeFromModule () { + // Is cache set? + if (!isset($GLOBALS[__FUNCTION__])) { + // Default is 'noindex' which is invalid for SQL tables but okay for meta data template + $GLOBALS[__FUNCTION__] = 'noindex'; + + // Determine it hard-coded + if (getModule() == 'login') { + // Is member area + $GLOBALS[__FUNCTION__] = 'member'; + } elseif (getModule() == 'index') { + // Is guest area + $GLOBALS[__FUNCTION__] = 'guest'; + } elseif (getModule() == 'admin') { + // Is admin area + $GLOBALS[__FUNCTION__] = 'admin'; + } elseif (isInstallationPhase()) { + // Is installation phase + $GLOBALS[__FUNCTION__] = 'install'; + } else { + // Get it from filter + $GLOBALS[__FUNCTION__] = runFilterChain('determine_menu_mode'); + } + } // END - if + + // Return it + return $GLOBALS[__FUNCTION__]; +} + // [EOF] ?>