X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fwrapper-functions.php;h=8e7ae4c14e8c415e0d501d64beb44129b1d0a966;hp=b76f513d39a06a91a60111ec4535c8be4051ab0b;hb=19b197c32c96ce8eea26561fb7b40e87c57716ae;hpb=f2736bc6457140146890877d992be862a78b259f diff --git a/inc/wrapper-functions.php b/inc/wrapper-functions.php index b76f513d39..8e7ae4c14e 100644 --- a/inc/wrapper-functions.php +++ b/inc/wrapper-functions.php @@ -1,7 +1,7 @@ 0) && (!ob_end_clean())) { // Failed! debug_report_bug(__FUNCTION__.': Failed to clean output buffer.'); } // END - if @@ -137,25 +137,10 @@ function decodeString ($str, $decompress = true) { return $str; } -// Smartly adds slashes -function smartAddSlashes ($unquoted) { - // Do we have cache? - if (!isset($GLOBALS['smart_addslashes'][$unquoted])) { - // Remove slashe - $unquoted = str_replace("\\", '', $unquoted); - - // Put it in cache and add slashes - $GLOBALS['smart_addslashes'][$unquoted] = addslashes($unquoted); - } // END - if - - // Return result - return $GLOBALS['smart_addslashes'][$unquoted]; -} - // Decode entities in a nicer way -function decodeEntities ($str) { +function decodeEntities ($str, $quote = ENT_NOQUOTES) { // Decode the entities to UTF-8 now - $decodedString = html_entity_decode($str, ENT_NOQUOTES, 'UTF-8'); + $decodedString = html_entity_decode($str, $quote, 'UTF-8'); // Return decoded string return $decodedString; @@ -166,13 +151,13 @@ function merge_array ($array1, $array2) { // Are both an array? if ((!is_array($array1)) && (!is_array($array2))) { // Both are not arrays - debug_report_bug(__FUNCTION__ . ': No arrays provided!'); + debug_report_bug(__FUNCTION__, __LINE__, 'No arrays provided!'); } elseif (!is_array($array1)) { // Left one is not an array - debug_report_bug(sprintf("[%s:%s] array1 is not an array. array != %s", __FUNCTION__, __LINE__, gettype($array1))); + debug_report_bug(__FILE__, __LINE__, sprintf("array1 is not an array. array != %s", gettype($array1))); } elseif (!is_array($array2)) { // Right one is not an array - debug_report_bug(sprintf("[%s:%s] array2 is not an array. array != %s", __FUNCTION__, __LINE__, gettype($array2))); + debug_report_bug(__FILE__, __LINE__, sprintf("array2 is not an array. array != %s", gettype($array2))); } // Merge all together @@ -185,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]; @@ -237,12 +228,12 @@ function detectRemoteHostname () { } // "Getter" for user agent -function detectUserAgent () { +function detectUserAgent ($alwaysReal = false) { // Get remote ip from environment $userAgent = getenv('HTTP_USER_AGENT'); // Is removeip installed? - if (isExtensionActive('removeip')) { + if ((isExtensionActive('removeip')) && ($alwaysReal === false)) { // Then anonymize it $userAgent = getAnonymousUserAgent($userAgent); } // END - if @@ -266,16 +257,33 @@ function detectReferer () { return $referer; } +// "Getter" for request URI +function detectRequestUri () { + // Return it + 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 @@ -318,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 @@ -329,14 +344,38 @@ 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 () { - // Simply check it - return ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y')); +function isDebugRegularExpressionEnabled () { + // Is cache set? + if (!isset($GLOBALS['is_regular_exp_debug_enabled'])) { + // Simply check it + $GLOBALS['is_regular_exp_debug_enabled'] = ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y')); + } // END - if + + // Return it + return $GLOBALS['is_regular_exp_debug_enabled']; } // Checks wether the cache instance is valid @@ -354,19 +393,19 @@ function copyFileVerified ($source, $dest, $chmod = '') { // Is the source file there? if (!isFileReadable($source)) { // Then abort here - debug_report_bug('Cannot read from source file ' . basename($source) . '.'); + debug_report_bug(__FUNCTION__, __LINE__, 'Cannot read from source file ' . basename($source) . '.'); } // END - if // Is the target directory there? if (!isDirectory(dirname($dest))) { // Then abort here - debug_report_bug('Cannot find directory ' . str_replace(getConfig('PATH'), '', dirname($dest)) . '.'); + debug_report_bug(__FUNCTION__, __LINE__, 'Cannot find directory ' . str_replace(getConfig('PATH'), '', dirname($dest)) . '.'); } // END - if // Now try to copy it if (!copy($source, $dest)) { // Something went wrong - debug_report_bug('copy() has failed to copy the file.'); + debug_report_bug(__FUNCTION__, __LINE__, 'copy() has failed to copy the file.'); } else { // Reset cache $GLOBALS['file_readable'][$dest] = true; @@ -388,14 +427,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!'); + debug_report_bug(__FUNCTION__, __LINE__, '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() @@ -404,7 +457,7 @@ function changeMode ($FQFN, $mode) { // Is the file/directory there? if ((!isFileReadable($FQFN)) && (!isDirectory($FQFN))) { // Neither, so abort here - debug_report_bug('Cannot chmod() on ' . basename($FQFN) . '.'); + debug_report_bug(__FUNCTION__, __LINE__, 'Cannot chmod() on ' . basename($FQFN) . '.'); } // END - if // Try to set them @@ -428,8 +481,15 @@ function removeFile ($FQFN) { } // Wrapper for $_POST['sel'] -function countPostSelection () { - return countSelection(postRequestElement('sel')); +function countPostSelection ($element = 'sel') { + // Is it set? + if (isPostRequestParameterSet($element)) { + // Return counted elements + return countSelection(postRequestParameter($element)); + } else { + // Return zero if not found + return 0; + } } // Checks wether the config-local.php is loaded @@ -443,15 +503,15 @@ function isNicknameUsed ($userid) { $isUsed = false; // Is the cache there - if (isset($GLOBALS['cache_probe_nicknames'][$userid])) { + if (isset($GLOBALS['is_nickname_used'][$userid])) { // Then use it - $isUsed = $GLOBALS['cache_probe_nicknames'][$userid]; + $isUsed = $GLOBALS['is_nickname_used'][$userid]; } else { // Determine it - $isUsed = ((isExtensionActive('nickname')) && (('' . round($userid) . '') != $userid)); + $isUsed = (('' . round($userid) . '') != $userid); // And write it to the cache - $GLOBALS['cache_probe_nicknames'][$userid] = $isUsed; + $GLOBALS['is_nickname_used'][$userid] = $isUsed; } // Return the result @@ -490,12 +550,12 @@ 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)) { // Output backtrace - debug_report_bug('what is empty.'); + debug_report_bug(__FUNCTION__, __LINE__, 'what is empty.'); } // END - if // Return it @@ -503,12 +563,12 @@ function isWhatSet ($strict = false) { } // Getter for 'action' value -function getAction () { +function getAction ($strict = true) { // Default is null $action = null; // Is the value set? - if (isActionSet(true)) { + if (isActionSet(($strict) && (getOutputMode() == 0))) { // Then use it $action = $GLOBALS['action']; } // END - if @@ -525,12 +585,12 @@ 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)) { // Output backtrace - debug_report_bug('action is empty.'); + debug_report_bug(__FUNCTION__, __LINE__, 'action is empty.'); } // END - if // Return it @@ -566,14 +626,11 @@ function isModuleSet ($strict = false) { // Should we abort here? if (($strict === true) && ($isset === false)) { // Output backtrace - print 'Module not set!
';
-		debug_print_backtrace();
-		die('= $version));
+	} else {
+		// Cache hits should be incremented twice
+		incrementStatsEntry('cache_hits', 2);
+	}
+
 	// Return it
-	//* DEBUG: */ print __FUNCTION__.':'.$ext_name.'=>'.$version.'
'; - return ((isExtensionInstalled($ext_name)) && (getExtensionVersion($ext_name) >= $version)); + //* DEBUG: */ debugOutput(__FUNCTION__.':'.$ext_name.'=>'.$version.':'.intval($GLOBALS['ext_installed_newer'][$ext_name][$version])); + return $GLOBALS['ext_installed_newer'][$ext_name][$version]; } // Wrapper function for checking if extension is installed and older than given version function isExtensionInstalledAndOlder ($ext_name, $version) { + // Is an cache entry found? + if (!isset($GLOBALS['ext_installed_older'][$ext_name][$version])) { + $GLOBALS['ext_installed_older'][$ext_name][$version] = ((isExtensionInstalled($ext_name)) && (isExtensionOlder($ext_name, $version))); + } else { + // Cache hits should be incremented twice + incrementStatsEntry('cache_hits', 2); + } + // Return it - //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'<'.$version.'
'; - return ((isExtensionInstalled($ext_name)) && (isExtensionOlder($ext_name, $version))); + //* DEBUG: */ debugOutput(__FUNCTION__.':'.$ext_name.'<'.$version.':'.intval($GLOBALS['ext_installed_older'][$ext_name][$version])); + return $GLOBALS['ext_installed_older'][$ext_name][$version]; } // Set username @@ -664,6 +748,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']; } @@ -681,16 +772,14 @@ function isInstallationPhase () { // Checks wether the extension demo is actuve and the admin login is demo (password needs to be demo, too!) 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); + // Is cache set? + if (!isset($GLOBALS['demo_mode_active'])) { + // Simply check it + $GLOBALS['demo_mode_active'] = ((isExtensionActive('demo')) && (getSession('admin_login') == 'demo')); + } // END - if - // Redirect to to - redirectToUrl($URL); + // Return it + return $GLOBALS['demo_mode_active']; } // Getter for PHP caching value @@ -700,6 +789,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(__FUNCTION__, __LINE__, 'Cache not set.'); + } // END - if + + // Check for admin hash return isset($GLOBALS['cache_array']['admin']['password'][$admin]); } @@ -708,5 +819,247 @@ function setAdminHash ($admin, $hash) { $GLOBALS['cache_array']['admin']['password'][$admin] = $hash; } +// Init user data array +function initUserData () { + // User id should not be zero + if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.'); + + // Init the user + $GLOBALS['user_data'][getCurrentUserId()] = array(); +} + +// Getter for user data +function getUserData ($column) { + // User id should not be zero + if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.'); + + // Return the value + return $GLOBALS['user_data'][getCurrentUserId()][$column]; +} + +// Geter for whole user data array +function getUserDataArray () { + // Get user id + $uid = getCurrentUserId(); + + // User id should not be zero + if ($uid < 1) debug_report_bug(__FUNCTION__.': User id is zero.'); + + // 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 +// in, but you should use isMember() if you want to find that out. +function isUserDataValid () { + // User id should not be zero so abort here + if (!isCurrentUserIdSet()) return false; + + // 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 +function setCurrentUserId ($userid) { + // Set userid + $GLOBALS['current_userid'] = bigintval($userid); + + // Unset it to re-determine the actual state + unset($GLOBALS['is_userdata_valid'][$userid]); +} + +// Getter for current userid +function getCurrentUserId () { + // Userid must be set before it can be used + if (!isCurrentUserIdSet()) { + // Not set + debug_report_bug(__FUNCTION__, __LINE__, 'User id is not set.'); + } // END - if + + // Return the userid + return $GLOBALS['current_userid']; +} + +// Checks if current userid is set +function isCurrentUserIdSet () { + return ((isset($GLOBALS['current_userid'])) && ($GLOBALS['current_userid'] > 0)); +} + +// Checks wether we are debugging template cache +function isDebuggingTemplateCache () { + return (getConfig('DEBUG_TEMPLATE_CACHE') == 'Y'); +} + +// Wrapper for fetchUserData() and getUserData() calls +function getFetchedUserData ($keyColumn, $userid, $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 $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); +} + +// Wrapper until we merged to the EL branch +function preCompileCode ($code, $template = '', $compiled = false, $full = true, $overwrite = false) { + return compileCode($code, false, true, $full); +} + +// Setter for HTTP status +function setHttpStatus ($status) { + $GLOBALS['http_status'] = (string) $status; +} + +// Getter for HTTP status +function getHttpStatus () { + return $GLOBALS['http_status']; +} + +// Setter for 'is_template_html' +function enableTemplateHtml ($enable = true) { + $GLOBALS['is_template_html'] = (bool) $enable; +} + +// Checks wether the template is HTML or not by previously set flag +// Default: true +function isTemplateHtml () { + // Is the output_mode other than 0 (HTML), then no comments are enabled + if (getOutputMode() != 0) { + // No HTML + return false; + } else { + // Maybe HTML? + return $GLOBALS['is_template_html']; + } +} + +/** + * Send a HTTP redirect to the browser. This function was taken from DokuWiki + * (GNU GPL 2; http://www.dokuwiki.org) and modified to fit into mailer project. + * + * ---------------------------------------------------------------------------- + * If you want to redirect, please use redirectToUrl(); instead + * ---------------------------------------------------------------------------- + * + * Works arround Microsoft IIS cookie sending bug. Does exit the script. + * + * @link http://support.microsoft.com/kb/q176113/ + * @author Andreas Gohr + * @access private + */ +function sendRawRedirect ($url) { + // always close the session + session_write_close(); + + // Revert entity & + $url = str_replace('&', '&', $url); + + // check if running on IIS < 6 with CGI-PHP + if ((isset($_SERVER['SERVER_SOFTWARE'])) && (isset($_SERVER['GATEWAY_INTERFACE'])) && + (strpos($_SERVER['GATEWAY_INTERFACE'],'CGI') !== false) && + (preg_match('|^Microsoft-IIS/(\d)\.\d$|', trim($_SERVER['SERVER_SOFTWARE']), $matches)) && + ($matches[1] < 6)) { + // Send the IIS header + sendHeader('Refresh: 0;url=' . $url); + } else { + // Send generic header + sendHeader('Location: ' . $url); + } + + // Shutdown here + shutdown(); +} + +// Determines the country of the given user id +function determineCountry ($userid) { + // Default is 'invalid' + $country = 'invalid'; + + // Is extension country active? + if (isExtensionActive('country')) { + // Determine the right country code through the country id + $id = getUserData('country_code'); + + // Then handle it over + $country = generateCountryInfo($id); + } else { + // Get raw code from user data + $country = getUserData('country'); + } + + // Return it + return $country; +} + +// "Getter" for total confirmed user accounts +function getTotalConfirmedUser () { + // Is it cached? + if (!isset($GLOBALS['total_confirmed_users'])) { + // Then do it + $GLOBALS['total_confirmed_users'] = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true); + } // END - if + + // Return cached value + return $GLOBALS['total_confirmed_users']; +} + +// Wrapper for writing debug informations to the browser +function debugOutput ($message) { + outputHtml('
' . $message . '
'); +} + +// Is given userid valid? +function isValidUserId ($userid) { + // Do we have cache? + if (!isset($GLOBALS['is_valid_userid'][$userid])) { + // Check it out + $GLOBALS['is_valid_userid'][$userid] = ((!is_null($userid)) && (!empty($userid)) && ($userid > 0)); + } // END - if + + // Return cache + return $GLOBALS['is_valid_userid'][$userid]; +} + // [EOF] ?>