2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 04/04/2009 *
4 * =================== Last change: 04/04/2009 *
6 * -------------------------------------------------------------------- *
7 * File : wrapper-functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Wrapper functions *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Wrapper-Funktionen *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * -------------------------------------------------------------------- *
18 * Copyright (c) 2003 - 2009 by Roland Haeder *
19 * Copyright (c) 2009 - 2011 by Mailer Developer Team *
20 * For more information visit: http://www.mxchange.org *
22 * This program is free software; you can redistribute it and/or modify *
23 * it under the terms of the GNU General Public License as published by *
24 * the Free Software Foundation; either version 2 of the License, or *
25 * (at your option) any later version. *
27 * This program is distributed in the hope that it will be useful, *
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
30 * GNU General Public License for more details. *
32 * You should have received a copy of the GNU General Public License *
33 * along with this program; if not, write to the Free Software *
34 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
36 ************************************************************************/
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
44 function readFromFile ($FQFN) {
45 // Sanity-check if file is there (should be there, but just to make it sure)
46 if (!isFileReadable($FQFN)) {
47 // This should not happen
48 debug_report_bug(__FUNCTION__, __LINE__, 'File ' . basename($FQFN) . ' is not readable!');
49 } elseif (!isset($GLOBALS['file_content'][$FQFN])) {
51 if (function_exists('file_get_contents')) {
53 $GLOBALS['file_content'][$FQFN] = file_get_contents($FQFN);
55 // Fall-back to implode-file chain
56 $GLOBALS['file_content'][$FQFN] = implode('', file($FQFN));
61 return $GLOBALS['file_content'][$FQFN];
64 // Writes content to a file
65 function writeToFile ($FQFN, $content, $aquireLock = false) {
66 // Is the file writeable?
67 if ((isFileReadable($FQFN)) && (!is_writeable($FQFN)) && (!changeMode($FQFN, 0644))) {
69 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File %s not writeable.", basename($FQFN)));
75 // By default all is failed...
76 $GLOBALS['file_readable'][$FQFN] = false;
77 unset($GLOBALS['file_content'][$FQFN]);
80 // Is the function there?
81 if (function_exists('file_put_contents')) {
83 if ($aquireLock === true) {
84 // Write it directly with lock
85 $return = file_put_contents($FQFN, $content, LOCK_EX);
88 $return = file_put_contents($FQFN, $content);
91 // Write it with fopen
92 $fp = fopen($FQFN, 'w') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot write to file ' . basename($FQFN) . '!');
94 // Do we need to aquire a lock?
95 if ($aquireLock === true) {
101 $return = fwrite($fp, $content);
107 // Was something written?
108 if ($return !== false) {
109 // Mark it as readable
110 $GLOBALS['file_readable'][$FQFN] = true;
112 // Remember content in cache
113 $GLOBALS['file_content'][$FQFN] = $content;
117 return (($return !== false) && (changeMode($FQFN, 0644)));
120 // Clears the output buffer. This function does *NOT* backup sent content.
121 function clearOutputBuffer () {
122 // Trigger an error on failure
123 if ((ob_get_length() > 0) && (!ob_end_clean())) {
125 debug_report_bug(__FUNCTION__, __LINE__, 'Failed to clean output buffer.');
130 // @TODO Implement $compress
131 function encodeString ($str, $compress = true) {
132 $str = urlencode(base64_encode(compileUriCode($str)));
136 // Decode strings encoded with encodeString()
137 // @TODO Implement $decompress
138 function decodeString ($str, $decompress = true) {
139 $str = compileUriCode(base64_decode(urldecode(compileUriCode($str))));
143 // Decode entities in a nicer way
144 function decodeEntities ($str, $quote = ENT_NOQUOTES) {
145 // Decode the entities to UTF-8 now
146 $decodedString = html_entity_decode($str, $quote, 'UTF-8');
148 // Return decoded string
149 return $decodedString;
152 // Merges an array together but only if both are arrays
153 function merge_array ($array1, $array2) {
154 // Are both an array?
155 if ((!is_array($array1)) && (!is_array($array2))) {
156 // Both are not arrays
157 debug_report_bug(__FUNCTION__, __LINE__, 'No arrays provided!');
158 } elseif (!is_array($array1)) {
159 // Left one is not an array
160 debug_report_bug(__FUNCTION__, __LINE__, sprintf("array1 is not an array. array != %s", gettype($array1)));
161 } elseif (!is_array($array2)) {
162 // Right one is not an array
163 debug_report_bug(__FUNCTION__, __LINE__, sprintf("array2 is not an array. array != %s", gettype($array2)));
166 // Merge all together
167 return array_merge($array1, $array2);
170 // Check if given FQFN is a readable file
171 function isFileReadable ($FQFN) {
173 if (!isset($GLOBALS['file_readable'][$FQFN])) {
175 $GLOBALS['file_readable'][$FQFN] = ((file_exists($FQFN)) && (is_file($FQFN)) && (is_readable($FQFN)));
179 return $GLOBALS['file_readable'][$FQFN];
182 // Checks wether the given FQFN is a directory and not ., .. or .svn
183 function isDirectory ($FQFN) {
185 if (!isset($GLOBALS[__FUNCTION__][$FQFN])) {
187 $baseName = basename($FQFN);
190 $GLOBALS[__FUNCTION__][$FQFN] = ((is_dir($FQFN)) && ($baseName != '.') && ($baseName != '..') && ($baseName != '.svn'));
194 return $GLOBALS[__FUNCTION__][$FQFN];
197 // "Getter" for the real remote IP number
198 function detectRealIpAddress () {
199 // Get remote ip from environment
200 $remoteAddr = determineRealRemoteAddress();
202 // Is removeip installed?
203 if (isExtensionActive('removeip')) {
205 $remoteAddr = getAnonymousRemoteAddress($remoteAddr);
212 // "Getter" for remote IP number
213 function detectRemoteAddr () {
214 // Get remote ip from environment
215 $remoteAddr = determineRealRemoteAddress(true);
217 // Is removeip installed?
218 if (isExtensionActive('removeip')) {
220 $remoteAddr = getAnonymousRemoteAddress($remoteAddr);
227 // "Getter" for remote hostname
228 function detectRemoteHostname () {
229 // Get remote ip from environment
230 $remoteHost = getenv('REMOTE_HOST');
232 // Is removeip installed?
233 if (isExtensionActive('removeip')) {
235 $remoteHost = getAnonymousRemoteHost($remoteHost);
242 // "Getter" for user agent
243 function detectUserAgent ($alwaysReal = false) {
244 // Get remote ip from environment
245 $userAgent = getenv('HTTP_USER_AGENT');
247 // Is removeip installed?
248 if ((isExtensionActive('removeip')) && ($alwaysReal === false)) {
250 $userAgent = getAnonymousUserAgent($userAgent);
257 // "Getter" for referer
258 function detectReferer () {
259 // Get remote ip from environment
260 $referer = getenv('HTTP_REFERER');
262 // Is removeip installed?
263 if (isExtensionActive('removeip')) {
265 $referer = getAnonymousReferer($referer);
272 // "Getter" for request URI
273 function detectRequestUri () {
275 return (getenv('REQUEST_URI'));
278 // "Getter" for query string
279 function detectQueryString () {
280 return str_replace('&', '&', (getenv('QUERY_STRING')));
283 // "Getter" for SERVER_NAME
284 function detectServerName () {
286 return (getenv('SERVER_NAME'));
289 // Removes any existing www. from SERVER_NAME. This is very silly but enough
290 // for our purpose here.
291 function detectDomainName () {
293 if (!isset($GLOBALS[__FUNCTION__])) {
295 $domainName = detectServerName();
297 // Is there any www. ?
298 if (substr($domainName, 0, 4) == 'www.') {
300 $domainName = substr($domainName, 4);
304 $GLOBALS[__FUNCTION__] = $domainName;
308 return $GLOBALS[__FUNCTION__];
311 // Check wether we are installing
312 function isInstalling () {
313 // Determine wether we are installing
314 if (!isset($GLOBALS['mailer_installing'])) {
315 // Check URL (css.php/js.php need this)
316 $GLOBALS['mailer_installing'] = isGetRequestParameterSet('installing');
320 return $GLOBALS['mailer_installing'];
323 // Check wether this script is installed
324 function isInstalled () {
326 if (!isset($GLOBALS[__FUNCTION__])) {
327 // Determine wether this script is installed
328 $GLOBALS[__FUNCTION__] = (
333 isConfigEntrySet('MXCHANGE_INSTALLED')
335 getConfig('MXCHANGE_INSTALLED') == 'Y'
339 // New config file found and loaded
340 isIncludeReadable(getCachePath() . 'config-local.php')
343 // New config file found, but not yet read
344 isIncludeReadable(getCachePath() . 'config-local.php')
347 // Only new config file is found
348 !isIncludeReadable('inc/config.php')
350 // Is installation mode
357 // Then use the cache
358 return $GLOBALS[__FUNCTION__];
361 // Check wether an admin is registered
362 function isAdminRegistered () {
364 if (!isset($GLOBALS[__FUNCTION__])) {
366 $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y'));
370 return $GLOBALS[__FUNCTION__];
373 // Checks wether the hourly reset mode is active
374 function isHourlyResetEnabled () {
375 // Now simply check it
376 return ((isset($GLOBALS['hourly_enabled'])) && ($GLOBALS['hourly_enabled'] === true));
379 // Checks wether the reset mode is active
380 function isResetModeEnabled () {
381 // Now simply check it
382 return ((isset($GLOBALS['reset_enabled'])) && ($GLOBALS['reset_enabled'] === true));
385 // Checks wether the debug mode is enabled
386 function isDebugModeEnabled () {
388 if (!isset($GLOBALS[__FUNCTION__])) {
390 $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_MODE')) && (getConfig('DEBUG_MODE') == 'Y'));
394 return $GLOBALS[__FUNCTION__];
397 // Checks wether the debug reset is enabled
398 function isDebugResetEnabled () {
400 if (!isset($GLOBALS[__FUNCTION__])) {
402 $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_RESET')) && (getConfig('DEBUG_RESET') == 'Y'));
406 return $GLOBALS[__FUNCTION__];
409 // Checks wether SQL debugging is enabled
410 function isSqlDebuggingEnabled () {
412 if (!isset($GLOBALS[__FUNCTION__])) {
413 // Determine if SQL debugging is enabled
414 $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_SQL')) && (getConfig('DEBUG_SQL') == 'Y'));
418 return $GLOBALS[__FUNCTION__];
421 // Checks wether we shall debug regular expressions
422 function isDebugRegularExpressionEnabled () {
424 if (!isset($GLOBALS[__FUNCTION__])) {
426 $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y'));
430 return $GLOBALS[__FUNCTION__];
433 // Checks wether the cache instance is valid
434 function isCacheInstanceValid () {
436 if (!isset($GLOBALS[__FUNCTION__])) {
438 $GLOBALS[__FUNCTION__] = ((isset($GLOBALS['cache_instance'])) && (is_object($GLOBALS['cache_instance'])));
442 return $GLOBALS[__FUNCTION__];
445 // Copies a file from source to destination and verifies if that goes fine.
446 // This function should wrap the copy() command and make a nicer debug backtrace
447 // even if there is no xdebug extension installed.
448 function copyFileVerified ($source, $dest, $chmod = '') {
449 // Failed is the default
452 // Is the source file there?
453 if (!isFileReadable($source)) {
455 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot read from source file ' . basename($source) . '.');
458 // Is the target directory there?
459 if (!isDirectory(dirname($dest))) {
461 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot find directory ' . str_replace(getPath(), '', dirname($dest)) . '.');
464 // Now try to copy it
465 if (!copy($source, $dest)) {
466 // Something went wrong
467 debug_report_bug(__FUNCTION__, __LINE__, 'copy() has failed to copy the file.');
470 $GLOBALS['file_readable'][$dest] = true;
473 // If there are chmod rights set, apply them
474 if (!empty($chmod)) {
476 $status = changeMode($dest, $chmod);
486 // Wrapper function for header()
487 // Send a header but checks before if we can do so
488 function sendHeader ($header) {
490 //* DEBUG: */ logDebugMessage(__FUNCTION__ . ': header=' . $header);
491 $GLOBALS['header'][] = trim($header);
494 // Flushes all headers
495 function flushHeaders () {
496 // Is the header already sent?
497 if (headers_sent()) {
499 debug_report_bug(__FUNCTION__, __LINE__, 'Headers already sent!');
502 // Flush all headers if found
503 if ((isset($GLOBALS['header'])) && (is_array($GLOBALS['header']))) {
504 foreach ($GLOBALS['header'] as $header) {
509 // Mark them as flushed
510 $GLOBALS['header'] = array();
513 // Wrapper function for chmod()
514 // @TODO Do some more sanity check here
515 function changeMode ($FQFN, $mode) {
516 // Is the file/directory there?
517 if ((!isFileReadable($FQFN)) && (!isDirectory($FQFN))) {
518 // Neither, so abort here
519 debug_report_bug(__FUNCTION__, __LINE__, 'Cannot chmod() on ' . basename($FQFN) . '.');
523 return chmod($FQFN, $mode);
526 // Wrapper for unlink()
527 function removeFile ($FQFN) {
528 // Is the file there?
529 if (isFileReadable($FQFN)) {
531 $GLOBALS['file_readable'][$FQFN] = false;
534 return unlink($FQFN);
537 // All fine if no file was removed. If we change this to 'false' or rewrite
538 // above if() block it would be to restrictive.
542 // Wrapper for $_POST['sel']
543 function countPostSelection ($element = 'sel') {
545 if (isPostRequestParameterSet($element)) {
546 // Return counted elements
547 return countSelection(postRequestParameter($element));
549 // Return zero if not found
554 // Checks wether the config-local.php is loaded
555 function isConfigLocalLoaded () {
556 return ((isset($GLOBALS['config_local_loaded'])) && ($GLOBALS['config_local_loaded'] === true));
559 // Checks wether a nickname or userid was entered and caches the result
560 function isNicknameUsed ($userid) {
561 // Is the cache there
562 if (!isset($GLOBALS[__FUNCTION__][$userid])) {
564 $GLOBALS[__FUNCTION__][$userid] = ((!empty($userid)) && (('' . round($userid) . '') != $userid));
568 return $GLOBALS[__FUNCTION__][$userid];
571 // Getter for 'what' value
572 function getWhat () {
577 if (isWhatSet(true)) {
579 $what = $GLOBALS['what'];
586 // Setter for 'what' value
587 function setWhat ($newWhat) {
588 $GLOBALS['what'] = SQL_ESCAPE($newWhat);
591 // Setter for 'what' from configuration
592 function setWhatFromConfig ($configEntry) {
593 // Get 'what' from config
594 $what = getConfig($configEntry);
600 // Checks wether what is set and optionally aborts on miss
601 function isWhatSet ($strict = false) {
603 $isset = isset($GLOBALS['what']);
605 // Should we abort here?
606 if (($strict === true) && ($isset === false)) {
608 debug_report_bug(__FUNCTION__, __LINE__, 'what is empty.');
615 // Getter for 'action' value
616 function getAction ($strict = true) {
621 if (isActionSet(($strict) && (isHtmlOutputMode()))) {
623 $action = $GLOBALS['action'];
630 // Setter for 'action' value
631 function setAction ($newAction) {
632 $GLOBALS['action'] = SQL_ESCAPE($newAction);
635 // Checks wether action is set and optionally aborts on miss
636 function isActionSet ($strict = false) {
638 $isset = ((isset($GLOBALS['action'])) && (!empty($GLOBALS['action'])));
640 // Should we abort here?
641 if (($strict === true) && ($isset === false)) {
643 debug_report_bug(__FUNCTION__, __LINE__, 'action is empty.');
650 // Getter for 'module' value
651 function getModule ($strict = true) {
656 if (isModuleSet($strict)) {
658 $module = $GLOBALS['module'];
665 // Setter for 'module' value
666 function setModule ($newModule) {
667 // Secure it and make all modules lower-case
668 $GLOBALS['module'] = SQL_ESCAPE(strtolower($newModule));
671 // Checks wether module is set and optionally aborts on miss
672 function isModuleSet ($strict = false) {
674 $isset = (!empty($GLOBALS['module']));
676 // Should we abort here?
677 if (($strict === true) && ($isset === false)) {
679 debug_report_bug(__FUNCTION__, __LINE__, 'module is empty.');
683 return (($isset === true) && ($GLOBALS['module'] != 'unknown')) ;
686 // Getter for 'output_mode' value
687 function getScriptOutputMode () {
689 if (!isset($GLOBALS[__FUNCTION__])) {
694 if (isOutputModeSet(true)) {
696 $output_mode = $GLOBALS['output_mode'];
700 $GLOBALS[__FUNCTION__] = $output_mode;
704 return $GLOBALS[__FUNCTION__];
707 // Setter for 'output_mode' value
708 function setOutputMode ($newOutputMode) {
709 $GLOBALS['output_mode'] = (int) $newOutputMode;
712 // Checks wether output_mode is set and optionally aborts on miss
713 function isOutputModeSet ($strict = false) {
715 $isset = (isset($GLOBALS['output_mode']));
717 // Should we abort here?
718 if (($strict === true) && ($isset === false)) {
720 debug_report_bug(__FUNCTION__, __LINE__, 'Output mode is not set.');
727 // Enables block-mode
728 function enableBlockMode ($enabled = true) {
729 $GLOBALS['block_mode'] = $enabled;
732 // Checks wether block-mode is enabled
733 function isBlockModeEnabled () {
735 if (!isset($GLOBALS['block_mode'])) {
737 debug_report_bug(__FUNCTION__, __LINE__, 'Block_mode is not set.');
741 return $GLOBALS['block_mode'];
744 // Wrapper function for addPointsThroughReferalSystem()
745 function addPointsDirectly ($subject, $userid, $points) {
747 unset($GLOBALS['ref_level']);
749 // Call more complicated method (due to more parameters)
750 return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, 'DIRECT');
753 // Wrapper for redirectToUrl but URL comes from a configuration entry
754 function redirectToConfiguredUrl ($configEntry) {
756 redirectToUrl(getConfig($configEntry));
759 // Wrapper function to redirect from member-only modules to index
760 function redirectToIndexMemberOnlyModule () {
761 // Do the redirect here
762 redirectToUrl('modules.php?module=index&code=' . getCode('MODULE_MEMBER_ONLY') . '&mod=' . getModule());
765 // Wrapper function to redirect to current URL
766 function redirectToRequestUri () {
767 redirectToUrl(basename(detectRequestUri()));
770 // Wrapper function to redirect to de-refered URL
771 function redirectToDereferedUrl ($url) {
773 redirectToUrl(generateDerefererUrl($url));
776 // Wrapper function for checking if extension is installed and newer or same version
777 function isExtensionInstalledAndNewer ($ext_name, $version) {
778 // Is an cache entry found?
779 if (!isset($GLOBALS[__FUNCTION__][$ext_name][$version])) {
781 $GLOBALS[__FUNCTION__][$ext_name][$version] = ((isExtensionInstalled($ext_name)) && (getExtensionVersion($ext_name) >= $version));
783 // Cache hits should be incremented twice
784 incrementStatsEntry('cache_hits', 2);
788 //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $ext_name . '=>' . $version . ':' . intval($GLOBALS[__FUNCTION__][$ext_name][$version]));
789 return $GLOBALS[__FUNCTION__][$ext_name][$version];
792 // Wrapper function for checking if extension is installed and older than given version
793 function isExtensionInstalledAndOlder ($ext_name, $version) {
794 // Is an cache entry found?
795 if (!isset($GLOBALS[__FUNCTION__][$ext_name][$version])) {
797 $GLOBALS[__FUNCTION__][$ext_name][$version] = ((isExtensionInstalled($ext_name)) && (isExtensionOlder($ext_name, $version)));
799 // Cache hits should be incremented twice
800 incrementStatsEntry('cache_hits', 2);
804 //* DEBUG: */ debugOutput(__FUNCTION__ . ':' . $ext_name . '<' . $version . ':' . intval($GLOBALS[__FUNCTION__][$ext_name][$version]));
805 return $GLOBALS[__FUNCTION__][$ext_name][$version];
809 function setUsername ($userName) {
810 $GLOBALS['username'] = (string) $userName;
814 function getUsername () {
816 if (!isset($GLOBALS['username'])) {
817 // No, so it has to be a guest
818 $GLOBALS['username'] = '{--USERNAME_GUEST--}';
822 return $GLOBALS['username'];
825 // Wrapper function for installation phase
826 function isInstallationPhase () {
828 if (!isset($GLOBALS[__FUNCTION__])) {
830 $GLOBALS[__FUNCTION__] = ((!isInstalled()) || (isInstalling()));
834 return $GLOBALS[__FUNCTION__];
837 // Checks wether the extension demo is actuve and the admin login is demo (password needs to be demo, too!)
838 function isDemoModeActive () {
840 if (!isset($GLOBALS[__FUNCTION__])) {
842 $GLOBALS[__FUNCTION__] = ((isExtensionActive('demo')) && (getCurrentAdminLogin() == 'demo'));
846 return $GLOBALS[__FUNCTION__];
849 // Getter for PHP caching value
850 function getPhpCaching () {
851 return $GLOBALS['php_caching'];
854 // Checks wether the admin hash is set
855 function isAdminHashSet ($adminId) {
856 // Is the array there?
857 if (!isset($GLOBALS['cache_array']['admin'])) {
858 // Missing array should be reported
859 debug_report_bug(__FUNCTION__, __LINE__, 'Cache not set.');
862 // Check for admin hash
863 return isset($GLOBALS['cache_array']['admin']['password'][$adminId]);
866 // Setter for admin hash
867 function setAdminHash ($adminId, $hash) {
868 $GLOBALS['cache_array']['admin']['password'][$adminId] = $hash;
871 // Getter for current admin login
872 function getCurrentAdminLogin () {
874 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'called!');
877 if (!isset($GLOBALS[__FUNCTION__])) {
879 $GLOBALS[__FUNCTION__] = getAdminLogin(getCurrentAdminId());
883 return $GLOBALS[__FUNCTION__];
886 // Setter for admin id (and current)
887 function setAdminId ($adminId) {
889 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'adminId=' . $adminId);
892 $status = setSession('admin_id', bigintval($adminId));
895 setCurrentAdminId($adminId);
901 // Setter for admin_last
902 function setAdminLast ($adminLast) {
904 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'adminLast=' . $adminLast);
907 $status = setSession('admin_last', $adminLast);
913 // Setter for admin_md5
914 function setAdminMd5 ($adminMd5) {
916 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'adminMd5=' . $adminMd5);
919 $status = setSession('admin_md5', $adminMd5);
925 // Getter for admin_md5
926 function getAdminMd5 () {
928 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'called!');
931 return getSession('admin_md5');
934 // Init user data array
935 function initUserData () {
936 // User id should not be zero
937 if (!isValidUserId(getCurrentUserId())) {
938 // Should be always valid
939 debug_report_bug(__FUNCTION__, __LINE__, 'Current user id is invalid: ' . getCurrentUserId());
943 $GLOBALS['user_data'][getCurrentUserId()] = array();
946 // Getter for user data
947 function getUserData ($column) {
948 // User id should not be zero
949 if (!isValidUserId(getCurrentUserId())) {
950 // Should be always valid
951 debug_report_bug(__FUNCTION__, __LINE__, 'Current user id is invalid: ' . getCurrentUserId());
957 if (isset($GLOBALS['user_data'][getCurrentUserId()][$column])) {
959 $data = $GLOBALS['user_data'][getCurrentUserId()][$column];
966 // Checks wether given user data is set to 'Y'
967 function isUserDataEnabled ($column) {
969 if (!isset($GLOBALS[__FUNCTION__][getCurrentUserId()][$column])) {
971 $GLOBALS[__FUNCTION__][getCurrentUserId()][$column] = (getUserData($column) == 'Y');
975 return $GLOBALS[__FUNCTION__][getCurrentUserId()][$column];
978 // Geter for whole user data array
979 function getUserDataArray () {
981 $userid = getCurrentUserId();
983 // Is the current userid valid?
984 if (!isValidUserId($userid)) {
985 // Should be always valid
986 debug_report_bug(__FUNCTION__, __LINE__, 'Current user id is invalid: ' . $userid);
989 // Get the whole array if found
990 if (isset($GLOBALS['user_data'][$userid])) {
991 // Found, so return it
992 return $GLOBALS['user_data'][$userid];
994 // Return empty array
999 // Checks if the user data is valid, this may indicate that the user has logged
1000 // in, but you should use isMember() if you want to find that out.
1001 function isUserDataValid () {
1002 // User id should not be zero so abort here
1003 if (!isCurrentUserIdSet()) return false;
1006 if (!isset($GLOBALS['is_userdata_valid'][getCurrentUserId()])) {
1008 $GLOBALS['is_userdata_valid'][getCurrentUserId()] = ((isset($GLOBALS['user_data'][getCurrentUserId()])) && (count($GLOBALS['user_data'][getCurrentUserId()]) > 1));
1011 // Return the result
1012 return $GLOBALS['is_userdata_valid'][getCurrentUserId()];
1015 // Setter for current userid
1016 function setCurrentUserId ($userid) {
1018 $GLOBALS['current_userid'] = bigintval($userid);
1020 // Unset it to re-determine the actual state
1021 unset($GLOBALS['is_userdata_valid'][$userid]);
1024 // Getter for current userid
1025 function getCurrentUserId () {
1026 // Userid must be set before it can be used
1027 if (!isCurrentUserIdSet()) {
1029 debug_report_bug(__FUNCTION__, __LINE__, 'User id is not set.');
1032 // Return the userid
1033 return $GLOBALS['current_userid'];
1036 // Checks if current userid is set
1037 function isCurrentUserIdSet () {
1038 return ((isset($GLOBALS['current_userid'])) && (isValidUserId($GLOBALS['current_userid'])));
1041 // Checks wether we are debugging template cache
1042 function isDebuggingTemplateCache () {
1043 // Do we have cache?
1044 if (!isset($GLOBALS[__FUNCTION__])) {
1046 $GLOBALS[__FUNCTION__] = (getConfig('DEBUG_TEMPLATE_CACHE') == 'Y');
1050 return $GLOBALS[__FUNCTION__];
1053 // Wrapper for fetchUserData() and getUserData() calls
1054 function getFetchedUserData ($keyColumn, $userid, $valueColumn) {
1056 if (!isset($GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn])) {
1057 // Default is 'guest'
1058 $data = '{--USERNAME_GUEST--}';
1060 // Can we fetch the user data?
1061 if ((isValidUserId($userid)) && (fetchUserData($userid, $keyColumn))) {
1062 // Now get the data back
1063 $data = getUserData($valueColumn);
1067 $GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn] = $data;
1071 return $GLOBALS[__FUNCTION__][$userid][$keyColumn][$valueColumn];
1074 // Wrapper for strpos() to ease porting from deprecated ereg() function
1075 function isInString ($needle, $haystack) {
1076 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'needle=' . $needle . ', haystack=' . $haystack . ', returned=' . intval(strpos($haystack, $needle) !== false));
1077 return (strpos($haystack, $needle) !== false);
1080 // Wrapper for strpos() to ease porting from deprecated eregi() function
1081 // This function is case-insensitive
1082 function isInStringIgnoreCase ($needle, $haystack) {
1083 return (isInString(strtolower($needle), strtolower($haystack)));
1086 // Wrapper to check for if fatal errors where detected
1087 function ifFatalErrorsDetected () {
1088 // Just call the inner function
1089 return (getTotalFatalErrors() > 0);
1092 // Setter for HTTP status
1093 function setHttpStatus ($status) {
1094 $GLOBALS['http_status'] = (string) $status;
1097 // Getter for HTTP status
1098 function getHttpStatus () {
1099 // Is the status set?
1100 if (!isset($GLOBALS['http_status'])) {
1102 debug_report_bug(__FUNCTION__, __LINE__, 'No HTTP status set!');
1106 return $GLOBALS['http_status'];
1110 * Send a HTTP redirect to the browser. This function was taken from DokuWiki
1111 * (GNU GPL 2; http://www.dokuwiki.org) and modified to fit into mailer project.
1113 * ----------------------------------------------------------------------------
1114 * If you want to redirect, please use redirectToUrl(); instead
1115 * ----------------------------------------------------------------------------
1117 * Works arround Microsoft IIS cookie sending bug. Does exit the script.
1119 * @link http://support.microsoft.com/kb/q176113/
1120 * @author Andreas Gohr <andi@splitbrain.org>
1123 function sendRawRedirect ($url) {
1124 // Send helping header
1125 setHttpStatus('302 Found');
1127 // always close the session
1128 session_write_close();
1130 // Revert entity &
1131 $url = str_replace('&', '&', $url);
1133 // check if running on IIS < 6 with CGI-PHP
1134 if ((isset($_SERVER['SERVER_SOFTWARE'])) && (isset($_SERVER['GATEWAY_INTERFACE'])) &&
1135 (strpos($_SERVER['GATEWAY_INTERFACE'], 'CGI') !== false) &&
1136 (preg_match('|^Microsoft-IIS/(\d)\.\d$|', trim($_SERVER['SERVER_SOFTWARE']), $matches)) &&
1137 ($matches[1] < 6)) {
1138 // Send the IIS header
1139 sendHeader('Refresh: 0;url=' . $url);
1141 // Send generic header
1142 sendHeader('Location: ' . $url);
1149 // Determines the country of the given user id
1150 function determineCountry ($userid) {
1151 // Do we have cache?
1152 if (!isset($GLOBALS[__FUNCTION__][$userid])) {
1153 // Default is 'invalid'
1154 $GLOBALS[__FUNCTION__][$userid] = 'invalid';
1156 // Is extension country active?
1157 if (isExtensionActive('country')) {
1158 // Determine the right country code through the country id
1159 $id = getUserData('country_code');
1161 // Then handle it over
1162 $GLOBALS[__FUNCTION__][$userid] = generateCountryInfo($id);
1164 // Get raw code from user data
1165 $GLOBALS[__FUNCTION__][$userid] = getUserData('country');
1170 return $GLOBALS[__FUNCTION__][$userid];
1173 // "Getter" for total confirmed user accounts
1174 function getTotalConfirmedUser () {
1176 if (!isset($GLOBALS[__FUNCTION__])) {
1178 if (isExtensionActive('user')) {
1179 $GLOBALS[__FUNCTION__] = countSumTotalData('CONFIRMED', 'user_data', 'userid', 'status', true);
1181 $GLOBALS[__FUNCTION__] = 0;
1185 // Return cached value
1186 return $GLOBALS[__FUNCTION__];
1189 // "Getter" for total unconfirmed user accounts
1190 function getTotalUnconfirmedUser () {
1192 if (!isset($GLOBALS[__FUNCTION__])) {
1194 if (isExtensionActive('user')) {
1195 $GLOBALS[__FUNCTION__] = countSumTotalData('UNCONFIRMED', 'user_data', 'userid', 'status', true);
1197 $GLOBALS[__FUNCTION__] = 0;
1201 // Return cached value
1202 return $GLOBALS[__FUNCTION__];
1205 // "Getter" for total locked user accounts
1206 function getTotalLockedUser () {
1208 if (!isset($GLOBALS[__FUNCTION__])) {
1210 if (isExtensionActive('user')) {
1211 $GLOBALS[__FUNCTION__] = countSumTotalData('LOCKED', 'user_data', 'userid', 'status', true);
1213 $GLOBALS[__FUNCTION__] = 0;
1217 // Return cached value
1218 return $GLOBALS[__FUNCTION__];
1221 // Is given userid valid?
1222 function isValidUserId ($userid) {
1223 // Do we have cache?
1224 if (!isset($GLOBALS[__FUNCTION__][$userid])) {
1226 $GLOBALS[__FUNCTION__][$userid] = ((!is_null($userid)) && (!empty($userid)) && ($userid > 0));
1230 return $GLOBALS[__FUNCTION__][$userid];
1234 function encodeEntities ($str) {
1236 $str = secureString($str, true, true);
1238 // Encode dollar sign as well
1239 $str = str_replace('$', '$', $str);
1245 // "Getter" for date from patch_ctime
1246 function getDateFromPatchTime () {
1248 if (!isset($GLOBALS[__FUNCTION__])) {
1250 $GLOBALS[__FUNCTION__] = generateDateTime(getConfig('patch_ctime'), '5');
1254 return $GLOBALS[__FUNCTION__];
1257 // Getter for current year (default)
1258 function getYear ($timestamp = null) {
1260 if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
1262 if (is_null($timestamp)) {
1263 $timestamp = time();
1267 $GLOBALS[__FUNCTION__][$timestamp] = date('Y', $timestamp);
1271 return $GLOBALS[__FUNCTION__][$timestamp];
1274 // Getter for current month (default)
1275 function getMonth ($timestamp = null) {
1277 if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
1278 // If null is set, use time()
1279 if (is_null($timestamp)) {
1280 // Use time() which is current timestamp
1281 $timestamp = time();
1285 $GLOBALS[__FUNCTION__][$timestamp] = date('m', $timestamp);
1289 return $GLOBALS[__FUNCTION__][$timestamp];
1292 // Getter for current hour (default)
1293 function getHour ($timestamp = null) {
1295 if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
1297 if (is_null($timestamp)) {
1298 $timestamp = time();
1302 $GLOBALS[__FUNCTION__][$timestamp] = date('H', $timestamp);
1306 return $GLOBALS[__FUNCTION__][$timestamp];
1309 // Getter for current day (default)
1310 function getDay ($timestamp = null) {
1312 if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
1314 if (is_null($timestamp)) {
1315 $timestamp = time();
1319 $GLOBALS[__FUNCTION__][$timestamp] = date('d', $timestamp);
1323 return $GLOBALS[__FUNCTION__][$timestamp];
1326 // Getter for current week (default)
1327 function getWeek ($timestamp = null) {
1329 if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
1331 if (is_null($timestamp)) $timestamp = time();
1334 $GLOBALS[__FUNCTION__][$timestamp] = date('W', $timestamp);
1338 return $GLOBALS[__FUNCTION__][$timestamp];
1341 // Getter for current short_hour (default)
1342 function getShortHour ($timestamp = null) {
1344 if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
1346 if (is_null($timestamp)) $timestamp = time();
1349 $GLOBALS[__FUNCTION__][$timestamp] = date('G', $timestamp);
1353 return $GLOBALS[__FUNCTION__][$timestamp];
1356 // Getter for current long_hour (default)
1357 function getLongHour ($timestamp = null) {
1359 if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
1361 if (is_null($timestamp)) $timestamp = time();
1364 $GLOBALS[__FUNCTION__][$timestamp] = date('H', $timestamp);
1368 return $GLOBALS[__FUNCTION__][$timestamp];
1371 // Getter for current second (default)
1372 function getSecond ($timestamp = null) {
1374 if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
1376 if (is_null($timestamp)) $timestamp = time();
1379 $GLOBALS[__FUNCTION__][$timestamp] = date('s', $timestamp);
1383 return $GLOBALS[__FUNCTION__][$timestamp];
1386 // Getter for current minute (default)
1387 function getMinute ($timestamp = null) {
1389 if (!isset($GLOBALS[__FUNCTION__][$timestamp])) {
1391 if (is_null($timestamp)) $timestamp = time();
1394 $GLOBALS[__FUNCTION__][$timestamp] = date('i', $timestamp);
1398 return $GLOBALS[__FUNCTION__][$timestamp];
1401 // Checks wether the title decoration is enabled
1402 function isTitleDecorationEnabled () {
1403 // Do we have cache?
1404 if (!isset($GLOBALS[__FUNCTION__])) {
1406 $GLOBALS[__FUNCTION__] = (getConfig('enable_title_deco') == 'Y');
1410 return $GLOBALS[__FUNCTION__];
1413 // Checks wether filter usage updates are enabled (expensive queries!)
1414 function isFilterUsageUpdateEnabled () {
1415 // Do we have cache?
1416 if (!isset($GLOBALS[__FUNCTION__])) {
1418 $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('sql_patches', '0.6.0')) && (isConfigEntrySet('update_filter_usage')) && (getConfig('update_filter_usage') == 'Y'));
1422 return $GLOBALS[__FUNCTION__];
1425 // Checks wether debugging of weekly resets is enabled
1426 function isWeeklyResetDebugEnabled () {
1427 // Do we have cache?
1428 if (!isset($GLOBALS[__FUNCTION__])) {
1430 $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_WEEKLY')) && (getConfig('DEBUG_WEEKLY') == 'Y'));
1434 return $GLOBALS[__FUNCTION__];
1437 // Checks wether debugging of monthly resets is enabled
1438 function isMonthlyResetDebugEnabled () {
1439 // Do we have cache?
1440 if (!isset($GLOBALS[__FUNCTION__])) {
1442 $GLOBALS[__FUNCTION__] = ((isConfigEntrySet('DEBUG_MONTHLY')) && (getConfig('DEBUG_MONTHLY') == 'Y'));
1446 return $GLOBALS[__FUNCTION__];
1449 // Checks wether displaying of debug SQLs are enabled
1450 function isDisplayDebugSqlEnabled () {
1451 // Do we have cache?
1452 if (!isset($GLOBALS[__FUNCTION__])) {
1454 $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('other', '0.2.2')) && (getConfig('display_debug_sqls') == 'Y'));
1458 return $GLOBALS[__FUNCTION__];
1461 // Checks wether module title is enabled
1462 function isModuleTitleEnabled () {
1463 // Do we have cache?
1464 if (!isset($GLOBALS[__FUNCTION__])) {
1466 $GLOBALS[__FUNCTION__] = (getConfig('enable_mod_title') == 'Y');
1470 return $GLOBALS[__FUNCTION__];
1473 // Checks wether what title is enabled
1474 function isWhatTitleEnabled () {
1475 // Do we have cache?
1476 if (!isset($GLOBALS[__FUNCTION__])) {
1478 $GLOBALS[__FUNCTION__] = (getConfig('enable_what_title') == 'Y');
1482 return $GLOBALS[__FUNCTION__];
1485 // Checks wether stats are enabled
1486 function ifStatsAreEnabled () {
1487 // Do we have cache?
1488 if (!isset($GLOBALS[__FUNCTION__])) {
1489 // Then determine it
1490 $GLOBALS[__FUNCTION__] = (getConfig('stats_enabled') == 'Y');
1493 // Return cached value
1494 return $GLOBALS[__FUNCTION__];
1497 // Checks wether admin-notification of certain user actions is enabled
1498 function isAdminNotificationEnabled () {
1499 // Do we have cache?
1500 if (!isset($GLOBALS[__FUNCTION__])) {
1502 $GLOBALS[__FUNCTION__] = (getConfig('admin_notify') == 'Y');
1506 return $GLOBALS[__FUNCTION__];
1509 // Checks wether random referal id selection is enabled
1510 function isRandomReferalIdEnabled () {
1511 // Do we have cache?
1512 if (!isset($GLOBALS[__FUNCTION__])) {
1514 $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('user', '0.3.4')) && (getConfig('select_user_zero_refid') == 'Y'));
1518 return $GLOBALS[__FUNCTION__];
1521 // "Getter" for default language
1522 function getDefaultLanguage () {
1523 // Do we have cache?
1524 if (!isset($GLOBALS[__FUNCTION__])) {
1526 $GLOBALS[__FUNCTION__] = getConfig('DEFAULT_LANG');
1530 return $GLOBALS[__FUNCTION__];
1533 // "Getter" for default referal id
1534 function getDefRefid () {
1535 // Do we have cache?
1536 if (!isset($GLOBALS[__FUNCTION__])) {
1538 $GLOBALS[__FUNCTION__] = getConfig('def_refid');
1542 return $GLOBALS[__FUNCTION__];
1545 // "Getter" for path
1546 function getPath () {
1547 // Do we have cache?
1548 if (!isset($GLOBALS[__FUNCTION__])) {
1550 $GLOBALS[__FUNCTION__] = getConfig('PATH');
1554 return $GLOBALS[__FUNCTION__];
1558 function getUrl () {
1559 // Do we have cache?
1560 if (!isset($GLOBALS[__FUNCTION__])) {
1562 $GLOBALS[__FUNCTION__] = getConfig('URL');
1566 return $GLOBALS[__FUNCTION__];
1569 // "Getter" for cache_path
1570 function getCachePath () {
1571 // Do we have cache?
1572 if (!isset($GLOBALS[__FUNCTION__])) {
1574 $GLOBALS[__FUNCTION__] = getConfig('CACHE_PATH');
1578 return $GLOBALS[__FUNCTION__];
1581 // "Getter" for secret_key
1582 function getSecretKey () {
1583 // Do we have cache?
1584 if (!isset($GLOBALS[__FUNCTION__])) {
1586 $GLOBALS[__FUNCTION__] = getConfig('secret_key');
1590 return $GLOBALS[__FUNCTION__];
1593 // "Getter" for SITE_KEY
1594 function getSiteKey () {
1595 // Do we have cache?
1596 if (!isset($GLOBALS[__FUNCTION__])) {
1598 $GLOBALS[__FUNCTION__] = getConfig('SITE_KEY');
1602 return $GLOBALS[__FUNCTION__];
1605 // "Getter" for DATE_KEY
1606 function getDateKey () {
1607 // Do we have cache?
1608 if (!isset($GLOBALS[__FUNCTION__])) {
1610 $GLOBALS[__FUNCTION__] = getConfig('DATE_KEY');
1614 return $GLOBALS[__FUNCTION__];
1617 // "Getter" for master_salt
1618 function getMasterSalt () {
1619 // Do we have cache?
1620 if (!isset($GLOBALS[__FUNCTION__])) {
1622 $GLOBALS[__FUNCTION__] = getConfig('master_salt');
1626 return $GLOBALS[__FUNCTION__];
1629 // "Getter" for prime
1630 function getPrime () {
1631 // Do we have cache?
1632 if (!isset($GLOBALS[__FUNCTION__])) {
1634 $GLOBALS[__FUNCTION__] = getConfig('_PRIME');
1638 return $GLOBALS[__FUNCTION__];
1641 // "Getter" for encrypt_seperator
1642 function getEncryptSeperator () {
1643 // Do we have cache?
1644 if (!isset($GLOBALS[__FUNCTION__])) {
1646 $GLOBALS[__FUNCTION__] = getConfig('ENCRYPT_SEPERATOR');
1650 return $GLOBALS[__FUNCTION__];
1653 // "Getter" for mysql_prefix
1654 function getMysqlPrefix () {
1655 // Do we have cache?
1656 if (!isset($GLOBALS[__FUNCTION__])) {
1658 $GLOBALS[__FUNCTION__] = getConfig('_MYSQL_PREFIX');
1662 return $GLOBALS[__FUNCTION__];
1665 // "Getter" for table_type
1666 function getTableType () {
1667 // Do we have cache?
1668 if (!isset($GLOBALS[__FUNCTION__])) {
1670 $GLOBALS[__FUNCTION__] = getConfig('_TABLE_TYPE');
1674 return $GLOBALS[__FUNCTION__];
1677 // "Getter" for salt_length
1678 function getSaltLength () {
1679 // Do we have cache?
1680 if (!isset($GLOBALS[__FUNCTION__])) {
1682 $GLOBALS[__FUNCTION__] = getConfig('salt_length');
1686 return $GLOBALS[__FUNCTION__];
1689 // "Getter" for output_mode
1690 function getOutputMode () {
1691 // Do we have cache?
1692 if (!isset($GLOBALS[__FUNCTION__])) {
1694 $GLOBALS[__FUNCTION__] = getConfig('OUTPUT_MODE');
1698 return $GLOBALS[__FUNCTION__];
1701 // "Getter" for full_version
1702 function getFullVersion () {
1703 // Do we have cache?
1704 if (!isset($GLOBALS[__FUNCTION__])) {
1706 $GLOBALS[__FUNCTION__] = getConfig('FULL_VERSION');
1710 return $GLOBALS[__FUNCTION__];
1713 // "Getter" for title
1714 function getTitle () {
1715 // Do we have cache?
1716 if (!isset($GLOBALS[__FUNCTION__])) {
1718 $GLOBALS[__FUNCTION__] = getConfig('TITLE');
1722 return $GLOBALS[__FUNCTION__];
1725 // "Getter" for curr_svn_revision
1726 function getCurrentRepositoryRevision () {
1727 // Do we have cache?
1728 if (!isset($GLOBALS[__FUNCTION__])) {
1730 $GLOBALS[__FUNCTION__] = getConfig('CURRENT_REPOSITORY_REVISION');
1734 return $GLOBALS[__FUNCTION__];
1737 // "Getter" for server_url
1738 function getServerUrl () {
1739 // Do we have cache?
1740 if (!isset($GLOBALS[__FUNCTION__])) {
1742 $GLOBALS[__FUNCTION__] = getConfig('SERVER_URL');
1746 return $GLOBALS[__FUNCTION__];
1749 // "Getter" for mt_word
1750 function getMtWord () {
1751 // Do we have cache?
1752 if (!isset($GLOBALS[__FUNCTION__])) {
1754 $GLOBALS[__FUNCTION__] = getConfig('mt_word');
1758 return $GLOBALS[__FUNCTION__];
1761 // "Getter" for mt_word2
1762 function getMtWord2 () {
1763 // Do we have cache?
1764 if (!isset($GLOBALS[__FUNCTION__])) {
1766 $GLOBALS[__FUNCTION__] = getConfig('mt_word2');
1770 return $GLOBALS[__FUNCTION__];
1773 // "Getter" for main_title
1774 function getMainTitle () {
1775 // Do we have cache?
1776 if (!isset($GLOBALS[__FUNCTION__])) {
1778 $GLOBALS[__FUNCTION__] = getConfig('MAIN_TITLE');
1782 return $GLOBALS[__FUNCTION__];
1785 // "Getter" for file_hash
1786 function getFileHash () {
1787 // Do we have cache?
1788 if (!isset($GLOBALS[__FUNCTION__])) {
1790 $GLOBALS[__FUNCTION__] = getConfig('file_hash');
1794 return $GLOBALS[__FUNCTION__];
1797 // "Getter" for pass_scramble
1798 function getPassScramble () {
1799 // Do we have cache?
1800 if (!isset($GLOBALS[__FUNCTION__])) {
1802 $GLOBALS[__FUNCTION__] = getConfig('pass_scramble');
1806 return $GLOBALS[__FUNCTION__];
1809 // "Getter" for ap_inactive_since
1810 function getApInactiveSince () {
1811 // Do we have cache?
1812 if (!isset($GLOBALS[__FUNCTION__])) {
1814 $GLOBALS[__FUNCTION__] = getConfig('ap_inactive_since');
1818 return $GLOBALS[__FUNCTION__];
1821 // "Getter" for user_min_confirmed
1822 function getUserMinConfirmed () {
1823 // Do we have cache?
1824 if (!isset($GLOBALS[__FUNCTION__])) {
1826 $GLOBALS[__FUNCTION__] = getConfig('user_min_confirmed');
1830 return $GLOBALS[__FUNCTION__];
1833 // "Getter" for auto_purge
1834 function getAutoPurge () {
1835 // Do we have cache?
1836 if (!isset($GLOBALS[__FUNCTION__])) {
1838 $GLOBALS[__FUNCTION__] = getConfig('auto_purge');
1842 return $GLOBALS[__FUNCTION__];
1845 // "Getter" for bonus_userid
1846 function getBonusUserid () {
1847 // Do we have cache?
1848 if (!isset($GLOBALS[__FUNCTION__])) {
1850 $GLOBALS[__FUNCTION__] = getConfig('bonus_userid');
1854 return $GLOBALS[__FUNCTION__];
1857 // "Getter" for ap_inactive_time
1858 function getApInactiveTime () {
1859 // Do we have cache?
1860 if (!isset($GLOBALS[__FUNCTION__])) {
1862 $GLOBALS[__FUNCTION__] = getConfig('ap_inactive_time');
1866 return $GLOBALS[__FUNCTION__];
1869 // "Getter" for ap_dm_timeout
1870 function getApDmTimeout () {
1871 // Do we have cache?
1872 if (!isset($GLOBALS[__FUNCTION__])) {
1874 $GLOBALS[__FUNCTION__] = getConfig('ap_dm_timeout');
1878 return $GLOBALS[__FUNCTION__];
1881 // "Getter" for ap_tasks_time
1882 function getApTasksTime () {
1883 // Do we have cache?
1884 if (!isset($GLOBALS[__FUNCTION__])) {
1886 $GLOBALS[__FUNCTION__] = getConfig('ap_tasks_time');
1890 return $GLOBALS[__FUNCTION__];
1893 // "Getter" for ap_unconfirmed_time
1894 function getApUnconfirmedTime () {
1895 // Do we have cache?
1896 if (!isset($GLOBALS[__FUNCTION__])) {
1898 $GLOBALS[__FUNCTION__] = getConfig('ap_unconfirmed_time');
1902 return $GLOBALS[__FUNCTION__];
1905 // "Getter" for points
1906 function getPoints () {
1907 // Do we have cache?
1908 if (!isset($GLOBALS[__FUNCTION__])) {
1910 $GLOBALS[__FUNCTION__] = getConfig('POINTS');
1914 return $GLOBALS[__FUNCTION__];
1917 // "Getter" for slogan
1918 function getSlogan () {
1919 // Do we have cache?
1920 if (!isset($GLOBALS[__FUNCTION__])) {
1922 $GLOBALS[__FUNCTION__] = getConfig('SLOGAN');
1926 return $GLOBALS[__FUNCTION__];
1929 // "Getter" for copy
1930 function getCopy () {
1931 // Do we have cache?
1932 if (!isset($GLOBALS[__FUNCTION__])) {
1934 $GLOBALS[__FUNCTION__] = getConfig('COPY');
1938 return $GLOBALS[__FUNCTION__];
1941 // "Getter" for webmaster
1942 function getWebmaster () {
1943 // Do we have cache?
1944 if (!isset($GLOBALS[__FUNCTION__])) {
1946 $GLOBALS[__FUNCTION__] = getConfig('WEBMASTER');
1950 return $GLOBALS[__FUNCTION__];
1953 // "Getter" for sql_count
1954 function getSqlCount () {
1955 // Do we have cache?
1956 if (!isset($GLOBALS[__FUNCTION__])) {
1958 $GLOBALS[__FUNCTION__] = getConfig('sql_count');
1962 return $GLOBALS[__FUNCTION__];
1965 // "Getter" for num_templates
1966 function getNumTemplates () {
1967 // Do we have cache?
1968 if (!isset($GLOBALS[__FUNCTION__])) {
1970 $GLOBALS[__FUNCTION__] = getConfig('num_templates');
1974 return $GLOBALS[__FUNCTION__];
1977 // "Getter" for dns_cache_timeout
1978 function getDnsCacheTimeout () {
1979 // Do we have cache?
1980 if (!isset($GLOBALS[__FUNCTION__])) {
1982 $GLOBALS[__FUNCTION__] = getConfig('dns_cache_timeout');
1986 return $GLOBALS[__FUNCTION__];
1989 // "Getter" for menu_blur_spacer
1990 function getMenuBlurSpacer () {
1991 // Do we have cache?
1992 if (!isset($GLOBALS[__FUNCTION__])) {
1994 $GLOBALS[__FUNCTION__] = getConfig('menu_blur_spacer');
1998 return $GLOBALS[__FUNCTION__];
2001 // "Getter" for points_register
2002 function getPointsRegister () {
2003 // Do we have cache?
2004 if (!isset($GLOBALS[__FUNCTION__])) {
2006 $GLOBALS[__FUNCTION__] = getConfig('points_register');
2010 return $GLOBALS[__FUNCTION__];
2013 // "Getter" for points_ref
2014 function getPointsRef () {
2015 // Do we have cache?
2016 if (!isset($GLOBALS[__FUNCTION__])) {
2018 $GLOBALS[__FUNCTION__] = getConfig('points_ref');
2022 return $GLOBALS[__FUNCTION__];
2025 // "Getter" for ref_payout
2026 function getRefPayout () {
2027 // Do we have cache?
2028 if (!isset($GLOBALS[__FUNCTION__])) {
2030 $GLOBALS[__FUNCTION__] = getConfig('ref_payout');
2034 return $GLOBALS[__FUNCTION__];
2037 // "Getter" for online_timeout
2038 function getOnlineTimeout () {
2039 // Do we have cache?
2040 if (!isset($GLOBALS[__FUNCTION__])) {
2042 $GLOBALS[__FUNCTION__] = getConfig('online_timeout');
2046 return $GLOBALS[__FUNCTION__];
2049 // "Getter" for index_home
2050 function getIndexHome () {
2051 // Do we have cache?
2052 if (!isset($GLOBALS[__FUNCTION__])) {
2054 $GLOBALS[__FUNCTION__] = getConfig('index_home');
2058 return $GLOBALS[__FUNCTION__];
2061 // "Getter" for one_day
2062 function getOneDay () {
2063 // Do we have cache?
2064 if (!isset($GLOBALS[__FUNCTION__])) {
2066 $GLOBALS[__FUNCTION__] = getConfig('ONE_DAY');
2070 return $GLOBALS[__FUNCTION__];
2073 // "Getter" for activate_xchange
2074 function getActivateXchange () {
2075 // Do we have cache?
2076 if (!isset($GLOBALS[__FUNCTION__])) {
2078 $GLOBALS[__FUNCTION__] = getConfig('activate_xchange');
2082 return $GLOBALS[__FUNCTION__];
2085 // "Getter" for img_type
2086 function getImgType () {
2087 // Do we have cache?
2088 if (!isset($GLOBALS[__FUNCTION__])) {
2090 $GLOBALS[__FUNCTION__] = getConfig('img_type');
2094 return $GLOBALS[__FUNCTION__];
2097 // "Getter" for code_length
2098 function getCodeLength () {
2099 // Do we have cache?
2100 if (!isset($GLOBALS[__FUNCTION__])) {
2102 $GLOBALS[__FUNCTION__] = getConfig('code_length');
2106 return $GLOBALS[__FUNCTION__];
2109 // "Getter" for least_cats
2110 function getLeastCats () {
2111 // Do we have cache?
2112 if (!isset($GLOBALS[__FUNCTION__])) {
2114 $GLOBALS[__FUNCTION__] = getConfig('least_cats');
2118 return $GLOBALS[__FUNCTION__];
2121 // "Getter" for pass_len
2122 function getPassLen () {
2123 // Do we have cache?
2124 if (!isset($GLOBALS[__FUNCTION__])) {
2126 $GLOBALS[__FUNCTION__] = getConfig('pass_len');
2130 return $GLOBALS[__FUNCTION__];
2133 // "Getter" for admin_menu
2134 function getAdminMenu () {
2135 // Do we have cache?
2136 if (!isset($GLOBALS[__FUNCTION__])) {
2138 $GLOBALS[__FUNCTION__] = getConfig('admin_menu');
2142 return $GLOBALS[__FUNCTION__];
2145 // "Getter" for last_month
2146 function getLastMonth () {
2147 // Do we have cache?
2148 if (!isset($GLOBALS[__FUNCTION__])) {
2150 $GLOBALS[__FUNCTION__] = getConfig('last_month');
2154 return $GLOBALS[__FUNCTION__];
2157 // "Getter" for max_send
2158 function getMaxSend () {
2159 // Do we have cache?
2160 if (!isset($GLOBALS[__FUNCTION__])) {
2162 $GLOBALS[__FUNCTION__] = getConfig('max_send');
2166 return $GLOBALS[__FUNCTION__];
2169 // "Getter" for mails_page
2170 function getMailsPage () {
2171 // Do we have cache?
2172 if (!isset($GLOBALS[__FUNCTION__])) {
2174 $GLOBALS[__FUNCTION__] = getConfig('mails_page');
2178 return $GLOBALS[__FUNCTION__];
2181 // "Getter" for rand_no
2182 function getRandNo () {
2183 // Do we have cache?
2184 if (!isset($GLOBALS[__FUNCTION__])) {
2186 $GLOBALS[__FUNCTION__] = getConfig('rand_no');
2190 return $GLOBALS[__FUNCTION__];
2193 // "Getter" for __DB_NAME
2194 function getDbName () {
2195 // Do we have cache?
2196 if (!isset($GLOBALS[__FUNCTION__])) {
2198 $GLOBALS[__FUNCTION__] = getConfig('__DB_NAME');
2202 return $GLOBALS[__FUNCTION__];
2205 // "Getter" for DOMAIN
2206 function getDomain () {
2207 // Do we have cache?
2208 if (!isset($GLOBALS[__FUNCTION__])) {
2210 $GLOBALS[__FUNCTION__] = getConfig('DOMAIN');
2214 return $GLOBALS[__FUNCTION__];
2217 // "Getter" for proxy_username
2218 function getProxyUsername () {
2219 // Do we have cache?
2220 if (!isset($GLOBALS[__FUNCTION__])) {
2222 $GLOBALS[__FUNCTION__] = getConfig('proxy_username');
2226 return $GLOBALS[__FUNCTION__];
2229 // "Getter" for proxy_password
2230 function getProxyPassword () {
2231 // Do we have cache?
2232 if (!isset($GLOBALS[__FUNCTION__])) {
2234 $GLOBALS[__FUNCTION__] = getConfig('proxy_password');
2238 return $GLOBALS[__FUNCTION__];
2241 // "Getter" for proxy_host
2242 function getProxyHost () {
2243 // Do we have cache?
2244 if (!isset($GLOBALS[__FUNCTION__])) {
2246 $GLOBALS[__FUNCTION__] = getConfig('proxy_host');
2250 return $GLOBALS[__FUNCTION__];
2253 // "Getter" for proxy_port
2254 function getProxyPort () {
2255 // Do we have cache?
2256 if (!isset($GLOBALS[__FUNCTION__])) {
2258 $GLOBALS[__FUNCTION__] = getConfig('proxy_port');
2262 return $GLOBALS[__FUNCTION__];
2265 // "Getter" for SMTP_HOSTNAME
2266 function getSmtpHostname () {
2267 // Do we have cache?
2268 if (!isset($GLOBALS[__FUNCTION__])) {
2270 $GLOBALS[__FUNCTION__] = getConfig('SMTP_HOSTNAME');
2274 return $GLOBALS[__FUNCTION__];
2277 // "Getter" for SMTP_USER
2278 function getSmtpUser () {
2279 // Do we have cache?
2280 if (!isset($GLOBALS[__FUNCTION__])) {
2282 $GLOBALS[__FUNCTION__] = getConfig('SMTP_USER');
2286 return $GLOBALS[__FUNCTION__];
2289 // "Getter" for SMTP_PASSWORD
2290 function getSmtpPassword () {
2291 // Do we have cache?
2292 if (!isset($GLOBALS[__FUNCTION__])) {
2294 $GLOBALS[__FUNCTION__] = getConfig('SMTP_PASSWORD');
2298 return $GLOBALS[__FUNCTION__];
2301 // "Getter" for points_word
2302 function getPointsWord () {
2303 // Do we have cache?
2304 if (!isset($GLOBALS[__FUNCTION__])) {
2306 $GLOBALS[__FUNCTION__] = getConfig('points_word');
2310 return $GLOBALS[__FUNCTION__];
2313 // "Getter" for profile_lock
2314 function getProfileLock () {
2315 // Do we have cache?
2316 if (!isset($GLOBALS[__FUNCTION__])) {
2318 $GLOBALS[__FUNCTION__] = getConfig('profile_lock');
2322 return $GLOBALS[__FUNCTION__];
2325 // "Getter" for url_tlock
2326 function getUrlTlock () {
2327 // Do we have cache?
2328 if (!isset($GLOBALS[__FUNCTION__])) {
2330 $GLOBALS[__FUNCTION__] = getConfig('url_tlock');
2334 return $GLOBALS[__FUNCTION__];
2337 // Checks wether proxy configuration is used
2338 function isProxyUsed () {
2339 // Do we have cache?
2340 if (!isset($GLOBALS[__FUNCTION__])) {
2342 $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('sql_patches', '0.4.3')) && (getConfig('proxy_host') != '') && (getConfig('proxy_port') > 0));
2346 return $GLOBALS[__FUNCTION__];
2349 // Checks wether POST data contains selections
2350 function ifPostContainsSelections ($element = 'sel') {
2351 // Do we have cache?
2352 if (!isset($GLOBALS[__FUNCTION__][$element])) {
2354 $GLOBALS[__FUNCTION__][$element] = ((isPostRequestParameterSet($element)) && (countPostSelection($element) > 0));
2358 return $GLOBALS[__FUNCTION__][$element];
2361 // Checks wether verbose_sql is Y and returns true/false if so
2362 function isVerboseSqlEnabled () {
2363 // Do we have cache?
2364 if (!isset($GLOBALS[__FUNCTION__])) {
2366 $GLOBALS[__FUNCTION__] = ((isExtensionInstalledAndNewer('sql_patches', '0.0.7')) && (getConfig('verbose_sql') == 'Y'));
2370 return $GLOBALS[__FUNCTION__];
2373 // "Getter" for total user points
2374 function getTotalPoints ($userid) {
2375 // Do we have cache?
2376 if (!isset($GLOBALS[__FUNCTION__][$userid])) {
2377 // Init array for filter chain
2379 'userid' => $userid,
2383 // Run filter chain for getting more point values
2384 $data = runFilterChain('get_total_points', $data);
2387 $GLOBALS[__FUNCTION__][$userid] = $data['points'] - countSumTotalData($userid, 'user_data', 'used_points');
2391 return $GLOBALS[__FUNCTION__][$userid];
2394 // Wrapper to check if url_blacklist is enabled
2395 function isUrlBlacklistEnabled () {
2396 // Do we have cache?
2397 if (!isset($GLOBALS[__FUNCTION__])) {
2399 $GLOBALS[__FUNCTION__] = (getConfig('url_blacklist') == 'Y');
2403 return $GLOBALS[__FUNCTION__];
2406 // Checks wether direct payment is allowed in configuration
2407 function isDirectPaymentEnabled () {
2408 // Do we have cache?
2409 if (!isset($GLOBALS[__FUNCTION__])) {
2411 $GLOBALS[__FUNCTION__] = (getConfig('allow_direct_pay') == 'Y');
2415 return $GLOBALS[__FUNCTION__];
2418 // Wrapper to check if current task is for extension (not update)
2419 function isExtensionTask ($content) {
2420 // Do we have cache?
2421 if (!isset($GLOBALS[__FUNCTION__][$content['task_type'] . '_' . $content['infos']])) {
2423 $GLOBALS[__FUNCTION__][$content['task_type'] . '_' . $content['infos']] = (($content['task_type'] == 'EXTENSION') && (isExtensionNameValid($content['infos'])) && (!isExtensionInstalled($content['infos'])));
2427 return $GLOBALS[__FUNCTION__][$content['task_type'] . '_' . $content['infos']];
2430 // Wrapper to check if output mode is CSS
2431 function isCssOutputMode () {
2433 return (getScriptOutputMode() == 1);
2436 // Wrapper to check if output mode is HTML
2437 function isHtmlOutputMode () {
2439 return (getScriptOutputMode() == 0);
2442 // Wrapper to check if output mode is RAW
2443 function isRawOutputMode () {
2445 return (getScriptOutputMode() == -1);
2448 // Wrapper to generate a user email link
2449 function generateWrappedUserEmailLink ($email) {
2450 // Just call the inner function
2451 return generateEmailLink($email, 'user_data');
2454 // Wrapper to check if user points are locked
2455 function ifUserPointsLocked ($userid) {
2456 // Do we have cache?
2457 if (!isset($GLOBALS[__FUNCTION__][$userid])) {
2459 $GLOBALS[__FUNCTION__][$userid] = ((getFetchedUserData('userid', $userid, 'ref_payout') > 0) && (!isDirectPaymentEnabled()));
2463 return $GLOBALS[__FUNCTION__][$userid];
2466 // Appends a line to an existing file or creates it instantly with given content.
2467 // This function does always add a new-line character to every line.
2468 function appendLineToFile ($file, $line) {
2469 $fp = fopen($file, 'a') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot write to file ' . basename($file) . '!');
2470 fwrite($fp, $line . "\n");
2474 // Wrapper for changeDataInFile() but with full path added
2475 function changeDataInInclude ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
2477 $FQFN = getPath() . $FQFN;
2479 // Call inner function
2480 return changeDataInFile($FQFN, $comment, $prefix, $suffix, $DATA, $seek);
2483 // Wrapper for changing entries in config-local.php
2484 function changeDataInLocalConfigurationFile ($comment, $prefix, $suffix, $DATA, $seek = 0) {
2485 // Call the inner function
2486 return changeDataInInclude(getCachePath() . 'config-local.php', $comment, $prefix, $suffix, $DATA, $seek);
2489 // Shortens ucfirst(strtolower()) calls
2490 function firstCharUpperCase ($str) {
2491 return ucfirst(strtolower($str));
2494 // Shortens calls with configuration entry as first argument (the second will become obsolete in the future)
2495 function createConfigurationTimeSelections ($configEntry, $stamps, $align = 'center') {
2496 // Get the configuration entry
2497 $configValue = getConfig($configEntry);
2499 // Call inner method
2500 return createTimeSelections($configValue, $configEntry, $stamps, $align);
2503 // Shortens converting of German comma to Computer's version in POST data
2504 function convertCommaToDotInPostData ($postEntry) {
2505 // Read and convert given entry
2506 $postValue = convertCommaToDot(postRequestParameter($postEntry));
2508 // ... and set it again
2509 setPostRequestParameter($postEntry, $postValue);
2512 // Converts German commas to Computer's version in all entries
2513 function convertCommaToDotInPostDataArray (array $postEntries) {
2514 // Replace german decimal comma with computer decimal dot
2515 foreach ($postEntries as $entry) {
2516 // Is the entry there?
2517 if (isPostRequestParameterSet($entry)) {
2519 convertCommaToDotInPostData($entry);
2524 // Getter for 'check_double_email'
2525 function getCheckDoubleEmail () {
2526 // Is the cache entry set?
2527 if (!isset($GLOBALS[__FUNCTION__])) {
2528 // No, so determine it
2529 $GLOBALS[__FUNCTION__] = getConfig('check_double_email');
2532 // Return cached entry
2533 return $GLOBALS[__FUNCTION__];
2536 // Checks wether 'check_double_email' is "YES"
2537 function isCheckDoubleEmailEnabled () {
2538 // Is the cache entry set?
2539 if (!isset($GLOBALS[__FUNCTION__])) {
2540 // No, so determine it
2541 $GLOBALS[__FUNCTION__] = (getCheckDoubleEmail() == 'Y');
2544 // Return cached entry
2545 return $GLOBALS[__FUNCTION__];