X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fwrapper-functions.php;h=e7ef273e797b4a0562efcbe0501e61b9973c5509;hp=de2d8c0fdb9c613f1c536a6b6047d13474174ccf;hb=8cf27a4147da16cabc4917f313235021cf4c4e01;hpb=62b4ef5bb0b63f7cac5f0dccd816246a108a5d83 diff --git a/inc/wrapper-functions.php b/inc/wrapper-functions.php index de2d8c0fdb..e7ef273e79 100644 --- a/inc/wrapper-functions.php +++ b/inc/wrapper-functions.php @@ -18,6 +18,7 @@ * svn:keywords Date Revision" (autoprobset!) at least!!!!!! * * -------------------------------------------------------------------- * * Copyright (c) 2003 - 2009 by Roland Haeder * + * Copyright (c) 2009, 2010 by Mailer Developer Team * * For more information visit: http://www.mxchange.org * * * * This program is free software; you can redistribute it and/or modify * @@ -42,31 +43,27 @@ if (!defined('__SECURITY')) { } // END - if // Read a given file -function readFromFile ($FQFN, $sqlPrepare = false) { +function readFromFile ($FQFN) { // Sanity-check if file is there (should be there, but just to make it sure) if (!isFileReadable($FQFN)) { // This should not happen debug_report_bug(__FUNCTION__.': File ' . basename($FQFN) . ' is not readable!'); } // END - if - // Load the file - if (function_exists('file_get_contents')) { - // Use new function - $content = file_get_contents($FQFN); - } else { - // Fall-back to implode-file chain - $content = implode('', file($FQFN)); - } - - // Prepare SQL queries? - if ($sqlPrepare === true) { - // Remove some unwanted chars - $content = str_replace("\r", '', $content); - $content = str_replace("\n\n", "\n", $content); + // Is it cached? + if (!isset($GLOBALS['file_content'][$FQFN])) { + // Load the file + if (function_exists('file_get_contents')) { + // Use new function + $GLOBALS['file_content'][$FQFN] = file_get_contents($FQFN); + } else { + // Fall-back to implode-file chain + $GLOBALS['file_content'][$FQFN] = implode('', file($FQFN)); + } } // END - if // Return the content - return $content; + return $GLOBALS['file_content'][$FQFN]; } // Writes content to a file @@ -110,6 +107,9 @@ function writeToFile ($FQFN, $content, $aquireLock = false) { // Mark it as readable $GLOBALS['file_readable'][$FQFN] = true; + // Remember content in cache + $GLOBALS['file_content'][$FQFN] = $content; + // Return status return changeMode($FQFN, 0644); } @@ -170,7 +170,13 @@ function isFileReadable ($FQFN) { if (!isset($GLOBALS['file_readable'][$FQFN])) { // Check all... $GLOBALS['file_readable'][$FQFN] = ((file_exists($FQFN)) && (is_file($FQFN)) && (is_readable($FQFN))); - } // END - if + + // Debug message + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . basename($FQFN) . ' - CHECK! (' . intval($GLOBALS['file_readable'][$FQFN]) . ')'); + } else { + // Cache used + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . basename($FQFN) . ' - CACHE! (' . intval($GLOBALS['file_readable'][$FQFN]) . ')'); + } // Return result return $GLOBALS['file_readable'][$FQFN]; @@ -257,16 +263,27 @@ function detectRequestUri () { return (getenv('REQUEST_URI')); } +// "Getter" for query string +function detectQueryString () { + return str_replace('&', '&', (getenv('QUERY_STRING'))); +} + +// "Getter" for SERVER_NAME +function detectServerName () { + // Return it + return (getenv('SERVER_NAME')); +} + // Check wether we are installing function isInstalling () { // Determine wether we are installing - if (!isset($GLOBALS['mxchange_installing'])) { + if (!isset($GLOBALS['mailer_installing'])) { // Check URL (css.php/js.php need this) - $GLOBALS['mxchange_installing'] = isGetRequestElementSet('installing'); + $GLOBALS['mailer_installing'] = isGetRequestParameterSet('installing'); } // END - if // Return result - return $GLOBALS['mxchange_installing']; + return $GLOBALS['mailer_installing']; } // Check wether this script is installed @@ -309,7 +326,14 @@ function isInstalled () { // Check wether an admin is registered function isAdminRegistered () { - return ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y')); + // Is cache set? + if (!isset($GLOBALS['is_admin_registered'])) { + // Simply check it + $GLOBALS['is_admin_registered'] = ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y')); + } // END - if + + // Return it + return $GLOBALS['is_admin_registered']; } // Checks wether the reset mode is active @@ -320,12 +344,30 @@ function isResetModeEnabled () { // Checks wether the debug mode is enabled function isDebugModeEnabled () { - // Simply check it - return ((isConfigEntrySet('DEBUG_MODE')) && (getConfig('DEBUG_MODE') == 'Y')); + // Is cache set? + if (!isset($GLOBALS['is_debugmode_enabled'])) { + // Simply check it + $GLOBALS['is_debugmode_enabled'] = ((isConfigEntrySet('DEBUG_MODE')) && (getConfig('DEBUG_MODE') == 'Y')); + } // END - if + + // Return it + return $GLOBALS['is_debugmode_enabled']; +} + +// Checks wether SQL debugging is enabled +function isSqlDebuggingEnabled () { + // Is cache set? + if (!isset($GLOBALS['is_sql_debug_enabled'])) { + // Determine if SQL debugging is enabled + $GLOBALS['is_sql_debug_enabled'] = ((isConfigEntrySet('DEBUG_SQL')) && (getConfig('DEBUG_SQL') == 'Y')); + } // END - if + + // Return it + return $GLOBALS['is_sql_debug_enabled']; } // Checks wether we shall debug regular expressions -function isDebugRegExpressionEnabled () { +function isDebugRegularExpressionEnabled () { // Simply check it return ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y')); } @@ -379,14 +421,28 @@ function copyFileVerified ($source, $dest, $chmod = '') { // Wrapper function for header() // Send a header but checks before if we can do so function sendHeader ($header) { + // Send the header + //* DEBUG: */ logDebugMessage(__FUNCTION__ . ': header=' . $header); + $GLOBALS['header'][] = trim($header); +} + +// Flushes all headers +function flushHeaders () { // Is the header already sent? if (headers_sent()) { // Then abort here debug_report_bug('Headers already sent!'); } // END - if - // Send the header - header(trim($header)); + // Flush all headers if found + if ((isset($GLOBALS['header'])) && (is_array($GLOBALS['header']))) { + foreach ($GLOBALS['header'] as $header) { + header($header); + } // END - foreach + } // END - if + + // Mark them as flushed + $GLOBALS['header'] = array(); } // Wrapper function for chmod() @@ -421,9 +477,9 @@ function removeFile ($FQFN) { // Wrapper for $_POST['sel'] function countPostSelection ($element = 'sel') { // Is it set? - if (isPostRequestElementSet($element)) { + if (isPostRequestParameterSet($element)) { // Return counted elements - return countSelection(postRequestElement($element)); + return countSelection(postRequestParameter($element)); } else { // Return zero if not found return 0; @@ -488,7 +544,7 @@ function setWhatFromConfig ($configEntry) { // Checks wether what is set and optionally aborts on miss function isWhatSet ($strict = false) { // Check for it - $isset = (isset($GLOBALS['what'])); + $isset = isset($GLOBALS['what']); // Should we abort here? if (($strict === true) && ($isset === false)) { @@ -523,7 +579,7 @@ function setAction ($newAction) { // Checks wether action is set and optionally aborts on miss function isActionSet ($strict = false) { // Check for it - $isset = (isset($GLOBALS['action'])); + $isset = ((isset($GLOBALS['action'])) && (!empty($GLOBALS['action']))); // Should we abort here? if (($strict === true) && ($isset === false)) { @@ -635,7 +691,18 @@ function addPointsDirectly ($subject, $userid, $points) { // Wrapper function to redirect from member-only modules to index function redirectToIndexMemberOnlyModule () { // Do the redirect here - redirectToUrl('modules.php?module=index&code=' . getCode('MODULE_MEM_ONLY') . '&mod=' . getModule()); + redirectToUrl('modules.php?module=index&code=' . getCode('MODULE_MEM_ONLY') . '&mod=' . getModule()); +} + +// Wrapper function to redirect to current URL +function redirectToRequestUri () { + redirectToUrl(basename(detectRequestUri())); +} + +// Wrapper function to redirect to de-refered URL +function redirectToDereferedUrl ($URL) { + // Redirect to to + redirectToUrl(generateDerefererUrl($URL)); } // Wrapper function for checking if extension is installed and newer or same version @@ -659,6 +726,13 @@ function setUsername ($userName) { // Get username function getUsername () { + // User name set? + if (!isset($GLOBALS['username'])) { + // No, so it has to be a guest + $GLOBALS['username'] = getMessage('USERNAME_GUEST'); + } // END - if + + // Return it return $GLOBALS['username']; } @@ -679,15 +753,6 @@ function isDemoModeActive () { return ((isExtensionActive('demo')) && (getSession('admin_login') == 'demo')); } -// Wrapper function to redirect to de-refered URL -function redirectToDereferedUrl ($URL) { - // De-refer the URL - $URL = generateDerefererUrl($URL); - - // Redirect to to - redirectToUrl($URL); -} - // Getter for PHP caching value function getPhpCaching () { return $GLOBALS['php_caching']; @@ -695,6 +760,28 @@ function getPhpCaching () { // Checks wether the admin hash is set function isAdminHashSet ($admin) { + /** + * @TODO Do we really need this check? If yes, try to fix this: + * 1.:functions.php:2504, debug_get_mailable_backtrace(0) + * 2.:wrapper-functions.php:744, debug_report_bug(1) + * 3.:mysql-manager.php:728, isAdminHashSet(1) + * 4.:filters.php:384, isAdmin(0) + * 5.:debug_get_mailable_backtrace:2457, FILTER_DETERMINE_USERNAME(1) + * 6.:filter-functions.php:280, call_user_func_array(2) + * 7.:load_cache.php:74, runFilterChain(1) + * 8.:inc-functions.php:131, include(1) + * 9.:inc-functions.php:145, loadInclude(1) + * 10.:mysql-connect.php:104, loadIncludeOnce(1) + * 11.:inc-functions.php:131, include(1) + * 12.:inc-functions.php:145, loadInclude(1) + * 13.:config-global.php:106, loadIncludeOnce(1) + * 14.:js.php:57, require(1) + */ + if (!isset($GLOBALS['cache_array']['admin'])) { + debug_report_bug('Cache not set.'); + } // END - if + + // Check for admin hash return isset($GLOBALS['cache_array']['admin']['password'][$admin]); } @@ -723,11 +810,20 @@ function getUserData ($column) { // Geter for whole user data array function getUserDataArray () { + // Get user id + $uid = getCurrentUserId(); + // User id should not be zero - if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.'); + if ($uid < 1) debug_report_bug(__FUNCTION__.': User id is zero.'); - // Get the whole array - return $GLOBALS['user_data'][getCurrentUserId()]; + // Get the whole array if found + if (isset($GLOBALS['user_data'][$uid])) { + // Found, so return it + return $GLOBALS['user_data'][$uid]; + } else { + // Return empty array + return array(); + } } // Checks if the user data is valid, this may indicate that the user has logged @@ -736,8 +832,14 @@ function isUserDataValid () { // User id should not be zero so abort here if (!isCurrentUserIdSet()) return false; - // Is the array there and filled? - return ((isset($GLOBALS['user_data'][getCurrentUserId()])) && (count($GLOBALS['user_data'][getCurrentUserId()]) > 1)); + // Is it cached? + if (!isset($GLOBALS['is_userdata_valid'][getCurrentUserId()])) { + // Determine it + $GLOBALS['is_userdata_valid'][getCurrentUserId()] = ((isset($GLOBALS['user_data'][getCurrentUserId()])) && (count($GLOBALS['user_data'][getCurrentUserId()]) > 1)); + } // END - if + + // Return the result + return $GLOBALS['is_userdata_valid'][getCurrentUserId()]; } // Setter for current userid @@ -769,17 +871,41 @@ function isDebuggingTemplateCache () { // Wrapper for fetchUserData() and getUserData() calls function getFetchedUserData ($keyColumn, $userId, $valueColumn) { - // Default is 'guest' - $data = getMessage('USERNAME_GUEST'); - - // Can we fetch the user data? - if (($userId > 0) && (fetchUserData($userId, $keyColumn))) { - // Now get the data back - $data = getUserData($valueColumn); + // Is it cached? + if (!isset($GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn])) { + // Default is 'guest' + $data = getMessage('USERNAME_GUEST'); + + // Can we fetch the user data? + if (($userId > 0) && (fetchUserData($userId, $keyColumn))) { + // Now get the data back + $data = getUserData($valueColumn); + } // END - if + + // Cache it + $GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn] = $data; } // END - if // Return it - return $data; + return $GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn]; +} + +// Wrapper for strpos() to ease porting from deprecated ereg() function +function isInString ($needle, $haystack) { + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'needle=' . $needle . ', haystack=' . $haystack . ', returned=' . intval(strpos($haystack, $needle) !== false)); + return (strpos($haystack, $needle) !== false); +} + +// Wrapper for strpos() to ease porting from deprecated eregi() function +// This function is case-insensitive +function isInStringIgnoreCase ($needle, $haystack) { + return (isInString(strtolower($needle), strtolower($haystack))); +} + +// Wrapper to check for if fatal errors where detected +function ifFatalErrorsDetected () { + // Just call the inner function + return (getTotalFatalErrors() > 0); } // [EOF]