X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fwrapper-functions.php;h=2eecd1a2ef5931f614b245f5678037d8ea990847;hb=12effdb00f104773905152bfb2950496c2efaec4;hp=ff399cbf86e0066338a557a3293c8e1630b37751;hpb=cb0ddf186efd5b223638476e74cffb2d3c415407;p=mailer.git diff --git a/inc/wrapper-functions.php b/inc/wrapper-functions.php index ff399cbf86..2eecd1a2ef 100644 --- a/inc/wrapper-functions.php +++ b/inc/wrapper-functions.php @@ -14,11 +14,9 @@ * $Date:: $ * * $Tag:: 0.2.1-FINAL $ * * $Author:: $ * - * Needs to be in all Files and every File needs "svn propset * - * svn:keywords Date Revision" (autoprobset!) at least!!!!!! * * -------------------------------------------------------------------- * * Copyright (c) 2003 - 2009 by Roland Haeder * - * Copyright (c) 2009, 2010 by Mailer Developer Team * + * Copyright (c) 2009 - 2011 by Mailer Developer Team * * For more information visit: http://www.mxchange.org * * * * This program is free software; you can redistribute it and/or modify * @@ -47,11 +45,8 @@ 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 - - // Is it cached? - if (!isset($GLOBALS['file_content'][$FQFN])) { + debug_report_bug(__FUNCTION__, __LINE__, 'File ' . basename($FQFN) . ' is not readable!'); + } elseif (!isset($GLOBALS['file_content'][$FQFN])) { // Load the file if (function_exists('file_get_contents')) { // Use new function @@ -78,6 +73,8 @@ function writeToFile ($FQFN, $content, $aquireLock = false) { } // END - if // By default all is failed... + $GLOBALS['file_readable'][$FQFN] = false; + unset($GLOBALS['file_content'][$FQFN]); $return = false; // Is the function there? @@ -94,32 +91,38 @@ function writeToFile ($FQFN, $content, $aquireLock = false) { // Write it with fopen $fp = fopen($FQFN, 'w') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot write to file ' . basename($FQFN) . '!'); - // Aquire lock - if ($aquireLock === true) flock($fp, LOCK_EX); + // Do we need to aquire a lock? + if ($aquireLock === true) { + // Aquire lock + flock($fp, LOCK_EX); + } // END - if // Write content - fwrite($fp, $content); + $return = fwrite($fp, $content); // Close stream fclose($fp); } - // Mark it as readable - $GLOBALS['file_readable'][$FQFN] = true; + // Was something written? + if ($return !== false) { + // Mark it as readable + $GLOBALS['file_readable'][$FQFN] = true; - // Remember content in cache - $GLOBALS['file_content'][$FQFN] = $content; + // Remember content in cache + $GLOBALS['file_content'][$FQFN] = $content; + } // END - if // Return status - return changeMode($FQFN, 0644); + return (($return !== false) && (changeMode($FQFN, 0644))); } // Clears the output buffer. This function does *NOT* backup sent content. function clearOutputBuffer () { // Trigger an error on failure - if (!ob_end_clean()) { + if ((ob_get_length() > 0) && (!ob_end_clean())) { // Failed! - debug_report_bug(__FUNCTION__.': Failed to clean output buffer.'); + debug_report_bug(__FUNCTION__, __LINE__, 'Failed to clean output buffer.'); } // END - if } @@ -151,13 +154,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(__FILE__, __LINE__, sprintf("array1 is not an array. array != %s", gettype($array1))); + debug_report_bug(__FUNCTION__, __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))); + debug_report_bug(__FUNCTION__, __LINE__, sprintf("array2 is not an array. array != %s", gettype($array2))); } // Merge all together @@ -170,13 +173,7 @@ function isFileReadable ($FQFN) { 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]) . ')'); - } + } // END - if // Return result return $GLOBALS['file_readable'][$FQFN]; @@ -185,22 +182,37 @@ function isFileReadable ($FQFN) { // Checks wether the given FQFN is a directory and not ., .. or .svn function isDirectory ($FQFN) { // Do we have cache? - if (!isset($GLOBALS['is_directory'][$FQFN])) { + if (!isset($GLOBALS[__FUNCTION__][$FQFN])) { // Generate baseName $baseName = basename($FQFN); // Check it - $GLOBALS['is_directory'][$FQFN] = ((is_dir($FQFN)) && ($baseName != '.') && ($baseName != '..') && ($baseName != '.svn')); + $GLOBALS[__FUNCTION__][$FQFN] = ((is_dir($FQFN)) && ($baseName != '.') && ($baseName != '..') && ($baseName != '.svn')); } // END - if // Return the result - return $GLOBALS['is_directory'][$FQFN]; + return $GLOBALS[__FUNCTION__][$FQFN]; +} + +// "Getter" for the real remote IP number +function detectRealIpAddress () { + // Get remote ip from environment + $remoteAddr = determineRealRemoteAddress(); + + // Is removeip installed? + if (isExtensionActive('removeip')) { + // Then anonymize it + $remoteAddr = getAnonymousRemoteAddress($remoteAddr); + } // END - if + + // Return it + return $remoteAddr; } // "Getter" for remote IP number function detectRemoteAddr () { // Get remote ip from environment - $remoteAddr = determineRealRemoteAddress(); + $remoteAddr = determineRealRemoteAddress(true); // Is removeip installed? if (isExtensionActive('removeip')) { @@ -274,6 +286,28 @@ function detectServerName () { return (getenv('SERVER_NAME')); } +// Removes any existing www. from SERVER_NAME. This is very silly but enough +// for our purpose here. +function detectDomainName () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Get server name + $domainName = detectServerName(); + + // Is there any www. ? + if (substr($domainName, 0, 4) == 'www.') { + // Remove it + $domainName = substr($domainName, 4); + } // END - if + + // Set cache + $GLOBALS[__FUNCTION__] = $domainName; + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + // Check wether we are installing function isInstalling () { // Determine wether we are installing @@ -289,9 +323,9 @@ function isInstalling () { // Check wether this script is installed function isInstalled () { // Do we have cache? - if (!isset($GLOBALS['is_installed'])) { + if (!isset($GLOBALS[__FUNCTION__])) { // Determine wether this script is installed - $GLOBALS['is_installed'] = ( + $GLOBALS[__FUNCTION__] = ( ( // First is config ( @@ -303,11 +337,11 @@ function isInstalled () { ) ) || ( // New config file found and loaded - isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php') + isIncludeReadable(getCachePath() . 'config-local.php') ) || ( ( // New config file found, but not yet read - isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php') + isIncludeReadable(getCachePath() . 'config-local.php') ) && ( ( // Only new config file is found @@ -321,19 +355,25 @@ function isInstalled () { } // END - if // Then use the cache - return $GLOBALS['is_installed']; + return $GLOBALS[__FUNCTION__]; } // Check wether an admin is registered function isAdminRegistered () { // Is cache set? - if (!isset($GLOBALS['is_admin_registered'])) { + if (!isset($GLOBALS[__FUNCTION__])) { // Simply check it - $GLOBALS['is_admin_registered'] = ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y')); + $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y')); } // END - if // Return it - return $GLOBALS['is_admin_registered']; + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether the hourly reset mode is active +function isHourlyResetEnabled () { + // Now simply check it + return ((isset($GLOBALS['hourly_enabled'])) && ($GLOBALS['hourly_enabled'] === true)); } // Checks wether the reset mode is active @@ -345,42 +385,61 @@ function isResetModeEnabled () { // Checks wether the debug mode is enabled function isDebugModeEnabled () { // Is cache set? - if (!isset($GLOBALS['is_debugmode_enabled'])) { + if (!isset($GLOBALS[__FUNCTION__])) { + // Simply check it + $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_MODE')) && (getConfig('DEBUG_MODE') == 'Y')); + } // END - if + + // Return it + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether the debug reset is enabled +function isDebugResetEnabled () { + // Is cache set? + if (!isset($GLOBALS[__FUNCTION__])) { // Simply check it - $GLOBALS['is_debugmode_enabled'] = ((isConfigEntrySet('DEBUG_MODE')) && (getConfig('DEBUG_MODE') == 'Y')); + $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_RESET')) && (getConfig('DEBUG_RESET') == 'Y')); } // END - if // Return it - return $GLOBALS['is_debugmode_enabled']; + return $GLOBALS[__FUNCTION__]; } // Checks wether SQL debugging is enabled function isSqlDebuggingEnabled () { // Is cache set? - if (!isset($GLOBALS['is_sql_debug_enabled'])) { + if (!isset($GLOBALS[__FUNCTION__])) { // Determine if SQL debugging is enabled - $GLOBALS['is_sql_debug_enabled'] = ((isConfigEntrySet('DEBUG_SQL')) && (getConfig('DEBUG_SQL') == 'Y')); + $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_SQL')) && (getConfig('DEBUG_SQL') == 'Y')); } // END - if // Return it - return $GLOBALS['is_sql_debug_enabled']; + return $GLOBALS[__FUNCTION__]; } // Checks wether we shall debug regular expressions function isDebugRegularExpressionEnabled () { // Is cache set? - if (!isset($GLOBALS['is_regular_exp_debug_enabled'])) { + if (!isset($GLOBALS[__FUNCTION__])) { // Simply check it - $GLOBALS['is_regular_exp_debug_enabled'] = ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y')); + $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y')); } // END - if // Return it - return $GLOBALS['is_regular_exp_debug_enabled']; + return $GLOBALS[__FUNCTION__]; } // Checks wether the cache instance is valid function isCacheInstanceValid () { - return ((isset($GLOBALS['cache_instance'])) && (is_object($GLOBALS['cache_instance']))); + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = ((isset($GLOBALS['cache_instance'])) && (is_object($GLOBALS['cache_instance']))); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; } // Copies a file from source to destination and verifies if that goes fine. @@ -399,7 +458,7 @@ function copyFileVerified ($source, $dest, $chmod = '') { // Is the target directory there? if (!isDirectory(dirname($dest))) { // Then abort here - debug_report_bug(__FUNCTION__, __LINE__, 'Cannot find directory ' . str_replace(getConfig('PATH'), '', dirname($dest)) . '.'); + debug_report_bug(__FUNCTION__, __LINE__, 'Cannot find directory ' . str_replace(getPath(), '', dirname($dest)) . '.'); } // END - if // Now try to copy it @@ -461,7 +520,7 @@ function changeMode ($FQFN, $mode) { } // END - if // Try to set them - chmod($FQFN, $mode); + return chmod($FQFN, $mode); } // Wrapper for unlink() @@ -499,23 +558,14 @@ function isConfigLocalLoaded () { // Checks wether a nickname or userid was entered and caches the result function isNicknameUsed ($userid) { - // Default is false - $isUsed = false; - // Is the cache there - if (isset($GLOBALS['is_nickname_used'][$userid])) { - // Then use it - $isUsed = $GLOBALS['is_nickname_used'][$userid]; - } else { + if (!isset($GLOBALS[__FUNCTION__][$userid])) { // Determine it - $isUsed = (('' . round($userid) . '') != $userid); - - // And write it to the cache - $GLOBALS['is_nickname_used'][$userid] = $isUsed; - } + $GLOBALS[__FUNCTION__][$userid] = ((!empty($userid)) && (('' . round($userid) . '') != $userid)); + } // END - if // Return the result - return $isUsed; + return $GLOBALS[__FUNCTION__][$userid]; } // Getter for 'what' value @@ -568,7 +618,7 @@ function getAction ($strict = true) { $action = null; // Is the value set? - if (isActionSet(($strict) && (getOutputMode() == 0))) { + if (isActionSet(($strict) && (isHtmlOutputMode()))) { // Then use it $action = $GLOBALS['action']; } // END - if @@ -634,18 +684,24 @@ function isModuleSet ($strict = false) { } // Getter for 'output_mode' value -function getOutputMode () { - // Default is null - $output_mode = null; +function getScriptOutputMode () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Default is null + $output_mode = null; + + // Is the value set? + if (isOutputModeSet(true)) { + // Then use it + $output_mode = $GLOBALS['output_mode']; + } // END - if - // Is the value set? - if (isOutputModeSet(true)) { - // Then use it - $output_mode = $GLOBALS['output_mode']; + // Store it in cache + $GLOBALS[__FUNCTION__] = $output_mode; } // END - if - // Return it - return $output_mode; + // Return cache + return $GLOBALS[__FUNCTION__]; } // Setter for 'output_mode' value @@ -661,7 +717,7 @@ function isOutputModeSet ($strict = false) { // Should we abort here? if (($strict === true) && ($isset === false)) { // Output backtrace - debug_report_bug(__FUNCTION__, __LINE__, 'output_mode is empty.'); + debug_report_bug(__FUNCTION__, __LINE__, 'Output mode is not set.'); } // END - if // Return it @@ -678,26 +734,41 @@ function isBlockModeEnabled () { // Abort if not set if (!isset($GLOBALS['block_mode'])) { // Needs to be fixed - debug_report_bug(__FUNCTION__ . ': block_mode is not set.'); + debug_report_bug(__FUNCTION__, __LINE__, 'Block_mode is not set.'); } // END - if // Return it return $GLOBALS['block_mode']; } -// Wrapper function for addPointsThroughReferalSystem() +/** + * Wrapper function for addPointsThroughReferalSystem(), you should generally + * avoid this function and use addPointsThroughReferalSystem() directly and add + * your special payment method entry to points_data instead. + * + * @param $subject A string-encoded subject for this add + * @param $userid The recipient (member) for given points + * @param $points Points to be added to member's account + * @return $added Wether the points has been added to the user's account + */ function addPointsDirectly ($subject, $userid, $points) { // Reset level here - unset($GLOBALS['ref_level']); + initReferalSystem(); // Call more complicated method (due to more parameters) - return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, false, 'direct'); + return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, 'DIRECT'); +} + +// Wrapper for redirectToUrl but URL comes from a configuration entry +function redirectToConfiguredUrl ($configEntry) { + // Load the URL + redirectToUrl(getConfig($configEntry)); } // 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()); + redirectToUrl('modules.php?module=index&code=' . getCode('MODULE_MEMBER_ONLY') . '&mod=' . getModule()); } // Wrapper function to redirect to current URL @@ -706,39 +777,41 @@ function redirectToRequestUri () { } // Wrapper function to redirect to de-refered URL -function redirectToDereferedUrl ($URL) { +function redirectToDereferedUrl ($url) { // Redirect to to - redirectToUrl(generateDerefererUrl($URL)); + 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)); + if (!isset($GLOBALS[__FUNCTION__][$ext_name][$version])) { + // Determine it + $GLOBALS[__FUNCTION__][$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]; + //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $ext_name . '=>' . $version . ':' . intval($GLOBALS[__FUNCTION__][$ext_name][$version])); + return $GLOBALS[__FUNCTION__][$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))); + if (!isset($GLOBALS[__FUNCTION__][$ext_name][$version])) { + // Determine it + $GLOBALS[__FUNCTION__][$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]; + //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $ext_name . '<' . $version . ':' . intval($GLOBALS[__FUNCTION__][$ext_name][$version])); + return $GLOBALS[__FUNCTION__][$ext_name][$version]; } // Set username @@ -751,7 +824,7 @@ function getUsername () { // User name set? if (!isset($GLOBALS['username'])) { // No, so it has to be a guest - $GLOBALS['username'] = getMessage('USERNAME_GUEST'); + $GLOBALS['username'] = '{--USERNAME_GUEST--}'; } // END - if // Return it @@ -761,25 +834,25 @@ function getUsername () { // Wrapper function for installation phase function isInstallationPhase () { // Do we have cache? - if (!isset($GLOBALS['installation_phase'])) { + if (!isset($GLOBALS[__FUNCTION__])) { // Determine it - $GLOBALS['installation_phase'] = ((!isInstalled()) || (isInstalling())); + $GLOBALS[__FUNCTION__] = ((!isInstalled()) || (isInstalling())); } // END - if // Return result - return $GLOBALS['installation_phase']; + return $GLOBALS[__FUNCTION__]; } // 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'])) { + if (!isset($GLOBALS[__FUNCTION__])) { // Simply check it - $GLOBALS['demo_mode_active'] = ((isExtensionActive('demo')) && (getSession('admin_login') == 'demo')); + $GLOBALS[__FUNCTION__] = ((isExtensionActive('demo')) && (getCurrentAdminLogin() == 'demo')); } // END - if // Return it - return $GLOBALS['demo_mode_active']; + return $GLOBALS[__FUNCTION__]; } // Getter for PHP caching value @@ -788,67 +861,145 @@ 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) - */ +function isAdminHashSet ($adminId) { + // Is the array there? if (!isset($GLOBALS['cache_array']['admin'])) { + // Missing array should be reported debug_report_bug(__FUNCTION__, __LINE__, 'Cache not set.'); } // END - if // Check for admin hash - return isset($GLOBALS['cache_array']['admin']['password'][$admin]); + return isset($GLOBALS['cache_array']['admin']['password'][$adminId]); } // Setter for admin hash -function setAdminHash ($admin, $hash) { - $GLOBALS['cache_array']['admin']['password'][$admin] = $hash; +function setAdminHash ($adminId, $hash) { + $GLOBALS['cache_array']['admin']['password'][$adminId] = $hash; +} + +// Getter for current admin login +function getCurrentAdminLogin () { + // Log debug message + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'called!'); + + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getAdminLogin(getCurrentAdminId()); + } // END - if + + // Return it + return $GLOBALS[__FUNCTION__]; +} + +// Setter for admin id (and current) +function setAdminId ($adminId) { + // Log debug message + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'adminId=' . $adminId); + + // Set session + $status = setSession('admin_id', bigintval($adminId)); + + // Set current id + setCurrentAdminId($adminId); + + // Return status + return $status; +} + +// Setter for admin_last +function setAdminLast ($adminLast) { + // Log debug message + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'adminLast=' . $adminLast); + + // Set session + $status = setSession('admin_last', $adminLast); + + // Return status + return $status; +} + +// Setter for admin_md5 +function setAdminMd5 ($adminMd5) { + // Log debug message + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'adminMd5=' . $adminMd5); + + // Set session + $status = setSession('admin_md5', $adminMd5); + + // Return status + return $status; +} + +// Getter for admin_md5 +function getAdminMd5 () { + // Log debug message + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'called!'); + + // Get session + return getSession('admin_md5'); } // Init user data array function initUserData () { // User id should not be zero - if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.'); + if (!isValidUserId(getCurrentUserId())) { + // Should be always valid + debug_report_bug(__FUNCTION__, __LINE__, 'Current user id is invalid: ' . getCurrentUserId()); + } // END - if // Init the user + unset($GLOBALS['is_userdata_valid'][getCurrentUserId()]); $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.'); + if (!isValidUserId(getCurrentUserId())) { + // Should be always valid + debug_report_bug(__FUNCTION__, __LINE__, 'Current user id is invalid: ' . getCurrentUserId()); + } // END - if + + // Default is empty + $data = null; + + if (isset($GLOBALS['user_data'][getCurrentUserId()][$column])) { + // Return the value + $data = $GLOBALS['user_data'][getCurrentUserId()][$column]; + } // END - if + + // Return it + return $data; +} + +// Checks wether given user data is set to 'Y' +function isUserDataEnabled ($column) { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__][getCurrentUserId()][$column])) { + // Determine it + $GLOBALS[__FUNCTION__][getCurrentUserId()][$column] = (getUserData($column) == 'Y'); + } // END - if - // Return the value - return $GLOBALS['user_data'][getCurrentUserId()][$column]; + // Return cache + return $GLOBALS[__FUNCTION__][getCurrentUserId()][$column]; } // Geter for whole user data array function getUserDataArray () { // Get user id - $uid = getCurrentUserId(); + $userid = getCurrentUserId(); - // User id should not be zero - if ($uid < 1) debug_report_bug(__FUNCTION__.': User id is zero.'); + // Is the current userid valid? + if (!isValidUserId($userid)) { + // Should be always valid + debug_report_bug(__FUNCTION__, __LINE__, 'Current user id is invalid: ' . $userid); + } // END - if // Get the whole array if found - if (isset($GLOBALS['user_data'][$uid])) { + if (isset($GLOBALS['user_data'][$userid])) { // Found, so return it - return $GLOBALS['user_data'][$uid]; + return $GLOBALS['user_data'][$userid]; } else { // Return empty array return array(); @@ -859,7 +1010,9 @@ function getUserDataArray () { // 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; + if (!isCurrentUserIdSet()) { + return false; + } // END - if // Is it cached? if (!isset($GLOBALS['is_userdata_valid'][getCurrentUserId()])) { @@ -894,33 +1047,42 @@ function getCurrentUserId () { // Checks if current userid is set function isCurrentUserIdSet () { - return ((isset($GLOBALS['current_userid'])) && ($GLOBALS['current_userid'] > 0)); + return ((isset($GLOBALS['current_userid'])) && (isValidUserId($GLOBALS['current_userid']))); } // Checks wether we are debugging template cache function isDebuggingTemplateCache () { - return (getConfig('DEBUG_TEMPLATE_CACHE') == 'Y'); + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = (getConfig('DEBUG_TEMPLATE_CACHE') == 'Y'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; } // Wrapper for fetchUserData() and getUserData() calls function getFetchedUserData ($keyColumn, $userid, $valueColumn) { + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'keyColumn=' . $keyColumn . ',userid=' . $userid . ',valueColumn=' . $valueColumn . ' - ENTERED!'); // Is it cached? - if (!isset($GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn])) { - // Default is 'guest' - $data = getMessage('USERNAME_GUEST'); + if (!isset($GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn])) { + // Default is NULL + $data = NULL; // Can we fetch the user data? - if (($userid > 0) && (fetchUserData($userid, $keyColumn))) { + if ((isValidUserId($userid)) && (fetchUserData($userid, $keyColumn))) { // Now get the data back $data = getUserData($valueColumn); } // END - if // Cache it - $GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn] = $data; + $GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn] = $data; } // END - if // Return it - return $GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn]; + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'keyColumn=' . $keyColumn . ',userid=' . $userid . ',valueColumn=' . $valueColumn . ',value=' . $GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn] . ' - EXIT!'); + return $GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn]; } // Wrapper for strpos() to ease porting from deprecated ereg() function @@ -941,11 +1103,6 @@ function ifFatalErrorsDetected () { 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; @@ -953,25 +1110,14 @@ function setHttpStatus ($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; -} + // Is the status set? + if (!isset($GLOBALS['http_status'])) { + // Abort here + debug_report_bug(__FUNCTION__, __LINE__, 'No HTTP status set!'); + } // END - if -// 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']; - } + // Return it + return $GLOBALS['http_status']; } /** @@ -989,6 +1135,9 @@ function isTemplateHtml () { * @access private */ function sendRawRedirect ($url) { + // Send helping header + setHttpStatus('302 Found'); + // always close the session session_write_close(); @@ -997,7 +1146,7 @@ function sendRawRedirect ($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) && + (strpos($_SERVER['GATEWAY_INTERFACE'], 'CGI') !== false) && (preg_match('|^Microsoft-IIS/(\d)\.\d$|', trim($_SERVER['SERVER_SOFTWARE']), $matches)) && ($matches[1] < 6)) { // Send the IIS header @@ -1013,40 +1162,1478 @@ function sendRawRedirect ($url) { // Determines the country of the given user id function determineCountry ($userid) { - // Default is 'invalid' - $country = 'invalid'; + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__][$userid])) { + // Default is 'invalid' + $GLOBALS[__FUNCTION__][$userid] = 'invalid'; - // Is extension country active? - if (isExtensionActive('country')) { - // Determine the right country code through the country id - $id = getUserData('country_code'); + // 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'); - } + // Then handle it over + $GLOBALS[__FUNCTION__][$userid] = generateCountryInfo($id); + } else { + // Get raw code from user data + $GLOBALS[__FUNCTION__][$userid] = getUserData('country'); + } + } // END - if - // Return it - return $country; + // Return cache + return $GLOBALS[__FUNCTION__][$userid]; } // "Getter" for total confirmed user accounts function getTotalConfirmedUser () { // Is it cached? - if (!isset($GLOBALS['total_confirmed_users'])) { + if (!isset($GLOBALS[__FUNCTION__])) { + // Then do it + if (isExtensionActive('user')) { + $GLOBALS[__FUNCTION__] = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true); + } else { + $GLOBALS[__FUNCTION__] = 0; + } + } // END - if + + // Return cached value + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for total unconfirmed user accounts +function getTotalUnconfirmedUser () { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__])) { + // Then do it + if (isExtensionActive('user')) { + $GLOBALS[__FUNCTION__] = countSumTotalData('UNCONFIRMED', 'user_data', 'userid', 'status', true); + } else { + $GLOBALS[__FUNCTION__] = 0; + } + } // END - if + + // Return cached value + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for total locked user accounts +function getTotalLockedUser () { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__])) { + // Then do it + if (isExtensionActive('user')) { + $GLOBALS[__FUNCTION__] = countSumTotalData('LOCKED', 'user_data', 'userid', 'status', true); + } else { + $GLOBALS[__FUNCTION__] = 0; + } + } // END - if + + // Return cached value + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for total locked user accounts +function getTotalRandomRefidUser () { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__])) { // Then do it - $GLOBALS['total_confirmed_users'] = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true); + if (isExtensionInstalledAndNewer('user', '0.3.4')) { + $GLOBALS[__FUNCTION__] = countSumTotalData('{?user_min_confirmed?}', 'user_data', 'userid', 'rand_confirmed', true, '', '>='); + } else { + $GLOBALS[__FUNCTION__] = 0; + } } // END - if // Return cached value - return $GLOBALS['total_confirmed_users']; + return $GLOBALS[__FUNCTION__]; +} + +// Is given userid valid? +function isValidUserId ($userid) { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__][$userid])) { + // Check it out + $GLOBALS[__FUNCTION__][$userid] = ((!is_null($userid)) && (!empty($userid)) && ($userid > 0)); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$userid]; +} + +// Encodes entities +function encodeEntities ($str) { + // Secure it first + $str = secureString($str, true, true); + + // Encode dollar sign as well + $str = str_replace('$', '$', $str); + + // Return it + return $str; +} + +// "Getter" for date from patch_ctime +function getDateFromRepository () { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__])) { + // Then set it + $GLOBALS[__FUNCTION__] = generateDateTime(getConfig('CURRENT_REPOSITORY_DATE'), '5'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for date/time from patch_ctime +function getDateTimeFromRepository () { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__])) { + // Then set it + $GLOBALS[__FUNCTION__] = generateDateTime(getConfig('CURRENT_REPOSITORY_DATE'), '2'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Getter for current year (default) +function getYear ($timestamp = null) { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { + // null is time() + if (is_null($timestamp)) { + $timestamp = time(); + } // END - if + + // Then create it + $GLOBALS[__FUNCTION__][$timestamp] = date('Y', $timestamp); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$timestamp]; +} + +// Getter for current month (default) +function getMonth ($timestamp = null) { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { + // If null is set, use time() + if (is_null($timestamp)) { + // Use time() which is current timestamp + $timestamp = time(); + } // END - if + + // Then create it + $GLOBALS[__FUNCTION__][$timestamp] = date('m', $timestamp); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$timestamp]; +} + +// Getter for current hour (default) +function getHour ($timestamp = null) { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { + // null is time() + if (is_null($timestamp)) { + $timestamp = time(); + } // END - if + + // Then create it + $GLOBALS[__FUNCTION__][$timestamp] = date('H', $timestamp); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$timestamp]; +} + +// Getter for current day (default) +function getDay ($timestamp = null) { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { + // null is time() + if (is_null($timestamp)) { + $timestamp = time(); + } // END - if + + // Then create it + $GLOBALS[__FUNCTION__][$timestamp] = date('d', $timestamp); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$timestamp]; +} + +// Getter for current week (default) +function getWeek ($timestamp = null) { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { + // null is time() + if (is_null($timestamp)) $timestamp = time(); + + // Then create it + $GLOBALS[__FUNCTION__][$timestamp] = date('W', $timestamp); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$timestamp]; +} + +// Getter for current short_hour (default) +function getShortHour ($timestamp = null) { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { + // null is time() + if (is_null($timestamp)) $timestamp = time(); + + // Then create it + $GLOBALS[__FUNCTION__][$timestamp] = date('G', $timestamp); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$timestamp]; +} + +// Getter for current long_hour (default) +function getLongHour ($timestamp = null) { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { + // null is time() + if (is_null($timestamp)) $timestamp = time(); + + // Then create it + $GLOBALS[__FUNCTION__][$timestamp] = date('H', $timestamp); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$timestamp]; +} + +// Getter for current second (default) +function getSecond ($timestamp = null) { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { + // null is time() + if (is_null($timestamp)) $timestamp = time(); + + // Then create it + $GLOBALS[__FUNCTION__][$timestamp] = date('s', $timestamp); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$timestamp]; +} + +// Getter for current minute (default) +function getMinute ($timestamp = null) { + // Is it cached? + if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { + // null is time() + if (is_null($timestamp)) $timestamp = time(); + + // Then create it + $GLOBALS[__FUNCTION__][$timestamp] = date('i', $timestamp); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$timestamp]; +} + +// Checks wether the title decoration is enabled +function isTitleDecorationEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Just check it + $GLOBALS[__FUNCTION__] = (getConfig('enable_title_deco') == 'Y'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether filter usage updates are enabled (expensive queries!) +function isFilterUsageUpdateEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('sql_patches', '0.6.0')) && (isConfigEntrySet('update_filter_usage')) && (getConfig('update_filter_usage') == 'Y')); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; } -// Wrapper for writing debug informations to the browser -function debugOutput ($message) { - outputHtml('
'); +// Checks wether debugging of weekly resets is enabled +function isWeeklyResetDebugEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_WEEKLY')) && (getConfig('DEBUG_WEEKLY') == 'Y')); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether debugging of monthly resets is enabled +function isMonthlyResetDebugEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_MONTHLY')) && (getConfig('DEBUG_MONTHLY') == 'Y')); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether displaying of debug SQLs are enabled +function isDisplayDebugSqlEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('other', '0.2.2')) && (getConfig('display_debug_sqls') == 'Y')); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether module title is enabled +function isModuleTitleEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = (getConfig('enable_mod_title') == 'Y'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether what title is enabled +function isWhatTitleEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = (getConfig('enable_what_title') == 'Y'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether stats are enabled +function ifStatsAreEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Then determine it + $GLOBALS[__FUNCTION__] = (getConfig('stats_enabled') == 'Y'); + } // END - if + + // Return cached value + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether admin-notification of certain user actions is enabled +function isAdminNotificationEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = (getConfig('admin_notify') == 'Y'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether random referal id selection is enabled +function isRandomReferalIdEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('user', '0.3.4')) && (getConfig('select_user_zero_refid') == 'Y')); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for default language +function getDefaultLanguage () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('DEFAULT_LANG'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for default referal id +function getDefRefid () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('def_refid'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for path +function getPath () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('PATH'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for url +function getUrl () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('URL'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for cache_path +function getCachePath () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('CACHE_PATH'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for secret_key +function getSecretKey () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('secret_key'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for SITE_KEY +function getSiteKey () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('SITE_KEY'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for DATE_KEY +function getDateKey () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('DATE_KEY'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for master_salt +function getMasterSalt () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('master_salt'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for prime +function getPrime () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('_PRIME'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for encrypt_seperator +function getEncryptSeperator () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('ENCRYPT_SEPERATOR'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for mysql_prefix +function getMysqlPrefix () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('_MYSQL_PREFIX'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for table_type +function getTableType () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('_TABLE_TYPE'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for salt_length +function getSaltLength () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('salt_length'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for output_mode +function getOutputMode () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('OUTPUT_MODE'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for full_version +function getFullVersion () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('FULL_VERSION'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for title +function getTitle () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('TITLE'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for curr_svn_revision +function getCurrentRepositoryRevision () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('CURRENT_REPOSITORY_REVISION'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for server_url +function getServerUrl () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('SERVER_URL'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for mt_word +function getMtWord () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('mt_word'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for mt_word2 +function getMtWord2 () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('mt_word2'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for main_title +function getMainTitle () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('MAIN_TITLE'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for file_hash +function getFileHash () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('file_hash'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for pass_scramble +function getPassScramble () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('pass_scramble'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for ap_inactive_since +function getApInactiveSince () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('ap_inactive_since'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for user_min_confirmed +function getUserMinConfirmed () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('user_min_confirmed'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for auto_purge +function getAutoPurge () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('auto_purge'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for bonus_userid +function getBonusUserid () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('bonus_userid'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for ap_inactive_time +function getApInactiveTime () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('ap_inactive_time'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for ap_dm_timeout +function getApDmTimeout () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('ap_dm_timeout'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for ap_tasks_time +function getApTasksTime () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('ap_tasks_time'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for ap_unconfirmed_time +function getApUnconfirmedTime () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('ap_unconfirmed_time'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for points +function getPoints () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('POINTS'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for slogan +function getSlogan () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('SLOGAN'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for copy +function getCopy () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('COPY'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for webmaster +function getWebmaster () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('WEBMASTER'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for sql_count +function getSqlCount () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('sql_count'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for num_templates +function getNumTemplates () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('num_templates'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for dns_cache_timeout +function getDnsCacheTimeout () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('dns_cache_timeout'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for menu_blur_spacer +function getMenuBlurSpacer () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('menu_blur_spacer'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for points_register +function getPointsRegister () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('points_register'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for points_ref +function getPointsRef () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('points_ref'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for ref_payout +function getRefPayout () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('ref_payout'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for online_timeout +function getOnlineTimeout () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('online_timeout'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for index_home +function getIndexHome () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('index_home'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for one_day +function getOneDay () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('ONE_DAY'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for activate_xchange +function getActivateXchange () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('activate_xchange'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for img_type +function getImgType () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('img_type'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for code_length +function getCodeLength () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('code_length'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for least_cats +function getLeastCats () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('least_cats'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for pass_len +function getPassLen () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('pass_len'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for admin_menu +function getAdminMenu () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('admin_menu'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for last_month +function getLastMonth () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('last_month'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for max_send +function getMaxSend () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('max_send'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for mails_page +function getMailsPage () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('mails_page'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for rand_no +function getRandNo () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('rand_no'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for __DB_NAME +function getDbName () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('__DB_NAME'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for DOMAIN +function getDomain () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('DOMAIN'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for proxy_username +function getProxyUsername () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('proxy_username'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for proxy_password +function getProxyPassword () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('proxy_password'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for proxy_host +function getProxyHost () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('proxy_host'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for proxy_port +function getProxyPort () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('proxy_port'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for SMTP_HOSTNAME +function getSmtpHostname () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('SMTP_HOSTNAME'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for SMTP_USER +function getSmtpUser () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('SMTP_USER'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for SMTP_PASSWORD +function getSmtpPassword () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('SMTP_PASSWORD'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for points_word +function getPointsWord () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('points_word'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for profile_lock +function getProfileLock () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('profile_lock'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for url_tlock +function getUrlTlock () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('url_tlock'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether proxy configuration is used +function isProxyUsed () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('sql_patches', '0.4.3')) && (getConfig('proxy_host') != '') && (getConfig('proxy_port') > 0)); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether POST data contains selections +function ifPostContainsSelections ($element = 'sel') { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__][$element])) { + // Determine it + $GLOBALS[__FUNCTION__][$element] = ((isPostRequestParameterSet($element)) && (countPostSelection($element) > 0)); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$element]; +} + +// Checks wether verbose_sql is Y and returns true/false if so +function isVerboseSqlEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('sql_patches', '0.0.7')) && (getConfig('verbose_sql') == 'Y')); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for total user points +function getTotalPoints ($userid) { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__][$userid])) { + // Init array for filter chain + $data = array( + 'userid' => $userid, + 'points' => 0 + ); + + // Run filter chain for getting more point values + $data = runFilterChain('get_total_points', $data); + + // Determine it + $GLOBALS[__FUNCTION__][$userid] = $data['points'] - countSumTotalData($userid, 'user_data', 'used_points'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$userid]; +} + +// Wrapper to check if url_blacklist is enabled +function isUrlBlacklistEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = (getConfig('url_blacklist') == 'Y'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether direct payment is allowed in configuration +function isDirectPaymentEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = (getConfig('allow_direct_pay') == 'Y'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Wrapper to check if current task is for extension (not update) +function isExtensionTask ($content) { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__][$content['task_type'] . '_' . $content['infos']])) { + // Determine it + $GLOBALS[__FUNCTION__][$content['task_type'] . '_' . $content['infos']] = (($content['task_type'] == 'EXTENSION') && (isExtensionNameValid($content['infos'])) && (!isExtensionInstalled($content['infos']))); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$content['task_type'] . '_' . $content['infos']]; +} + +// Wrapper to check if output mode is CSS +function isCssOutputMode () { + // Determine it + return (getScriptOutputMode() == 1); +} + +// Wrapper to check if output mode is HTML +function isHtmlOutputMode () { + // Determine it + return (getScriptOutputMode() == 0); +} + +// Wrapper to check if output mode is RAW +function isRawOutputMode () { + // Determine it + return (getScriptOutputMode() == -1); +} + +// Wrapper to generate a user email link +function generateWrappedUserEmailLink ($email) { + // Just call the inner function + return generateEmailLink($email, 'user_data'); +} + +// Wrapper to check if user points are locked +function ifUserPointsLocked ($userid) { + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - ENTERED!'); + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__][$userid])) { + // Determine it + $GLOBALS[__FUNCTION__][$userid] = ((getFetchedUserData('userid', $userid, 'ref_payout') > 0) && (!isDirectPaymentEnabled())); + } // END - if + + // Return cache + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',locked=' . intval($GLOBALS[__FUNCTION__][$userid]) . ' - EXIT!'); + return $GLOBALS[__FUNCTION__][$userid]; +} + +// Appends a line to an existing file or creates it instantly with given content. +// This function does always add a new-line character to every line. +function appendLineToFile ($file, $line) { + $fp = fopen($file, 'a') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot write to file ' . basename($file) . '!'); + fwrite($fp, $line . "\n"); + fclose($fp); +} + +// Wrapper for changeDataInFile() but with full path added +function changeDataInInclude ($FQFN, $comment, $prefix, $suffix, $inserted, $seek=0) { + // Add full path + $FQFN = getPath() . $FQFN; + + // Call inner function + return changeDataInFile($FQFN, $comment, $prefix, $suffix, $inserted, $seek); +} + +// Wrapper for changing entries in config-local.php +function changeDataInLocalConfigurationFile ($comment, $prefix, $suffix, $inserted, $seek = 0) { + // Call the inner function + return changeDataInInclude(getCachePath() . 'config-local.php', $comment, $prefix, $suffix, $inserted, $seek); +} + +// Shortens ucfirst(strtolower()) calls +function firstCharUpperCase ($str) { + return ucfirst(strtolower($str)); +} + +// Shortens calls with configuration entry as first argument (the second will become obsolete in the future) +function createConfigurationTimeSelections ($configEntry, $stamps, $align = 'center') { + // Get the configuration entry + $configValue = getConfig($configEntry); + + // Call inner method + return createTimeSelections($configValue, $configEntry, $stamps, $align); +} + +// Shortens converting of German comma to Computer's version in POST data +function convertCommaToDotInPostData ($postEntry) { + // Read and convert given entry + $postValue = convertCommaToDot(postRequestParameter($postEntry)); + + // ... and set it again + setPostRequestParameter($postEntry, $postValue); +} + +// Converts German commas to Computer's version in all entries +function convertCommaToDotInPostDataArray ($postEntries) { + // Replace german decimal comma with computer decimal dot + foreach ($postEntries as $entry) { + // Is the entry there? + if (isPostRequestParameterSet($entry)) { + // Then convert it + convertCommaToDotInPostData($entry); + } // END - if + } // END - foreach +} + +/** + * Parses a string into a US formated float variable, taken from user comments + * from PHP documentation website. + * + * @param $floatString A string holding a float expression + * @return $float Corresponding float variable + * @author chris