X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fwrapper-functions.php;h=8e7ae4c14e8c415e0d501d64beb44129b1d0a966;hp=7cc9c9ec6b37bde0e5951792cd4354b8917d15e7;hb=19b197c32c96ce8eea26561fb7b40e87c57716ae;hpb=03f62d0b89aa9276ac37f4d616d940fae184d850 diff --git a/inc/wrapper-functions.php b/inc/wrapper-functions.php index 7cc9c9ec6b..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 } -// Loads an include file and logs any missing files for debug purposes -function loadInclude ($INC) { - // Add the path. This is why we need a trailing slash in config.php - $FQFN = constant('PATH') . $INC; - - // Is the include file there? - if (!isIncludeReadable($INC)) { - // Not there so log it - debug_report_bug(sprintf("Include file %s not found.", $INC)); - return false; - } // END - if - - // Try to load it - require($FQFN); -} - -// Loads an include file once -function loadIncludeOnce ($INC) { - // Is it not loaded? - if (!isset($GLOBALS['load_once'][$INC])) { - // Mark it as loaded - $GLOBALS['load_once'][$INC] = "loaded"; - - // Then try to load it - loadInclude($INC); - } // END - if -} - -// Checks wether an include file (non-FQFN better) is readable -function isIncludeReadable ($INC) { - // Construct FQFN - $FQFN = constant('PATH') . $INC; - - // Is it readable? - return isFileReadable($FQFN); -} - // Encode strings // @TODO Implement $compress function encodeString ($str, $compress = true) { @@ -162,16 +137,10 @@ function decodeString ($str, $decompress = true) { return $str; } -// Smartly adds slashes -function smartAddSlashes ($unquoted) { - $unquoted = str_replace("\\", '', $unquoted); - return 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; @@ -180,39 +149,52 @@ function decodeEntities ($str) { // Merges an array together but only if both are arrays function merge_array ($array1, $array2) { // Are both an array? - if ((is_array($array1)) && (is_array($array2))) { - // Merge all together - return array_merge($array1, $array2); - } elseif (is_array($array1)) { - // Return left array - DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("array2 is not an array. array != %s", gettype($array2))); - return $array1; - } elseif (is_array($array2)) { - // Return right array - DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("array1 is not an array. array != %s", gettype($array1))); - return $array2; + if ((!is_array($array1)) && (!is_array($array2))) { + // Both are not arrays + debug_report_bug(__FUNCTION__, __LINE__, 'No arrays provided!'); + } elseif (!is_array($array1)) { + // Left one is not an array + 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(__FILE__, __LINE__, sprintf("array2 is not an array. array != %s", gettype($array2))); } - // Both are not arrays - debug_report_bug(__FUNCTION__.": No arrays provided!"); + // Merge all together + return array_merge($array1, $array2); } // Check if given FQFN is a readable file function isFileReadable ($FQFN) { - // Check all... - return ((file_exists($FQFN)) && (is_file($FQFN)) && (is_readable($FQFN))); + // Do we have cache? + if (!isset($GLOBALS['file_readable'][$FQFN])) { + // Check all... + $GLOBALS['file_readable'][$FQFN] = ((file_exists($FQFN)) && (is_file($FQFN)) && (is_readable($FQFN))); + + // 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]; } -// Checks wether the given FQFN is a directory and not .,.. or .svn +// Checks wether the given FQFN is a directory and not ., .. or .svn function isDirectory ($FQFN) { - // Generate baseName - $baseName = basename($FQFN); + // Do we have cache? + if (!isset($GLOBALS['is_directory'][$FQFN])) { + // Generate baseName + $baseName = basename($FQFN); - // Check it - $isDirectory = ((is_dir($FQFN)) && ($baseName != '.') && ($baseName != '..') && ($baseName != '.svn')); + // Check it + $GLOBALS['is_directory'][$FQFN] = ((is_dir($FQFN)) && ($baseName != '.') && ($baseName != '..') && ($baseName != '.svn')); + } // END - if // Return the result - return $isDirectory; + return $GLOBALS['is_directory'][$FQFN]; } // "Getter" for remote IP number @@ -221,9 +203,9 @@ function detectRemoteAddr () { $remoteAddr = determineRealRemoteAddress(); // Is removeip installed? - if (EXT_IS_ACTIVE('removeip')) { + if (isExtensionActive('removeip')) { // Then anonymize it - $remoteAddr = GET_ANONYMOUS_REMOTE_ADDR($remoteAddr); + $remoteAddr = getAnonymousRemoteAddress($remoteAddr); } // END - if // Return it @@ -236,9 +218,9 @@ function detectRemoteHostname () { $remoteHost = getenv('REMOTE_HOST'); // Is removeip installed? - if (EXT_IS_ACTIVE('removeip')) { + if (isExtensionActive('removeip')) { // Then anonymize it - $remoteHost = GET_ANONYMOUS_REMOTE_HOST($remoteHost); + $remoteHost = getAnonymousRemoteHost($remoteHost); } // END - if // Return it @@ -246,14 +228,14 @@ 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 (EXT_IS_ACTIVE('removeip')) { + if ((isExtensionActive('removeip')) && ($alwaysReal === false)) { // Then anonymize it - $userAgent = GET_ANONYMOUS_USER_AGENT($userAgent); + $userAgent = getAnonymousUserAgent($userAgent); } // END - if // Return it @@ -266,51 +248,92 @@ function detectReferer () { $referer = getenv('HTTP_REFERER'); // Is removeip installed? - if (EXT_IS_ACTIVE('removeip')) { + if (isExtensionActive('removeip')) { // Then anonymize it - $referer = GET_ANONYMOUS_REFERER($referer); + $referer = getAnonymousReferer($referer); } // END - if // Return it 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 () { - $installing = ((isset($GLOBALS['mxchange_installing'])) || (REQUEST_ISSET_GET('installing'))); - //* DEBUG: */ var_dump($installing); - return $installing; + // Determine wether we are installing + if (!isset($GLOBALS['mailer_installing'])) { + // Check URL (css.php/js.php need this) + $GLOBALS['mailer_installing'] = isGetRequestParameterSet('installing'); + } // END - if + + // Return result + return $GLOBALS['mailer_installing']; } // Check wether this script is installed function isInstalled () { - return ( - ( - // New config file found and loaded - getConfig('MXCHANGE_INSTALLED') == 'Y' - ) || ( - // Fall-back! - isIncludeReadable('inc/config.php') - ) || ( + // Do we have cache? + if (!isset($GLOBALS['is_installed'])) { + // Determine wether this script is installed + $GLOBALS['is_installed'] = ( ( - // New config file found, but not yet read - isIncludeReadable('inc/cache/config-local.php') - ) && ( + // First is config + ( + ( + isConfigEntrySet('MXCHANGE_INSTALLED') + ) && ( + getConfig('MXCHANGE_INSTALLED') == 'Y' + ) + ) + ) || ( + // New config file found and loaded + isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php') + ) || ( ( - // Only new config file is found - !isIncludeReadable('inc/config.php') - ) || ( - // Is installation mode - isInstalling() + // New config file found, but not yet read + isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php') + ) && ( + ( + // Only new config file is found + !isIncludeReadable('inc/config.php') + ) || ( + // Is installation mode + !isInstalling() + ) ) - ) - ) - ); + )); + } // END - if + + // Then use the cache + return $GLOBALS['is_installed']; } // Check wether an admin is registered function isAdminRegistered () { - return (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 @@ -321,14 +344,38 @@ function isResetModeEnabled () { // Checks wether the debug mode is enabled function isDebugModeEnabled () { - // Simply check it - return (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 (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 @@ -346,20 +393,23 @@ 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(constant('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.'); - } // END - if + debug_report_bug(__FUNCTION__, __LINE__, 'copy() has failed to copy the file.'); + } else { + // Reset cache + $GLOBALS['file_readable'][$dest] = true; + } // If there are chmod rights set, apply them if (!empty($chmod)) { @@ -377,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() @@ -393,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 @@ -404,6 +468,9 @@ function changeMode ($FQFN, $mode) { function removeFile ($FQFN) { // Is the file there? if (isFileReadable($FQFN)) { + // Reset cache first + $GLOBALS['file_readable'][$FQFN] = false; + // Yes, so remove it return unlink($FQFN); } // END - if @@ -414,8 +481,15 @@ function removeFile ($FQFN) { } // Wrapper for $_POST['sel'] -function countPostSelection () { - return countSelection(REQUEST_POST('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 @@ -429,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 = ((EXT_IS_ACTIVE('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 @@ -474,14 +548,14 @@ function setWhatFromConfig ($configEntry) { } // Checks wether what is set and optionally aborts on miss -function isWhatSet ($abortOnMiss = false) { +function isWhatSet ($strict = false) { // Check for it - $isset = (!empty($GLOBALS['what'])); + $isset = isset($GLOBALS['what']); // Should we abort here? - if (($abortOnMiss === true) && ($isset === false)) { + 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 @@ -489,12 +563,12 @@ function isWhatSet ($abortOnMiss = 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 @@ -509,14 +583,14 @@ function setAction ($newAction) { } // Checks wether action is set and optionally aborts on miss -function isActionSet ($abortOnMiss = false) { +function isActionSet ($strict = false) { // Check for it - $isset = (!empty($GLOBALS['action'])); + $isset = ((isset($GLOBALS['action'])) && (!empty($GLOBALS['action']))); // Should we abort here? - if (($abortOnMiss === true) && ($isset === false)) { + 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 @@ -524,12 +598,12 @@ function isActionSet ($abortOnMiss = false) { } // Getter for 'module' value -function getModule () { +function getModule ($strict = true) { // Default is null $module = null; // Is the value set? - if (isModuleSet(true)) { + if (isModuleSet($strict)) { // Then use it $module = $GLOBALS['module']; } // END - if @@ -540,22 +614,23 @@ function getModule () { // Setter for 'module' value function setModule ($newModule) { - $GLOBALS['module'] = SQL_ESCAPE($newModule); + // Secure it and make all modules lower-case + $GLOBALS['module'] = SQL_ESCAPE(strtolower($newModule)); } // Checks wether module is set and optionally aborts on miss -function isModuleSet ($abortOnMiss = false) { +function isModuleSet ($strict = false) { // Check for it $isset = (!empty($GLOBALS['module'])); // Should we abort here? - if (($abortOnMiss === true) && ($isset === false)) { + if (($strict === true) && ($isset === false)) { // Output backtrace - debug_report_bug('module is empty.'); + debug_report_bug(__FUNCTION__, __LINE__, 'module is empty.'); } // END - if // Return it - return $isset; + return (($isset === true) && ($GLOBALS['module'] != 'unknown')) ; } // Getter for 'output_mode' value @@ -575,23 +650,416 @@ function getOutputMode () { // Setter for 'output_mode' value function setOutputMode ($newOutputMode) { - $GLOBALS['output_mode'] = SQL_ESCAPE($newOutputMode); + $GLOBALS['output_mode'] = (int) $newOutputMode; } // Checks wether output_mode is set and optionally aborts on miss -function isOutputModeSet ($abortOnMiss = false) { +function isOutputModeSet ($strict = false) { // Check for it $isset = (isset($GLOBALS['output_mode'])); // Should we abort here? - if (($abortOnMiss === true) && ($isset === false)) { + if (($strict === true) && ($isset === false)) { // Output backtrace - debug_report_bug('output_mode is empty.'); + debug_report_bug(__FUNCTION__, __LINE__, 'Output_mode is empty.'); } // END - if // Return it return $isset; } +// Enables block-mode +function enableBlockMode ($enabled = true) { + $GLOBALS['block_mode'] = $enabled; +} + +// Checks wether block-mode is enabled +function isBlockModeEnabled () { + // Abort if not set + if (!isset($GLOBALS['block_mode'])) { + // Needs to be fixed + debug_report_bug(__FUNCTION__, __LINE__, 'Block_mode is not set.'); + } // END - if + + // Return it + return $GLOBALS['block_mode']; +} + +// Wrapper function for addPointsThroughReferalSystem() +function addPointsDirectly ($subject, $userid, $points) { + // Reset level here + unset($GLOBALS['ref_level']); + + // Call more complicated method (due to more parameters) + return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, false, 'direct'); +} + +// Wrapper function to redirect from member-only modules to index +function redirectToIndexMemberOnlyModule () { + // Do the redirect here + redirectToUrl('modules.php?module=index&code=' . getCode('MODULE_MEMBER_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 +function isExtensionInstalledAndNewer ($ext_name, $version) { + // Is an cache entry found? + if (!isset($GLOBALS['ext_installed_newer'][$ext_name][$version])) { + $GLOBALS['ext_installed_newer'][$ext_name][$version] = ((isExtensionInstalled($ext_name)) && (getExtensionVersion($ext_name) >= $version)); + } else { + // Cache hits should be incremented twice + incrementStatsEntry('cache_hits', 2); + } + + // Return it + //* 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: */ debugOutput(__FUNCTION__.':'.$ext_name.'<'.$version.':'.intval($GLOBALS['ext_installed_older'][$ext_name][$version])); + return $GLOBALS['ext_installed_older'][$ext_name][$version]; +} + +// Set username +function setUsername ($userName) { + $GLOBALS['username'] = (string) $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']; +} + +// Wrapper function for installation phase +function isInstallationPhase () { + // Do we have cache? + if (!isset($GLOBALS['installation_phase'])) { + // Determine it + $GLOBALS['installation_phase'] = ((!isInstalled()) || (isInstalling())); + } // END - if + + // Return result + return $GLOBALS['installation_phase']; +} + +// Checks wether the extension demo is actuve and the admin login is demo (password needs to be demo, too!) +function isDemoModeActive () { + // Is cache set? + if (!isset($GLOBALS['demo_mode_active'])) { + // Simply check it + $GLOBALS['demo_mode_active'] = ((isExtensionActive('demo')) && (getSession('admin_login') == 'demo')); + } // END - if + + // Return it + return $GLOBALS['demo_mode_active']; +} + +// Getter for PHP caching value +function getPhpCaching () { + return $GLOBALS['php_caching']; +} + +// 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]); +} + +// Setter for admin hash +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] ?>