fooRequestElementBar() functions renamed, adding of request parameters added:
[mailer.git] / inc / wrapper-functions.php
index 236300372037b127ae81da81092a936139fb5aa3..c9f97c7b212f8f057c1dc78425d2b18761572cb5 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                            *
@@ -137,25 +137,10 @@ function decodeString ($str, $decompress = true) {
        return $str;
 }
 
-// Smartly adds slashes
-function smartAddSlashes ($unquoted) {
-       // Do we have cache?
-       if (!isset($GLOBALS['smart_addslashes'][$unquoted])) {
-               // Remove slashe
-               $unquoted = str_replace("\\", '', $unquoted);
-
-               // Put it in cache and add slashes
-               $GLOBALS['smart_addslashes'][$unquoted] = addslashes($unquoted);
-       } // END - if
-
-       // Return result
-       return $GLOBALS['smart_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;
@@ -237,12 +222,12 @@ 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 (isExtensionActive('removeip')) {
+       if ((isExtensionActive('removeip')) && ($alwaysReal === false)) {
                // Then anonymize it
                $userAgent = getAnonymousUserAgent($userAgent);
        } // END - if
@@ -266,12 +251,23 @@ function detectReferer () {
        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')));
+}
+
 // Check wether we are installing
 function isInstalling () {
        // Determine wether we are installing
        if (!isset($GLOBALS['mxchange_installing'])) {
                // Check URL (css.php/js.php need this)
-               $GLOBALS['mxchange_installing'] = isGetRequestElementSet('installing');
+               $GLOBALS['mxchange_installing'] = isGetRequestParameterSet('installing');
        } // END - if
 
        // Return result
@@ -286,7 +282,13 @@ function isInstalled () {
                $GLOBALS['is_installed'] = (
                (
                        // First is config
-                       getConfig('MXCHANGE_INSTALLED') == 'Y'
+                       (
+                               (
+                                       isConfigEntrySet('MXCHANGE_INSTALLED')
+                               ) && (
+                                       getConfig('MXCHANGE_INSTALLED') == 'Y'
+                               )
+                       )
                ) || (
                        // New config file found and loaded
                        isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
@@ -312,7 +314,7 @@ function isInstalled () {
 
 // Check wether an admin is registered
 function isAdminRegistered () {
-       return (getConfig('ADMIN_REGISTERED') == 'Y');
+       return ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y'));
 }
 
 // Checks wether the reset mode is active
@@ -324,13 +326,13 @@ function isResetModeEnabled () {
 // Checks wether the debug mode is enabled
 function isDebugModeEnabled () {
        // Simply check it
-       return (getConfig('DEBUG_MODE') == 'Y');
+       return ((isConfigEntrySet('DEBUG_MODE')) && (getConfig('DEBUG_MODE') == 'Y'));
 }
 
 // Checks wether we shall debug regular expressions
 function isDebugRegExpressionEnabled () {
        // Simply check it
-       return (getConfig('DEBUG_REGEX') == 'Y');
+       return ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y'));
 }
 
 // Checks wether the cache instance is valid
@@ -382,14 +384,25 @@ 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
+       $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
+       foreach ($GLOBALS['header'] as $header) {
+               header($header);
+       } // END - foreach
+
+       // Mark them as flushed
+       $GLOBALS['header'] = array();
 }
 
 // Wrapper function for chmod()
@@ -422,8 +435,15 @@ function removeFile ($FQFN) {
 }
 
 // Wrapper for $_POST['sel']
-function countPostSelection () {
-       return countSelection(postRequestElement('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
@@ -437,15 +457,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 = ((isExtensionActive('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
@@ -482,12 +502,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']));
 
        // Should we abort here?
-       if (($abortOnMiss === true) && ($isset === false)) {
+       if (($strict === true) && ($isset === false)) {
                // Output backtrace
                debug_report_bug('what is empty.');
        } // END - if
@@ -517,12 +537,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']));
 
        // Should we abort here?
-       if (($abortOnMiss === true) && ($isset === false)) {
+       if (($strict === true) && ($isset === false)) {
                // Output backtrace
                debug_report_bug('action is empty.');
        } // END - if
@@ -532,12 +552,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
@@ -553,21 +573,18 @@ function setModule ($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
-               print '<pre>';
-               debug_print_backtrace();
-               die('</pre');
                debug_report_bug('module is empty.');
        } // END - if
 
        // Return it
-       return $isset;
+       return (($isset === true) && ($GLOBALS['module'] != 'unknown')) ;
 }
 
 // Getter for 'output_mode' value
@@ -587,16 +604,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
@@ -640,12 +657,14 @@ function redirectToIndexMemberOnlyModule () {
 // Wrapper function for checking if extension is installed and newer or same version
 function isExtensionInstalledAndNewer ($ext_name, $version) {
        // Return it
+       //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'=&gt;'.$version.'<br />';
        return ((isExtensionInstalled($ext_name)) && (getExtensionVersion($ext_name) >= $version));
 }
 
 // Wrapper function for checking if extension is installed and older than given version
 function isExtensionInstalledAndOlder ($ext_name, $version) {
        // Return it
+       //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'&lt;'.$version.'<br />';
        return ((isExtensionInstalled($ext_name)) && (isExtensionOlder($ext_name, $version)));
 }
 
@@ -700,5 +719,84 @@ 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 () {
+       // User id should not be zero
+       if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
+
+       // Get the whole array
+       return $GLOBALS['user_data'][getCurrentUserId()];
+}
+
+// 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 the array there and filled?
+       return ((isset($GLOBALS['user_data'][getCurrentUserId()])) && (count($GLOBALS['user_data'][getCurrentUserId()]) > 1));
+}
+
+// Setter for current userid
+function setCurrentUserId ($userid) {
+       $GLOBALS['current_userid'] = bigintval($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']);
+}
+
+// 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) {
+       // 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
+
+       // Return it
+       return $data;
+}
+
 // [EOF]
 ?>