X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Fwrapper-functions.php;h=308f7439a6b589421729f0fabed41f4b50deb8f0;hp=b42874ee8a035d540729ff09ce03c050585be84d;hb=3971209b0996a1b0506d6ddaf7326432933eae1b;hpb=07af932574589f4906be5ebf6733fdb95f30e9a2 diff --git a/inc/wrapper-functions.php b/inc/wrapper-functions.php index b42874ee8a..308f7439a6 100644 --- a/inc/wrapper-functions.php +++ b/inc/wrapper-functions.php @@ -16,8 +16,8 @@ * $Author:: $ * * -------------------------------------------------------------------- * * Copyright (c) 2003 - 2009 by Roland Haeder * - * Copyright (c) 2009, 2010 by Mailer Developer Team * - * For more information visit: http://www.mxchange.org * + * Copyright (c) 2009 - 2011 by Mailer Developer Team * + * 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 @@ -194,10 +192,25 @@ function isDirectory ($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')) { @@ -271,12 +284,34 @@ 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 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 @@ -333,6 +368,12 @@ function isAdminRegistered () { 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 function isResetModeEnabled () { // Now simply check it @@ -351,6 +392,18 @@ function isDebugModeEnabled () { return $GLOBALS[__FUNCTION__]; } +// Checks wether the debug reset is enabled +function isDebugResetEnabled () { + // Is cache set? + if (!isset($GLOBALS[__FUNCTION__])) { + // Simply check it + $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_RESET')) && (getConfig('DEBUG_RESET') == 'Y')); + } // END - if + + // Return it + return $GLOBALS[__FUNCTION__]; +} + // Checks wether SQL debugging is enabled function isSqlDebuggingEnabled () { // Is cache set? @@ -377,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. @@ -421,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) { @@ -480,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; @@ -499,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 @@ -509,7 +542,7 @@ function isNicknameUsed ($userid) { // Getter for 'what' value function getWhat () { // Default is null - $what = null; + $what = NULL; // Is the value set? if (isWhatSet(true)) { @@ -553,7 +586,7 @@ 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()))) { @@ -588,7 +621,7 @@ 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)) { @@ -614,7 +647,7 @@ function isModuleSet ($strict = false) { // 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 @@ -623,17 +656,23 @@ function isModuleSet ($strict = false) { // Getter for 'output_mode' value function getScriptOutputMode () { - // Default is null - $output_mode = null; + // 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']; + // Is the value set? + if (isOutputModeSet(true)) { + // Then use it + $output_mode = $GLOBALS['output_mode']; + } // END - if + + // 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 @@ -649,7 +688,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 @@ -673,13 +712,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 @@ -691,7 +739,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 @@ -700,9 +748,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 @@ -717,7 +765,7 @@ function isExtensionInstalledAndNewer ($ext_name, $version) { } // Return it - //* DEBUG: */ debugOutput(__FUNCTION__.':'.$ext_name.'=>'.$version.':'.intval($GLOBALS[__FUNCTION__][$ext_name][$version])); + //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $ext_name . '=>' . $version . ':' . intval($GLOBALS[__FUNCTION__][$ext_name][$version])); return $GLOBALS[__FUNCTION__][$ext_name][$version]; } @@ -733,7 +781,7 @@ function isExtensionInstalledAndOlder ($ext_name, $version) { } // Return it - //* DEBUG: */ debugOutput(__FUNCTION__.':'.$ext_name.'<'.$version.':'.intval($GLOBALS[__FUNCTION__][$ext_name][$version])); + //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $ext_name . '<' . $version . ':' . intval($GLOBALS[__FUNCTION__][$ext_name][$version])); return $GLOBALS[__FUNCTION__][$ext_name][$version]; } @@ -771,7 +819,7 @@ function isDemoModeActive () { // Is cache set? if (!isset($GLOBALS[__FUNCTION__])) { // Simply check it - $GLOBALS[__FUNCTION__] = ((isExtensionActive('demo')) && (getAdminLogin(getSession('admin_id')) == 'demo')); + $GLOBALS[__FUNCTION__] = ((isExtensionActive('demo')) && (getCurrentAdminLogin() == 'demo')); } // END - if // Return it @@ -800,6 +848,69 @@ 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 @@ -809,6 +920,7 @@ function initUserData () { } // END - if // Init the user + unset($GLOBALS['is_userdata_valid'][getCurrentUserId()]); $GLOBALS['user_data'][getCurrentUserId()] = array(); } @@ -820,8 +932,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 @@ -849,7 +981,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()])) { @@ -901,10 +1035,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))) { @@ -917,6 +1052,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]; } @@ -945,6 +1081,13 @@ function setHttpStatus ($status) { // Getter for HTTP status function getHttpStatus () { + // Is the status set? + if (!isset($GLOBALS['http_status'])) { + // Abort here + debug_report_bug(__FUNCTION__, __LINE__, 'No HTTP status set!'); + } // END - if + + // Return it return $GLOBALS['http_status']; } @@ -974,14 +1117,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 @@ -1017,7 +1160,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 @@ -1029,7 +1176,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 @@ -1041,7 +1192,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 @@ -1073,11 +1244,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('patch_ctime'), '5'); + $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 @@ -1085,11 +1268,13 @@ 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() - if (is_null($timestamp)) $timestamp = time(); + if (is_null($timestamp)) { + $timestamp = time(); + } // END - if // Then create it $GLOBALS[__FUNCTION__][$timestamp] = date('Y', $timestamp); @@ -1100,11 +1285,14 @@ 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])) { - // null is time() - if (is_null($timestamp)) $timestamp = time(); + // 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); @@ -1114,12 +1302,31 @@ function getMonth ($timestamp = null) { 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) { +function getDay ($timestamp = NULL) { // Is it cached? if (!isset($GLOBALS[__FUNCTION__][$timestamp])) { // null is time() - if (is_null($timestamp)) $timestamp = time(); + if (is_null($timestamp)) { + $timestamp = time(); + } // END - if // Then create it $GLOBALS[__FUNCTION__][$timestamp] = date('d', $timestamp); @@ -1130,7 +1337,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() @@ -1145,7 +1352,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() @@ -1160,7 +1367,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() @@ -1175,7 +1382,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() @@ -1190,7 +1397,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() @@ -1289,11 +1496,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 @@ -1312,12 +1519,12 @@ 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 - $GLOBALS[__FUNCTION__] = (getConfig('select_user_zero_refid') == 'Y'); + $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('user', '0.3.4')) && (getConfig('select_user_zero_refid') == 'Y')); } // END - if // Return cache @@ -1336,6 +1543,18 @@ function getDefaultLanguage () { return $GLOBALS[__FUNCTION__]; } +// "Getter" for default referral 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? @@ -1384,6 +1603,30 @@ function getSecretKey () { 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? @@ -1408,12 +1651,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 @@ -1840,6 +2083,354 @@ function getOneDay () { 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__]; +} + +// "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__]; +} + // Checks wether proxy configuration is used function isProxyUsed () { // Do we have cache? @@ -1857,7 +2448,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 @@ -1880,8 +2471,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 @@ -1912,6 +2512,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? @@ -1950,12 +2562,122 @@ 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 $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(postRequestElement($postEntry)); + + // ... and set it again + setPostRequestElement($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 (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]; }