Proper cache hit counting fixed
[mailer.git] / inc / wrapper-functions.php
index c59e12c9230ff867178214fe42712c79bf40bd95..48db9bbc05b706263abad490660594bfce5b9fb4 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /************************************************************************
- * MXChange v0.2.1                                    Start: 04/04/2009 *
- * ===============                              Last change: 04/04/2009 *
+ * Mailer v0.2.1-FINAL                                Start: 04/04/2009 *
+ * ===================                          Last change: 04/04/2009 *
  *                                                                      *
  * -------------------------------------------------------------------- *
  * File              : wrapper-functions.php                            *
@@ -17,7 +17,8 @@
  * Needs to be in all Files and every File needs "svn propset           *
  * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  * -------------------------------------------------------------------- *
- * Copyright (c) 2003 - 2008 by Roland Haeder                           *
+ * Copyright (c) 2003 - 2009 by Roland Haeder                           *
+ * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
  * For more information visit: http://www.mxchange.org                  *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
 
 // Some security stuff...
 if (!defined('__SECURITY')) {
-       $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
-       require($INC);
+       die();
 } // END - if
 
 // Read a given file
-function readFromFile ($FQFN, $sqlPrepare = false) {
+function readFromFile ($FQFN) {
        // Sanity-check if file is there (should be there, but just to make it sure)
        if (!isFileReadable($FQFN)) {
                // This should not happen
                debug_report_bug(__FUNCTION__.': File ' . basename($FQFN) . ' is not readable!');
        } // END - if
 
-       // Load the file
-       if (function_exists('file_get_contents')) {
-               // Use new function
-               $content = file_get_contents($FQFN);
-       } else {
-               // Fall-back to implode-file chain
-               $content = implode('', file($FQFN));
-       }
-
-       // Prepare SQL queries?
-       if ($sqlPrepare === true) {
-               // Remove some unwanted chars
-               $content = str_replace("\r", '', $content);
-               $content = str_replace("\n\n", "\n", $content);
+       // Is it cached?
+       if (!isset($GLOBALS['file_content'][$FQFN])) {
+               // Load the file
+               if (function_exists('file_get_contents')) {
+                       // Use new function
+                       $GLOBALS['file_content'][$FQFN] = file_get_contents($FQFN);
+               } else {
+                       // Fall-back to implode-file chain
+                       $GLOBALS['file_content'][$FQFN] = implode('', file($FQFN));
+               }
        } // END - if
 
        // Return the content
-       return $content;
+       return $GLOBALS['file_content'][$FQFN];
 }
 
 // Writes content to a file
-function writeToFile ($FQFN, $content) {
+function writeToFile ($FQFN, $content, $aquireLock = false) {
        // Is the file writeable?
        if ((isFileReadable($FQFN)) && (!is_writeable($FQFN)) && (!changeMode($FQFN, 0644))) {
                // Not writeable!
-               DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("File %s not writeable.", basename($FQFN)));
+               logDebugMessage(__FUNCTION__, __LINE__, sprintf("File %s not writeable.", basename($FQFN)));
 
                // Failed! :(
                return false;
@@ -86,20 +82,36 @@ function writeToFile ($FQFN, $content) {
 
        // Is the function there?
        if (function_exists('file_put_contents')) {
-               // Write it directly
-               $return = file_put_contents($FQFN, $content);
+               // With lock?
+               if ($aquireLock === true) {
+                       // Write it directly with lock
+                       $return = file_put_contents($FQFN, $content, LOCK_EX);
+               } else {
+                       // Write it directly
+                       $return = file_put_contents($FQFN, $content);
+               }
        } else {
                // Write it with fopen
                $fp = fopen($FQFN, 'w') or app_die(__FUNCTION__, __LINE__, "Cannot write file ".basename($FQFN).'!');
+
+               // Aquire lock
+               if ($aquireLock === true) flock($fp, LOCK_EX);
+
+               // Write content
                fwrite($fp, $content);
-               fclose($fp);
 
-               // Set CHMOD rights
-               $return = changeMode($FQFN, 0644);
+               // Close stream
+               fclose($fp);
        }
 
+       // Mark it as readable
+       $GLOBALS['file_readable'][$FQFN] = true;
+
+       // Remember content in cache
+       $GLOBALS['file_content'][$FQFN] = $content;
+
        // Return status
-       return $return;
+       return changeMode($FQFN, 0644);
 }
 
 // Clears the output buffer. This function does *NOT* backup sent content.
@@ -111,43 +123,6 @@ function clearOutputBuffer () {
        } // END - if
 }
 
-// Loads an include file and logs any missing files for debug purposes
-function loadInclude ($INC) {
-       // Add the path. This is why we need a trailing slash in config.php
-       $FQFN = getConfig('PATH') . $INC;
-
-       // Is the include file there?
-       if (!isIncludeReadable($INC)) {
-               // Not there so log it
-               debug_report_bug(sprintf("Include file %s not found.", $INC));
-               return false;
-       } // END - if
-
-       // Try to load it
-       require($FQFN);
-}
-
-// Loads an include file once
-function loadIncludeOnce ($INC) {
-       // Is it not loaded?
-       if (!isset($GLOBALS['load_once'][$INC])) {
-               // Mark it as loaded
-               $GLOBALS['load_once'][$INC] = 'loaded';
-
-               // Then try to load it
-               loadInclude($INC);
-       } // END - if
-}
-
-// Checks wether an include file (non-FQFN better) is readable
-function isIncludeReadable ($INC) {
-       // Construct FQFN
-       $FQFN = getConfig('PATH') . $INC;
-
-       // Is it readable?
-       return isFileReadable($FQFN);
-}
-
 // Encode strings
 // @TODO Implement $compress
 function encodeString ($str, $compress = true) {
@@ -162,16 +137,10 @@ function decodeString ($str, $decompress = true) {
        return $str;
 }
 
-// Smartly adds slashes
-function smartAddSlashes ($unquoted) {
-       $unquoted = str_replace("\\", '', $unquoted);
-       return addslashes($unquoted);
-}
-
 // Decode entities in a nicer way
-function decodeEntities ($str) {
+function decodeEntities ($str, $quote = ENT_NOQUOTES) {
        // Decode the entities to UTF-8 now
-       $decodedString = html_entity_decode($str, ENT_NOQUOTES, 'UTF-8');
+       $decodedString = html_entity_decode($str, $quote, 'UTF-8');
 
        // Return decoded string
        return $decodedString;
@@ -185,10 +154,10 @@ function merge_array ($array1, $array2) {
                debug_report_bug(__FUNCTION__ . ': No arrays provided!');
        } elseif (!is_array($array1)) {
                // Left one is not an array
-               debug_report_bug(__FUNCTION__, sprintf("array1 is not an array. array != %s", gettype($array1)));
+               debug_report_bug(sprintf("[%s:%s] array1 is not an array. array != %s", __FUNCTION__, __LINE__, gettype($array1)));
        } elseif (!is_array($array2)) {
                // Right one is not an array
-               debug_report_bug(__FUNCTION__, sprintf("array2 is not an array. array != %s", gettype($array2)));
+               debug_report_bug(sprintf("[%s:%s] array2 is not an array. array != %s", __FUNCTION__, __LINE__, gettype($array2)));
        }
 
        // Merge all together
@@ -197,20 +166,35 @@ function merge_array ($array1, $array2) {
 
 // Check if given FQFN is a readable file
 function isFileReadable ($FQFN) {
-       // Check all...
-       return ((file_exists($FQFN)) && (is_file($FQFN)) && (is_readable($FQFN)));
+       // Do we have cache?
+       if (!isset($GLOBALS['file_readable'][$FQFN])) {
+               // Check all...
+               $GLOBALS['file_readable'][$FQFN] = ((file_exists($FQFN)) && (is_file($FQFN)) && (is_readable($FQFN)));
+
+               // Debug message
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . basename($FQFN) . ' - CHECK! (' . intval($GLOBALS['file_readable'][$FQFN]) . ')');
+       } else {
+               // Cache used
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . basename($FQFN) . ' - CACHE! (' . intval($GLOBALS['file_readable'][$FQFN]) . ')');
+       }
+
+       // Return result
+       return $GLOBALS['file_readable'][$FQFN];
 }
 
-// Checks wether the given FQFN is a directory and not .,.. or .svn
+// Checks wether the given FQFN is a directory and not ., .. or .svn
 function isDirectory ($FQFN) {
-       // Generate baseName
-       $baseName = basename($FQFN);
+       // Do we have cache?
+       if (!isset($GLOBALS['is_directory'][$FQFN])) {
+               // Generate baseName
+               $baseName = basename($FQFN);
 
-       // Check it
-       $isDirectory = ((is_dir($FQFN)) && ($baseName != '.') && ($baseName != '..') && ($baseName != '.svn'));
+               // Check it
+               $GLOBALS['is_directory'][$FQFN] = ((is_dir($FQFN)) && ($baseName != '.') && ($baseName != '..') && ($baseName != '.svn'));
+       } // END - if
 
        // Return the result
-       return $isDirectory;
+       return $GLOBALS['is_directory'][$FQFN];
 }
 
 // "Getter" for remote IP number
@@ -219,9 +203,9 @@ function detectRemoteAddr () {
        $remoteAddr = determineRealRemoteAddress();
 
        // Is removeip installed?
-       if (EXT_IS_ACTIVE('removeip')) {
+       if (isExtensionActive('removeip')) {
                // Then anonymize it
-               $remoteAddr = GET_ANONYMOUS_REMOTE_ADDR($remoteAddr);
+               $remoteAddr = getAnonymousRemoteAddress($remoteAddr);
        } // END - if
 
        // Return it
@@ -234,9 +218,9 @@ function detectRemoteHostname () {
        $remoteHost = getenv('REMOTE_HOST');
 
        // Is removeip installed?
-       if (EXT_IS_ACTIVE('removeip')) {
+       if (isExtensionActive('removeip')) {
                // Then anonymize it
-               $remoteHost = GET_ANONYMOUS_REMOTE_HOST($remoteHost);
+               $remoteHost = getAnonymousRemoteHost($remoteHost);
        } // END - if
 
        // Return it
@@ -244,14 +228,14 @@ function detectRemoteHostname () {
 }
 
 // "Getter" for user agent
-function detectUserAgent () {
+function detectUserAgent ($alwaysReal = false) {
        // Get remote ip from environment
        $userAgent = getenv('HTTP_USER_AGENT');
 
        // Is removeip installed?
-       if (EXT_IS_ACTIVE('removeip')) {
+       if ((isExtensionActive('removeip')) && ($alwaysReal === false)) {
                // Then anonymize it
-               $userAgent = GET_ANONYMOUS_USER_AGENT($userAgent);
+               $userAgent = getAnonymousUserAgent($userAgent);
        } // END - if
 
        // Return it
@@ -264,51 +248,92 @@ function detectReferer () {
        $referer = getenv('HTTP_REFERER');
 
        // Is removeip installed?
-       if (EXT_IS_ACTIVE('removeip')) {
+       if (isExtensionActive('removeip')) {
                // Then anonymize it
-               $referer = GET_ANONYMOUS_REFERER($referer);
+               $referer = getAnonymousReferer($referer);
        } // END - if
 
        // Return it
        return $referer;
 }
 
+// "Getter" for request URI
+function detectRequestUri () {
+       // Return it
+       return (getenv('REQUEST_URI'));
+}
+
+// "Getter" for query string
+function detectQueryString () {
+       return str_replace('&', '&amp;', (getenv('QUERY_STRING')));
+}
+
+// "Getter" for SERVER_NAME
+function detectServerName () {
+       // Return it
+       return (getenv('SERVER_NAME'));
+}
+
 // Check wether we are installing
 function isInstalling () {
-       $installing = ((isset($GLOBALS['mxchange_installing'])) || (REQUEST_ISSET_GET('installing')));
-       //* DEBUG: */ var_dump($installing);
-       return $installing;
+       // Determine wether we are installing
+       if (!isset($GLOBALS['mailer_installing'])) {
+               // Check URL (css.php/js.php need this)
+               $GLOBALS['mailer_installing'] = isGetRequestParameterSet('installing');
+       } // END - if
+
+       // Return result
+       return $GLOBALS['mailer_installing'];
 }
 
 // Check wether this script is installed
 function isInstalled () {
-       return (
-       (
-               // New config file found and loaded
-               isIncludeReadable('inc/cache/config-local.php')
-       ) || (
-               // Fall-back to config
-               getConfig('MXCHANGE_INSTALLED') == 'Y'
-       ) || (
+       // Do we have cache?
+       if (!isset($GLOBALS['is_installed'])) {
+               // Determine wether this script is installed
+               $GLOBALS['is_installed'] = (
                (
-                       // New config file found, but not yet read
-                       isIncludeReadable('inc/cache/config-local.php')
-               ) && (
+                       // First is config
                        (
-                               // Only new config file is found
-                               !isIncludeReadable('inc/config.php')
-                       ) || (
-                               // Is installation mode
-                               isInstalling()
+                               (
+                                       isConfigEntrySet('MXCHANGE_INSTALLED')
+                               ) && (
+                                       getConfig('MXCHANGE_INSTALLED') == 'Y'
+                               )
                        )
-               )
-       )
-       );
+               ) || (
+                       // New config file found and loaded
+                       isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
+               ) || (
+                       (
+                               // New config file found, but not yet read
+                               isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
+                       ) && (
+                               (
+                                       // Only new config file is found
+                                       !isIncludeReadable('inc/config.php')
+                               ) || (
+                                       // Is installation mode
+                                       !isInstalling()
+                               )
+                       )
+               ));
+       } // END - if
+
+       // Then use the cache
+       return $GLOBALS['is_installed'];
 }
 
 // Check wether an admin is registered
 function isAdminRegistered () {
-       return (getConfig('ADMIN_REGISTERED') == 'Y');
+       // Is cache set?
+       if (!isset($GLOBALS['is_admin_registered'])) {
+               // Simply check it
+               $GLOBALS['is_admin_registered'] = ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y'));
+       } // END - if
+
+       // Return it
+       return $GLOBALS['is_admin_registered'];
 }
 
 // Checks wether the reset mode is active
@@ -319,14 +344,38 @@ function isResetModeEnabled () {
 
 // Checks wether the debug mode is enabled
 function isDebugModeEnabled () {
-       // Simply check it
-       return (getConfig('DEBUG_MODE') == 'Y');
+       // Is cache set?
+       if (!isset($GLOBALS['is_debugmode_enabled'])) {
+               // Simply check it
+               $GLOBALS['is_debugmode_enabled'] = ((isConfigEntrySet('DEBUG_MODE')) && (getConfig('DEBUG_MODE') == 'Y'));
+       } // END - if
+
+       // Return it
+       return $GLOBALS['is_debugmode_enabled'];
+}
+
+// Checks wether SQL debugging is enabled
+function isSqlDebuggingEnabled () {
+       // Is cache set?
+       if (!isset($GLOBALS['is_sql_debug_enabled'])) {
+               // Determine if SQL debugging is enabled
+               $GLOBALS['is_sql_debug_enabled'] = ((isConfigEntrySet('DEBUG_SQL')) && (getConfig('DEBUG_SQL') == 'Y'));
+       } // END - if
+
+       // Return it
+       return $GLOBALS['is_sql_debug_enabled'];
 }
 
 // Checks wether we shall debug regular expressions
-function isDebugRegExpressionEnabled () {
-       // Simply check it
-       return (getConfig('DEBUG_REGEX') == 'Y');
+function isDebugRegularExpressionEnabled () {
+       // Is cache set?
+       if (!isset($GLOBALS['is_regular_exp_debug_enabled'])) {
+               // Simply check it
+               $GLOBALS['is_regular_exp_debug_enabled'] = ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y'));
+       } // END - if
+
+       // Return it
+       return $GLOBALS['is_regular_exp_debug_enabled'];
 }
 
 // Checks wether the cache instance is valid
@@ -357,7 +406,10 @@ function copyFileVerified ($source, $dest, $chmod = '') {
        if (!copy($source, $dest)) {
                // Something went wrong
                debug_report_bug('copy() has failed to copy the file.');
-       } // END - if
+       } else {
+               // Reset cache
+               $GLOBALS['file_readable'][$dest] = true;
+       }
 
        // If there are chmod rights set, apply them
        if (!empty($chmod)) {
@@ -375,14 +427,28 @@ function copyFileVerified ($source, $dest, $chmod = '') {
 // Wrapper function for header()
 // Send a header but checks before if we can do so
 function sendHeader ($header) {
+       // Send the header
+       //* DEBUG: */ logDebugMessage(__FUNCTION__ . ': header=' . $header);
+       $GLOBALS['header'][] = trim($header);
+}
+
+// Flushes all headers
+function flushHeaders () {
        // Is the header already sent?
        if (headers_sent()) {
                // Then abort here
                debug_report_bug('Headers already sent!');
        } // END - if
 
-       // Send the header
-       header(trim($header));
+       // Flush all headers if found
+       if ((isset($GLOBALS['header'])) && (is_array($GLOBALS['header']))) {
+               foreach ($GLOBALS['header'] as $header) {
+                       header($header);
+               } // END - foreach
+       } // END - if
+
+       // Mark them as flushed
+       $GLOBALS['header'] = array();
 }
 
 // Wrapper function for chmod()
@@ -402,6 +468,9 @@ function changeMode ($FQFN, $mode) {
 function removeFile ($FQFN) {
        // Is the file there?
        if (isFileReadable($FQFN)) {
+               // Reset cache first
+               $GLOBALS['file_readable'][$FQFN] = false;
+
                // Yes, so remove it
                return unlink($FQFN);
        } // END - if
@@ -412,8 +481,15 @@ function removeFile ($FQFN) {
 }
 
 // Wrapper for $_POST['sel']
-function countPostSelection () {
-       return countSelection(REQUEST_POST('sel'));
+function countPostSelection ($element = 'sel') {
+       // Is it set?
+       if (isPostRequestParameterSet($element)) {
+               // Return counted elements
+               return countSelection(postRequestParameter($element));
+       } else {
+               // Return zero if not found
+               return 0;
+       }
 }
 
 // Checks wether the config-local.php is loaded
@@ -427,15 +503,15 @@ function isNicknameUsed ($userid) {
        $isUsed = false;
 
        // Is the cache there
-       if (isset($GLOBALS['cache_probe_nicknames'][$userid])) {
+       if (isset($GLOBALS['is_nickname_used'][$userid])) {
                // Then use it
-               $isUsed = $GLOBALS['cache_probe_nicknames'][$userid];
+               $isUsed = $GLOBALS['is_nickname_used'][$userid];
        } else {
                // Determine it
-               $isUsed = ((EXT_IS_ACTIVE('nickname')) && (('' . round($userid) . '') != $userid));
+               $isUsed = (('' . round($userid) . '') != $userid);
 
                // And write it to the cache
-               $GLOBALS['cache_probe_nicknames'][$userid] = $isUsed;
+               $GLOBALS['is_nickname_used'][$userid] = $isUsed;
        }
 
        // Return the result
@@ -472,12 +548,12 @@ function setWhatFromConfig ($configEntry) {
 }
 
 // Checks wether what is set and optionally aborts on miss
-function isWhatSet ($abortOnMiss =  false) {
+function isWhatSet ($strict =  false) {
        // Check for it
-       $isset = (isset($GLOBALS['what']));
+       $isset = isset($GLOBALS['what']);
 
        // Should we abort here?
-       if (($abortOnMiss === true) && ($isset === false)) {
+       if (($strict === true) && ($isset === false)) {
                // Output backtrace
                debug_report_bug('what is empty.');
        } // END - if
@@ -507,12 +583,12 @@ function setAction ($newAction) {
 }
 
 // Checks wether action is set and optionally aborts on miss
-function isActionSet ($abortOnMiss =  false) {
+function isActionSet ($strict =  false) {
        // Check for it
-       $isset = (isset($GLOBALS['action']));
+       $isset = ((isset($GLOBALS['action'])) && (!empty($GLOBALS['action'])));
 
        // Should we abort here?
-       if (($abortOnMiss === true) && ($isset === false)) {
+       if (($strict === true) && ($isset === false)) {
                // Output backtrace
                debug_report_bug('action is empty.');
        } // END - if
@@ -522,12 +598,12 @@ function isActionSet ($abortOnMiss =  false) {
 }
 
 // Getter for 'module' value
-function getModule () {
+function getModule ($strict = true) {
        // Default is null
        $module = null;
 
        // Is the value set?
-       if (isModuleSet(true)) {
+       if (isModuleSet($strict)) {
                // Then use it
                $module = $GLOBALS['module'];
        } // END - if
@@ -538,22 +614,23 @@ function getModule () {
 
 // Setter for 'module' value
 function setModule ($newModule) {
-       $GLOBALS['module'] = SQL_ESCAPE($newModule);
+       // Secure it and make all modules lower-case
+       $GLOBALS['module'] = SQL_ESCAPE(strtolower($newModule));
 }
 
 // Checks wether module is set and optionally aborts on miss
-function isModuleSet ($abortOnMiss =  false) {
+function isModuleSet ($strict =  false) {
        // Check for it
        $isset = (!empty($GLOBALS['module']));
 
        // Should we abort here?
-       if (($abortOnMiss === true) && ($isset === false)) {
+       if (($strict === true) && ($isset === false)) {
                // Output backtrace
                debug_report_bug('module is empty.');
        } // END - if
 
        // Return it
-       return $isset;
+       return (($isset === true) && ($GLOBALS['module'] != 'unknown')) ;
 }
 
 // Getter for 'output_mode' value
@@ -573,16 +650,16 @@ function getOutputMode () {
 
 // Setter for 'output_mode' value
 function setOutputMode ($newOutputMode) {
-       $GLOBALS['output_mode'] = SQL_ESCAPE($newOutputMode);
+       $GLOBALS['output_mode'] = (int) $newOutputMode;
 }
 
 // Checks wether output_mode is set and optionally aborts on miss
-function isOutputModeSet ($abortOnMiss =  false) {
+function isOutputModeSet ($strict =  false) {
        // Check for it
        $isset = (isset($GLOBALS['output_mode']));
 
        // Should we abort here?
-       if (($abortOnMiss === true) && ($isset === false)) {
+       if (($strict === true) && ($isset === false)) {
                // Output backtrace
                debug_report_bug('output_mode is empty.');
        } // END - if
@@ -608,5 +685,261 @@ function isBlockModeEnabled () {
        return $GLOBALS['block_mode'];
 }
 
+// Wrapper function for addPointsThroughReferalSystem()
+function addPointsDirectly ($subject, $userid, $points) {
+       // Reset level here
+       unset($GLOBALS['ref_level']);
+
+       // Call more complicated method (due to more parameters)
+       return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, false, 'direct');
+}
+
+// Wrapper function to redirect from member-only modules to index
+function redirectToIndexMemberOnlyModule () {
+       // Do the redirect here
+       redirectToUrl('modules.php?module=index&code=' . getCode('MODULE_MEM_ONLY') . '&mod=' . getModule());
+}
+
+// Wrapper function to redirect to current URL
+function redirectToRequestUri () {
+       redirectToUrl(basename(detectRequestUri()));
+}
+
+// Wrapper function to redirect to de-refered URL
+function redirectToDereferedUrl ($URL) {
+       // Redirect to to
+       redirectToUrl(generateDerefererUrl($URL));
+}
+
+// Wrapper function for checking if extension is installed and newer or same version
+function isExtensionInstalledAndNewer ($ext_name, $version) {
+       // Is an cache entry found?
+       if (!isset($GLOBALS['ext_installed_newer'][$ext_name][$version])) {
+               $GLOBALS['ext_installed_newer'][$ext_name][$version] = ((isExtensionInstalled($ext_name)) && (getExtensionVersion($ext_name) >= $version));
+       } else {
+               // Cache hits should be incremented twice
+               incrementStatsEntry('cache_hits', 2);
+       }
+
+       // Return it
+       //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'=&gt;'.$version.':'.intval($GLOBALS['ext_installed_newer'][$ext_name][$version]).'<br />';
+       return $GLOBALS['ext_installed_newer'][$ext_name][$version];
+}
+
+// Wrapper function for checking if extension is installed and older than given version
+function isExtensionInstalledAndOlder ($ext_name, $version) {
+       // Is an cache entry found?
+       if (!isset($GLOBALS['ext_installed_older'][$ext_name][$version])) {
+               $GLOBALS['ext_installed_older'][$ext_name][$version] = ((isExtensionInstalled($ext_name)) && (isExtensionOlder($ext_name, $version)));
+       } else {
+               // Cache hits should be incremented twice
+               incrementStatsEntry('cache_hits', 2);
+       }
+
+       // Return it
+       //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'&lt;'.$version.':'.intval($GLOBALS['ext_installed_older'][$ext_name][$version]).'<br />';
+       return $GLOBALS['ext_installed_older'][$ext_name][$version];
+}
+
+// Set username
+function setUsername ($userName) {
+       $GLOBALS['username'] = (string) $userName;
+}
+
+// Get username
+function getUsername () {
+       // User name set?
+       if (!isset($GLOBALS['username'])) {
+               // No, so it has to be a guest
+               $GLOBALS['username'] = getMessage('USERNAME_GUEST');
+       } // END - if
+
+       // Return it
+       return $GLOBALS['username'];
+}
+
+// Wrapper function for installation phase
+function isInstallationPhase () {
+       // Do we have cache?
+       if (!isset($GLOBALS['installation_phase'])) {
+               // Determine it
+               $GLOBALS['installation_phase'] = ((!isInstalled()) || (isInstalling()));
+       } // END - if
+
+       // Return result
+       return $GLOBALS['installation_phase'];
+}
+
+// Checks wether the extension demo is actuve and the admin login is demo (password needs to be demo, too!)
+function isDemoModeActive () {
+       // Is cache set?
+       if (!isset($GLOBALS['demo_mode_active'])) {
+               // Simply check it
+               $GLOBALS['demo_mode_active'] = ((isExtensionActive('demo')) && (getSession('admin_login') == 'demo'));
+       } // END - if
+
+       // Return it
+       return $GLOBALS['demo_mode_active'];
+}
+
+// Getter for PHP caching value
+function getPhpCaching () {
+       return $GLOBALS['php_caching'];
+}
+
+// Checks wether the admin hash is set
+function isAdminHashSet ($admin) {
+       /**
+        * @TODO Do we really need this check? If yes, try to fix this:
+        * 1.:functions.php:2504, debug_get_mailable_backtrace(0)
+        * 2.:wrapper-functions.php:744, debug_report_bug(1)
+        * 3.:mysql-manager.php:728, isAdminHashSet(1)
+        * 4.:filters.php:384, isAdmin(0)
+        * 5.:debug_get_mailable_backtrace:2457, FILTER_DETERMINE_USERNAME(1)
+        * 6.:filter-functions.php:280, call_user_func_array(2)
+        * 7.:load_cache.php:74, runFilterChain(1)
+        * 8.:inc-functions.php:131, include(1)
+        * 9.:inc-functions.php:145, loadInclude(1)
+        * 10.:mysql-connect.php:104, loadIncludeOnce(1)
+        * 11.:inc-functions.php:131, include(1)
+        * 12.:inc-functions.php:145, loadInclude(1)
+        * 13.:config-global.php:106, loadIncludeOnce(1)
+        * 14.:js.php:57, require(1)
+        */
+       if (!isset($GLOBALS['cache_array']['admin'])) {
+               debug_report_bug('Cache not set.');
+       } // END - if
+
+       // Check for admin hash
+       return isset($GLOBALS['cache_array']['admin']['password'][$admin]);
+}
+
+// Setter for admin hash
+function setAdminHash ($admin, $hash) {
+       $GLOBALS['cache_array']['admin']['password'][$admin] = $hash;
+}
+
+// Init user data array
+function initUserData () {
+       // User id should not be zero
+       if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
+
+       // Init the user
+       $GLOBALS['user_data'][getCurrentUserId()] = array();
+}
+
+// Getter for user data
+function getUserData ($column) {
+       // User id should not be zero
+       if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
+
+       // Return the value
+       return $GLOBALS['user_data'][getCurrentUserId()][$column];
+}
+
+// Geter for whole user data array
+function getUserDataArray () {
+       // Get user id
+       $uid = getCurrentUserId();
+
+       // User id should not be zero
+       if ($uid < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
+
+       // Get the whole array if found
+       if (isset($GLOBALS['user_data'][$uid])) {
+               // Found, so return it
+               return $GLOBALS['user_data'][$uid];
+       } else {
+               // Return empty array
+               return array();
+       }
+}
+
+// Checks if the user data is valid, this may indicate that the user has logged
+// in, but you should use isMember() if you want to find that out.
+function isUserDataValid () {
+       // User id should not be zero so abort here
+       if (!isCurrentUserIdSet()) return false;
+
+       // Is it cached?
+       if (!isset($GLOBALS['is_userdata_valid'][getCurrentUserId()])) {
+               // Determine it
+               $GLOBALS['is_userdata_valid'][getCurrentUserId()] = ((isset($GLOBALS['user_data'][getCurrentUserId()])) && (count($GLOBALS['user_data'][getCurrentUserId()]) > 1));
+       } // END - if
+
+       // Return the result
+       return $GLOBALS['is_userdata_valid'][getCurrentUserId()];
+}
+
+// Setter for current userid
+function setCurrentUserId ($userid) {
+       // Set userid
+       $GLOBALS['current_userid'] = bigintval($userid);
+
+       // Unset it to re-determine the actual state
+       unset($GLOBALS['is_userdata_valid'][$userid]);
+}
+
+// Getter for current userid
+function getCurrentUserId () {
+       // Userid must be set before it can be used
+       if (!isCurrentUserIdSet()) {
+               // Not set
+               debug_report_bug('User id is not set.');
+       } // END - if
+
+       // Return the userid
+       return $GLOBALS['current_userid'];
+}
+
+// Checks if current userid is set
+function isCurrentUserIdSet () {
+       return ((isset($GLOBALS['current_userid'])) && ($GLOBALS['current_userid'] > 0));
+}
+
+// Checks wether we are debugging template cache
+function isDebuggingTemplateCache () {
+       return (getConfig('DEBUG_TEMPLATE_CACHE') == 'Y');
+}
+
+// Wrapper for fetchUserData() and getUserData() calls
+function getFetchedUserData ($keyColumn, $userid, $valueColumn) {
+       // Is it cached?
+       if (!isset($GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn])) {
+               // Default is 'guest'
+               $data = getMessage('USERNAME_GUEST');
+
+               // Can we fetch the user data?
+               if (($userid > 0) && (fetchUserData($userid, $keyColumn))) {
+                       // Now get the data back
+                       $data = getUserData($valueColumn);
+               } // END - if
+
+               // Cache it
+               $GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn] = $data;
+       } // END - if
+
+       // Return it
+       return $GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn];
+}
+
+// Wrapper for strpos() to ease porting from deprecated ereg() function
+function isInString ($needle, $haystack) {
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'needle=' . $needle . ', haystack=' . $haystack . ', returned=' . intval(strpos($haystack, $needle) !== false));
+       return (strpos($haystack, $needle) !== false);
+}
+
+// Wrapper for strpos() to ease porting from deprecated eregi() function
+// This function is case-insensitive
+function isInStringIgnoreCase ($needle, $haystack) {
+       return (isInString(strtolower($needle), strtolower($haystack)));
+}
+
+// Wrapper to check for if fatal errors where detected
+function ifFatalErrorsDetected () {
+       // Just call the inner function
+       return (getTotalFatalErrors() > 0);
+}
+
 // [EOF]
 ?>