X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fwrapper-functions.php;h=5195c0c1e7c716abe6bffe17f24367b875cb2994;hp=02c2e4c09d8cc0f5db17252273b83f3ce15d3586;hb=f0e095401c24cf94f760de965c39f7ae35d32d25;hpb=03486c08011d4c233e2455c8e5335ecc0818333f diff --git a/inc/wrapper-functions.php b/inc/wrapper-functions.php index 02c2e4c09d..5195c0c1e7 100644 --- a/inc/wrapper-functions.php +++ b/inc/wrapper-functions.php @@ -17,7 +17,7 @@ * -------------------------------------------------------------------- * * Copyright (c) 2003 - 2009 by Roland Haeder * * Copyright (c) 2009 - 2011 by Mailer Developer Team * - * For more information visit: http://www.mxchange.org * + * For more information visit: http://mxchange.org * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * @@ -127,15 +127,13 @@ function clearOutputBuffer () { } // Encode strings -// @TODO Implement $compress -function encodeString ($str, $compress = true) { +function encodeString ($str) { $str = urlencode(base64_encode(compileUriCode($str))); return $str; } // Decode strings encoded with encodeString() -// @TODO Implement $decompress -function decodeString ($str, $decompress = true) { +function decodeString ($str) { $str = compileUriCode(base64_decode(urldecode(compileUriCode($str)))); return $str; } @@ -172,7 +170,7 @@ function isFileReadable ($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))); + $GLOBALS['file_readable'][$FQFN] = ((is_file($FQFN)) && (file_exists($FQFN)) && (is_readable($FQFN))); } // END - if // Return result @@ -313,7 +311,7 @@ function isInstalling () { // Determine wether we are installing if (!isset($GLOBALS['mailer_installing'])) { // Check URL (css.php/js.php need this) - $GLOBALS['mailer_installing'] = isGetRequestParameterSet('installing'); + $GLOBALS['mailer_installing'] = isGetRequestElementSet('installing'); } // END - if // Return result @@ -432,7 +430,14 @@ function isDebugRegularExpressionEnabled () { // 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. @@ -476,33 +481,6 @@ function copyFileVerified ($source, $dest, $chmod = '') { return $status; } -// 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(__FUNCTION__, __LINE__, 'Headers already sent!'); - } // END - if - - // 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() // @TODO Do some more sanity check here function changeMode ($FQFN, $mode) { @@ -535,9 +513,9 @@ function removeFile ($FQFN) { // Wrapper for $_POST['sel'] function countPostSelection ($element = 'sel') { // Is it set? - if (isPostRequestParameterSet($element)) { + if (isPostRequestElementSet($element)) { // Return counted elements - return countSelection(postRequestParameter($element)); + return countSelection(postRequestElement($element)); } else { // Return zero if not found return 0; @@ -554,7 +532,7 @@ function isNicknameUsed ($userid) { // Is the cache there if (!isset($GLOBALS[__FUNCTION__][$userid])) { // Determine it - $GLOBALS[__FUNCTION__][$userid] = (('' . round($userid) . '') != $userid); + $GLOBALS[__FUNCTION__][$userid] = ((!empty($userid)) && (('' . round($userid) . '') != $userid) && ($userid != 'NULL')); } // END - if // Return the result @@ -562,14 +540,14 @@ function isNicknameUsed ($userid) { } // Getter for 'what' value -function getWhat () { +function getWhat ($strict = true) { // Default is null - $what = null; + $what = NULL; // Is the value set? - if (isWhatSet(true)) { + if (isWhatSet($strict)) { // Then use it - $what = $GLOBALS['what']; + $what = $GLOBALS['__what']; } // END - if // Return it @@ -578,7 +556,7 @@ function getWhat () { // Setter for 'what' value function setWhat ($newWhat) { - $GLOBALS['what'] = SQL_ESCAPE($newWhat); + $GLOBALS['__what'] = $newWhat; } // Setter for 'what' from configuration @@ -593,7 +571,7 @@ function setWhatFromConfig ($configEntry) { // Checks wether what is set and optionally aborts on miss function isWhatSet ($strict = false) { // Check for it - $isset = isset($GLOBALS['what']); + $isset = (isset($GLOBALS['__what']) && (!empty($GLOBALS['__what']))); // Should we abort here? if (($strict === true) && ($isset === false)) { @@ -608,12 +586,12 @@ function isWhatSet ($strict = false) { // Getter for 'action' value function getAction ($strict = true) { // Default is null - $action = null; + $action = NULL; // Is the value set? if (isActionSet(($strict) && (isHtmlOutputMode()))) { // Then use it - $action = $GLOBALS['action']; + $action = $GLOBALS['__action']; } // END - if // Return it @@ -622,13 +600,13 @@ function getAction ($strict = true) { // Setter for 'action' value function setAction ($newAction) { - $GLOBALS['action'] = SQL_ESCAPE($newAction); + $GLOBALS['__action'] = $newAction; } // Checks wether action is set and optionally aborts on miss function isActionSet ($strict = false) { // Check for it - $isset = ((isset($GLOBALS['action'])) && (!empty($GLOBALS['action']))); + $isset = ((isset($GLOBALS['__action'])) && (!empty($GLOBALS['__action']))); // Should we abort here? if (($strict === true) && ($isset === false)) { @@ -643,12 +621,12 @@ function isActionSet ($strict = false) { // Getter for 'module' value function getModule ($strict = true) { // Default is null - $module = null; + $module = NULL; // Is the value set? if (isModuleSet($strict)) { // Then use it - $module = $GLOBALS['module']; + $module = $GLOBALS['__module']; } // END - if // Return it @@ -658,22 +636,22 @@ function getModule ($strict = true) { // Setter for 'module' value function setModule ($newModule) { // Secure it and make all modules lower-case - $GLOBALS['module'] = SQL_ESCAPE(strtolower($newModule)); + $GLOBALS['__module'] = strtolower($newModule); } // Checks wether module is set and optionally aborts on miss function isModuleSet ($strict = false) { // Check for it - $isset = (!empty($GLOBALS['module'])); + $isset = ((isset($GLOBALS['__module'])) && (!empty($GLOBALS['__module']))); // Should we abort here? if (($strict === true) && ($isset === false)) { // Output backtrace - debug_report_bug(__FUNCTION__, __LINE__, 'module is empty.'); + debug_report_bug(__FUNCTION__, __LINE__, 'Module is empty.'); } // END - if // Return it - return (($isset === true) && ($GLOBALS['module'] != 'unknown')) ; + return (($isset === true) && ($GLOBALS['__module'] != 'unknown')) ; } // Getter for 'output_mode' value @@ -681,7 +659,7 @@ function getScriptOutputMode () { // Do we have cache? if (!isset($GLOBALS[__FUNCTION__])) { // Default is null - $output_mode = null; + $output_mode = NULL; // Is the value set? if (isOutputModeSet(true)) { @@ -699,7 +677,9 @@ function getScriptOutputMode () { // Setter for 'output_mode' value function setOutputMode ($newOutputMode) { - $GLOBALS['output_mode'] = (int) $newOutputMode; + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'output_mode=' . $newOutputMode); + $GLOBALS['output_mode'] = (int) $newOutputMode; + $GLOBALS['getScriptOutputMode'] = (int) $newOutputMode; } // Checks wether output_mode is set and optionally aborts on miss @@ -734,13 +714,22 @@ function isBlockModeEnabled () { return $GLOBALS['block_mode']; } -// Wrapper function for addPointsThroughReferalSystem() +/** + * Wrapper function for addPointsThroughReferralSystem(), you should generally + * avoid this function and use addPointsThroughReferralSystem() 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']); + initReferralSystem(); // Call more complicated method (due to more parameters) - return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, 'direct'); + return addPointsThroughReferralSystem($subject, $userid, $points, false, 0, 'DIRECT'); } // Wrapper for redirectToUrl but URL comes from a configuration entry @@ -752,7 +741,7 @@ function redirectToConfiguredUrl ($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 @@ -761,9 +750,9 @@ 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 @@ -933,6 +922,7 @@ function initUserData () { } // END - if // Init the user + unset($GLOBALS['is_userdata_valid'][getCurrentUserId()]); $GLOBALS['user_data'][getCurrentUserId()] = array(); } @@ -944,8 +934,28 @@ function getUserData ($column) { debug_report_bug(__FUNCTION__, __LINE__, 'Current user id is invalid: ' . getCurrentUserId()); } // END - if - // Return the value - return $GLOBALS['user_data'][getCurrentUserId()][$column]; + // 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 cache + return $GLOBALS[__FUNCTION__][getCurrentUserId()][$column]; } // Geter for whole user data array @@ -973,7 +983,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()])) { @@ -1025,10 +1037,11 @@ function isDebuggingTemplateCache () { // 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[__FUNCTION__][$userid][$keyColumn][$valueColumn])) { - // Default is 'guest' - $data = '{--USERNAME_GUEST--}'; + // Default is NULL + $data = NULL; // Can we fetch the user data? if ((isValidUserId($userid)) && (fetchUserData($userid, $keyColumn))) { @@ -1041,6 +1054,7 @@ function getFetchedUserData ($keyColumn, $userid, $valueColumn) { } // END - if // Return it + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'keyColumn=' . $keyColumn . ',userid=' . $userid . ',valueColumn=' . $valueColumn . ',value=' . $GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn] . ' - EXIT!'); return $GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn]; } @@ -1094,6 +1108,15 @@ function getHttpStatus () { * @access private */ function sendRawRedirect ($url) { + // Clear output buffer + clearOutputBuffer(); + + // Clear own output buffer + $GLOBALS['output'] = ''; + + // To make redirects working (no content type), output mode must be raw + setOutputMode(-1); + // Send helping header setHttpStatus('302 Found'); @@ -1105,14 +1128,14 @@ 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) && + (isInString('CGI', $_SERVER['GATEWAY_INTERFACE'])) && (preg_match('|^Microsoft-IIS/(\d)\.\d$|', trim($_SERVER['SERVER_SOFTWARE']), $matches)) && ($matches[1] < 6)) { // Send the IIS header - sendHeader('Refresh: 0;url=' . $url); + addHttpHeader('Refresh: 0;url=' . $url); } else { // Send generic header - sendHeader('Location: ' . $url); + addHttpHeader('Location: ' . $url); } // Shutdown here @@ -1148,7 +1171,11 @@ function getTotalConfirmedUser () { // Is it cached? if (!isset($GLOBALS[__FUNCTION__])) { // Then do it - $GLOBALS[__FUNCTION__] = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true); + if (isExtensionActive('user')) { + $GLOBALS[__FUNCTION__] = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true); + } else { + $GLOBALS[__FUNCTION__] = 0; + } } // END - if // Return cached value @@ -1160,7 +1187,11 @@ function getTotalUnconfirmedUser () { // Is it cached? if (!isset($GLOBALS[__FUNCTION__])) { // Then do it - $GLOBALS[__FUNCTION__] = countSumTotalData('UNCONFIRMED', 'user_data', 'userid', 'status', true); + if (isExtensionActive('user')) { + $GLOBALS[__FUNCTION__] = countSumTotalData('UNCONFIRMED', 'user_data', 'userid', 'status', true); + } else { + $GLOBALS[__FUNCTION__] = 0; + } } // END - if // Return cached value @@ -1172,7 +1203,27 @@ function getTotalLockedUser () { // Is it cached? if (!isset($GLOBALS[__FUNCTION__])) { // Then do it - $GLOBALS[__FUNCTION__] = countSumTotalData('LOCKED', 'user_data', 'userid', 'status', true); + 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 + 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 @@ -1181,6 +1232,12 @@ function getTotalLockedUser () { // Is given userid valid? function isValidUserId ($userid) { + // Handle NULL + if (is_null($userid)) { + // Do not handle this as of below isset() will always return false + return false; + } // END - if + // Do we have cache? if (!isset($GLOBALS[__FUNCTION__][$userid])) { // Check it out @@ -1204,11 +1261,23 @@ function encodeEntities ($str) { } // "Getter" for date from patch_ctime -function getDateFromPatchTime () { +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('patch_ctime'), '5'); + $GLOBALS[__FUNCTION__] = generateDateTime(getConfig('CURRENT_REPOSITORY_DATE'), '2'); } // END - if // Return cache @@ -1216,7 +1285,7 @@ function getDateFromPatchTime () { } // Getter for current year (default) -function getYear ($timestamp = null) { +function getYear ($timestamp = NULL) { // Is it cached? if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { // null is time() @@ -1233,7 +1302,7 @@ function getYear ($timestamp = null) { } // Getter for current month (default) -function getMonth ($timestamp = null) { +function getMonth ($timestamp = NULL) { // Is it cached? if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { // If null is set, use time() @@ -1251,7 +1320,7 @@ function getMonth ($timestamp = null) { } // Getter for current hour (default) -function getHour ($timestamp = null) { +function getHour ($timestamp = NULL) { // Is it cached? if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { // null is time() @@ -1268,7 +1337,7 @@ function getHour ($timestamp = null) { } // Getter for current day (default) -function getDay ($timestamp = null) { +function getDay ($timestamp = NULL) { // Is it cached? if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { // null is time() @@ -1285,7 +1354,7 @@ function getDay ($timestamp = null) { } // Getter for current week (default) -function getWeek ($timestamp = null) { +function getWeek ($timestamp = NULL) { // Is it cached? if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { // null is time() @@ -1300,7 +1369,7 @@ function getWeek ($timestamp = null) { } // Getter for current short_hour (default) -function getShortHour ($timestamp = null) { +function getShortHour ($timestamp = NULL) { // Is it cached? if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { // null is time() @@ -1315,7 +1384,7 @@ function getShortHour ($timestamp = null) { } // Getter for current long_hour (default) -function getLongHour ($timestamp = null) { +function getLongHour ($timestamp = NULL) { // Is it cached? if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { // null is time() @@ -1330,7 +1399,7 @@ function getLongHour ($timestamp = null) { } // Getter for current second (default) -function getSecond ($timestamp = null) { +function getSecond ($timestamp = NULL) { // Is it cached? if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { // null is time() @@ -1345,7 +1414,7 @@ function getSecond ($timestamp = null) { } // Getter for current minute (default) -function getMinute ($timestamp = null) { +function getMinute ($timestamp = NULL) { // Is it cached? if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { // null is time() @@ -1444,11 +1513,11 @@ function isWhatTitleEnabled () { } // Checks wether stats are enabled -function ifStatsAreEnabled () { +function ifInternalStatsEnabled () { // Do we have cache? if (!isset($GLOBALS[__FUNCTION__])) { // Then determine it - $GLOBALS[__FUNCTION__] = (getConfig('stats_enabled') == 'Y'); + $GLOBALS[__FUNCTION__] = (getConfig('internal_stats') == 'Y'); } // END - if // Return cached value @@ -1467,8 +1536,8 @@ function isAdminNotificationEnabled () { return $GLOBALS[__FUNCTION__]; } -// Checks wether random referal id selection is enabled -function isRandomReferalIdEnabled () { +// Checks wether random referral id selection is enabled +function isRandomReferralIdEnabled () { // Do we have cache? if (!isset($GLOBALS[__FUNCTION__])) { // Determine it @@ -1491,7 +1560,7 @@ function getDefaultLanguage () { return $GLOBALS[__FUNCTION__]; } -// "Getter" for default referal id +// "Getter" for default referral id function getDefRefid () { // Do we have cache? if (!isset($GLOBALS[__FUNCTION__])) { @@ -1599,12 +1668,12 @@ function getPrime () { return $GLOBALS[__FUNCTION__]; } -// "Getter" for encrypt_seperator -function getEncryptSeperator () { +// "Getter" for encrypt_separator +function getEncryptSeparator () { // Do we have cache? if (!isset($GLOBALS[__FUNCTION__])) { // Determine it - $GLOBALS[__FUNCTION__] = getConfig('ENCRYPT_SEPERATOR'); + $GLOBALS[__FUNCTION__] = getConfig('ENCRYPT_SEPARATOR'); } // END - if // Return cache @@ -2295,6 +2364,102 @@ function getUrlTlock () { return $GLOBALS[__FUNCTION__]; } +// "Getter" for title_left +function getTitleLeft () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('title_left'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for title_right +function getTitleRight () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('title_right'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// "Getter" for title_middle +function getTitleMiddle () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = getConfig('title_middle'); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__]; +} + +// Getter for 'check_double_email' +function getCheckDoubleEmail () { + // Is the cache entry set? + if (!isset($GLOBALS[__FUNCTION__])) { + // No, so determine it + $GLOBALS[__FUNCTION__] = getConfig('check_double_email'); + } // END - if + + // Return cached entry + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether 'check_double_email' is 'Y' +function isCheckDoubleEmailEnabled () { + // Is the cache entry set? + if (!isset($GLOBALS[__FUNCTION__])) { + // No, so determine it + $GLOBALS[__FUNCTION__] = (getCheckDoubleEmail() == 'Y'); + } // END - if + + // Return cached entry + return $GLOBALS[__FUNCTION__]; +} + +// Getter for 'display_home_in_index' +function getDisplayHomeInIndex () { + // Is the cache entry set? + if (!isset($GLOBALS[__FUNCTION__])) { + // No, so determine it + $GLOBALS[__FUNCTION__] = getConfig('display_home_in_index'); + } // END - if + + // Return cached entry + return $GLOBALS[__FUNCTION__]; +} + +// Checks wether 'display_home_in_index' is 'Y' +function isDisplayHomeInIndexEnabled () { + // Is the cache entry set? + if (!isset($GLOBALS[__FUNCTION__])) { + // No, so determine it + $GLOBALS[__FUNCTION__] = (getDisplayHomeInIndex() == 'Y'); + } // END - if + + // Return cached entry + return $GLOBALS[__FUNCTION__]; +} + +// Getter for 'admin_menu_javascript' +function getAdminMenuJavascript () { + // Is the cache entry set? + if (!isset($GLOBALS[__FUNCTION__])) { + // No, so determine it + $GLOBALS[__FUNCTION__] = getConfig('admin_menu_javascript'); + } // END - if + + // Return cached entry + return $GLOBALS[__FUNCTION__]; +} + // Checks wether proxy configuration is used function isProxyUsed () { // Do we have cache? @@ -2312,7 +2477,7 @@ function ifPostContainsSelections ($element = 'sel') { // Do we have cache? if (!isset($GLOBALS[__FUNCTION__][$element])) { // Determine it - $GLOBALS[__FUNCTION__][$element] = ((isPostRequestParameterSet($element)) && (countPostSelection($element) > 0)); + $GLOBALS[__FUNCTION__][$element] = ((isPostRequestElementSet($element)) && (countPostSelection($element) > 0)); } // END - if // Return cache @@ -2335,8 +2500,17 @@ function isVerboseSqlEnabled () { 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] = countSumTotalData($userid, 'user_points', 'points') - countSumTotalData($userid, 'user_data', 'used_points'); + $GLOBALS[__FUNCTION__][$userid] = $data['points'] - countSumTotalData($userid, 'user_data', 'used_points'); } // END - if // Return cache @@ -2367,6 +2541,18 @@ function isDirectPaymentEnabled () { return $GLOBALS[__FUNCTION__]; } +// Checks wether JavaScript-based admin menu is enabled +function isAdminMenuJavascriptEnabled () { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__])) { + // Determine it + $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('sql_patches', '0.8.7')) && (getConfig('admin_menu_javascript') == '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? @@ -2397,6 +2583,18 @@ function isRawOutputMode () { return (getScriptOutputMode() == -1); } +// Wrapper to check if output mode is AJAX +function isAjaxOutputMode () { + // Determine it + return (getScriptOutputMode() == -2); +} + +// Wrapper to check if output mode is image +function isImageOutputMode () { + // Determine it + return (getScriptOutputMode() == -3); +} + // Wrapper to generate a user email link function generateWrappedUserEmailLink ($email) { // Just call the inner function @@ -2405,6 +2603,7 @@ function generateWrappedUserEmailLink ($email) { // 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 @@ -2412,6 +2611,7 @@ function ifUserPointsLocked ($userid) { } // END - if // Return cache + //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ',locked=' . intval($GLOBALS[__FUNCTION__][$userid]) . ' - EXIT!'); return $GLOBALS[__FUNCTION__][$userid]; } @@ -2424,18 +2624,18 @@ function appendLineToFile ($file, $line) { } // Wrapper for changeDataInFile() but with full path added -function changeDataInInclude ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) { +function changeDataInInclude ($FQFN, $comment, $prefix, $suffix, $inserted, $seek=0) { // Add full path $FQFN = getPath() . $FQFN; // Call inner function - return changeDataInFile($FQFN, $comment, $prefix, $suffix, $DATA, $seek); + return changeDataInFile($FQFN, $comment, $prefix, $suffix, $inserted, $seek); } // Wrapper for changing entries in config-local.php -function changeDataInLocalConfigurationFile ($comment, $prefix, $suffix, $DATA, $seek = 0) { +function changeDataInLocalConfigurationFile ($comment, $prefix, $suffix, $inserted, $seek = 0) { // Call the inner function - return changeDataInInclude(getCachePath() . 'config-local.php', $comment, $prefix, $suffix, $DATA, $seek); + return changeDataInInclude(getCachePath() . 'config-local.php', $comment, $prefix, $suffix, $inserted, $seek); } // Shortens ucfirst(strtolower()) calls @@ -2455,23 +2655,103 @@ function createConfigurationTimeSelections ($configEntry, $stamps, $align = 'cen // Shortens converting of German comma to Computer's version in POST data function convertCommaToDotInPostData ($postEntry) { // Read and convert given entry - $postValue = convertCommaToDot(postRequestParameter($postEntry)); + $postValue = convertCommaToDot(postRequestElement($postEntry)); // ... and set it again - setPostRequestParameter($postEntry, $postValue); + setPostRequestElement($postEntry, $postValue); } // Converts German commas to Computer's version in all entries -function convertCommaToDotInPostDataArray (array $postEntries) { +function convertCommaToDotInPostDataArray ($postEntries) { // Replace german decimal comma with computer decimal dot foreach ($postEntries as $entry) { // Is the entry there? - if (isPostRequestParameterSet($entry)) { + if (isPostRequestElementSet($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 chrisgeorgakopouloscom + * @link http://de.php.net/manual/en/function.floatval.php#92563 + */ +function parseFloat ($floatString){ + // Load locale info + $LocaleInfo = localeconv(); + + // Remove thousand separators + $floatString = str_replace($LocaleInfo['mon_thousands_sep'] , '' , $floatString); + + // Convert decimal point + $floatString = str_replace($LocaleInfo['mon_decimal_point'] , '.', $floatString); + + // Return float value of converted string + return floatval($floatString); +} + +// Generates a YES/NO option list from given default +function generateYesNoOptionList ($defaultValue = '') { + // Generate it + return generateOptionList('/ARRAY/', array('Y', 'N'), array('{--YES--}', '{--NO--}'), $defaultValue); +} + +// "Getter" for total available receivers +function getTotalReceivers ($mode = 'normal') { + // Get num rows + $numRows = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true, ' AND `receive_mails` > 0' . runFilterChain('exclude_users', $mode)); + + // Return value + return $numRows; +} + +// Wrapper "getter" to get total unconfirmed mails for given userid +function getTotalUnconfirmedMails ($userid) { + // Do we have cache? + if (!isset($GLOBALS[__FUNCTION__][$userid])) { + // Determine it + $GLOBALS[__FUNCTION__][$userid] = countSumTotalData($userid, 'user_links', 'id', 'userid', true); + } // END - if + + // Return cache + return $GLOBALS[__FUNCTION__][$userid]; +} + +// Checks wether 'mailer_theme' was found in session +function isMailerThemeSet () { + // Check session + return isSessionVariableSet('mailer_theme'); +} + +/** + * Setter for theme in session (This setter does return the success of + * setSession() which is required e.g. for destroySponsorSession(). + */ +function setMailerTheme ($newTheme) { + // Set it in session + return setSession('mailer_theme', $newTheme); +} + +/** + * Getter for theme from session (This getter does return 'mailer_theme' from + * session data or throws an error if not possible + */ +function getMailerTheme () { + // Is 'mailer_theme' set? + if (!isMailerThemeSet()) { + // No, then abort here + debug_report_bug(__FUNCTION__, __LINE__, 'mailer_theme not set in session. Please fix your code.'); + } // END - if + + // Return the theme from session + return getSession('mailer_theme'); +} + // [EOF] ?>