<?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 *
* 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) {
- // 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));
- }
+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
- // 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;
// 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.
} // 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 = constant('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 = constant('PATH') . $INC;
-
- // Is it readable?
- return isFileReadable($FQFN);
-}
-
// Encode strings
// @TODO Implement $compress
function encodeString ($str, $compress = 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;
// Merges an array together but only if both are arrays
function merge_array ($array1, $array2) {
// Are both an array?
- if ((is_array($array1)) && (is_array($array2))) {
- // Merge all together
- return array_merge($array1, $array2);
- } elseif (is_array($array1)) {
- // Return left array
- DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("array2 is not an array. array != %s", gettype($array2)));
- return $array1;
- } elseif (is_array($array2)) {
- // Return right array
- DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("array1 is not an array. array != %s", gettype($array1)));
- return $array2;
+ if ((!is_array($array1)) && (!is_array($array2))) {
+ // Both are not arrays
+ debug_report_bug(__FUNCTION__ . ': No arrays provided!');
+ } elseif (!is_array($array1)) {
+ // Left one is not an array
+ 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(sprintf("[%s:%s] array2 is not an array. array != %s", __FUNCTION__, __LINE__, gettype($array2)));
}
- // Both are not arrays
- debug_report_bug(__FUNCTION__.": No arrays provided!");
+ // Merge all together
+ return array_merge($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
$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
$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
}
// "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
$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('&', '&', (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['mxchange_installing'])) {
+ // Check URL (css.php/js.php need this)
+ $GLOBALS['mxchange_installing'] = isGetRequestParameterSet('installing');
+ } // END - if
+
+ // Return result
+ return $GLOBALS['mxchange_installing'];
}
// Check wether this script is installed
function isInstalled () {
- return ((getConfig('MXCHANGE_INSTALLED') == 'Y') || (isIncludeReadable('inc/cache/config-local.php')));
+ // Do we have cache?
+ if (!isset($GLOBALS['is_installed'])) {
+ // Determine wether this script is installed
+ $GLOBALS['is_installed'] = (
+ (
+ // First is config
+ (
+ (
+ 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');
+ return ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y'));
}
// Checks wether the reset mode is active
// 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 SQL debugging is enabled
+function isSqlDebuggingEnabled () {
+ return ((isConfigEntrySet('DEBUG_SQL')) && (getConfig('DEBUG_SQL') == 'Y'));
+}
+
+// Checks wether we shall debug regular expressions
+function isDebugRegExpressionEnabled () {
+ // Simply check it
+ return ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y'));
}
// Checks wether the cache instance is valid
// Is the target directory there?
if (!isDirectory(dirname($dest))) {
// Then abort here
- debug_report_bug('Cannot find directory ' . str_replace(constant('PATH'), '', dirname($dest)) . '.');
+ debug_report_bug('Cannot find directory ' . str_replace(getConfig('PATH'), '', dirname($dest)) . '.');
} // END - if
// Now try to copy it
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)) {
// 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($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()
// @TODO Do some more sanity check here
function changeMode ($FQFN, $mode) {
// Is the file/directory there?
- if ((!isFile($FQFN)) && (!isDirectory($FQFN))) {
+ if ((!isFileReadable($FQFN)) && (!isDirectory($FQFN))) {
// Neither, so abort here
debug_report_bug('Cannot chmod() on ' . basename($FQFN) . '.');
} // END - if
chmod($FQFN, $mode);
}
+// Wrapper for unlink()
+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
+
+ // All fine if no file was removed. If we change this to 'false' or rewrite
+ // above if() block it would be to restrictive.
+ return true;
+}
+
// 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
return ((isset($GLOBALS['config_local_loaded'])) && ($GLOBALS['config_local_loaded'] === true));
}
+// Checks wether a nickname or userid was entered and caches the result
+function isNicknameUsed ($userid) {
+ // Default is false
+ $isUsed = false;
+
+ // Is the cache there
+ if (isset($GLOBALS['is_nickname_used'][$userid])) {
+ // Then use it
+ $isUsed = $GLOBALS['is_nickname_used'][$userid];
+ } else {
+ // Determine it
+ $isUsed = (('' . round($userid) . '') != $userid);
+
+ // And write it to the cache
+ $GLOBALS['is_nickname_used'][$userid] = $isUsed;
+ }
+
+ // Return the result
+ return $isUsed;
+}
+
+// Getter for 'what' value
+function getWhat () {
+ // Default is null
+ $what = null;
+
+ // Is the value set?
+ if (isWhatSet(true)) {
+ // Then use it
+ $what = $GLOBALS['what'];
+ } // END - if
+
+ // Return it
+ return $what;
+}
+
+// Setter for 'what' value
+function setWhat ($newWhat) {
+ $GLOBALS['what'] = SQL_ESCAPE($newWhat);
+}
+
+// Setter for 'what' from configuration
+function setWhatFromConfig ($configEntry) {
+ // Get 'what' from config
+ $what = getConfig($configEntry);
+
+ // Set it
+ setWhat($what);
+}
+
+// Checks wether what is set and optionally aborts on miss
+function isWhatSet ($strict = false) {
+ // Check for it
+ $isset = isset($GLOBALS['what']);
+
+ // Should we abort here?
+ if (($strict === true) && ($isset === false)) {
+ // Output backtrace
+ debug_report_bug('what is empty.');
+ } // END - if
+
+ // Return it
+ return $isset;
+}
+
+// Getter for 'action' value
+function getAction () {
+ // Default is null
+ $action = null;
+
+ // Is the value set?
+ if (isActionSet(true)) {
+ // Then use it
+ $action = $GLOBALS['action'];
+ } // END - if
+
+ // Return it
+ return $action;
+}
+
+// Setter for 'action' value
+function setAction ($newAction) {
+ $GLOBALS['action'] = SQL_ESCAPE($newAction);
+}
+
+// Checks wether action is set and optionally aborts on miss
+function isActionSet ($strict = false) {
+ // Check for it
+ $isset = ((isset($GLOBALS['action'])) && (!empty($GLOBALS['action'])));
+
+ // Should we abort here?
+ if (($strict === true) && ($isset === false)) {
+ // Output backtrace
+ debug_report_bug('action is empty.');
+ } // END - if
+
+ // Return it
+ return $isset;
+}
+
+// Getter for 'module' value
+function getModule ($strict = true) {
+ // Default is null
+ $module = null;
+
+ // Is the value set?
+ if (isModuleSet($strict)) {
+ // Then use it
+ $module = $GLOBALS['module'];
+ } // END - if
+
+ // Return it
+ return $module;
+}
+
+// Setter for 'module' value
+function setModule ($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 ($strict = false) {
+ // Check for it
+ $isset = (!empty($GLOBALS['module']));
+
+ // Should we abort here?
+ if (($strict === true) && ($isset === false)) {
+ // Output backtrace
+ debug_report_bug('module is empty.');
+ } // END - if
+
+ // Return it
+ return (($isset === true) && ($GLOBALS['module'] != 'unknown')) ;
+}
+
+// Getter for 'output_mode' value
+function getOutputMode () {
+ // Default is null
+ $output_mode = null;
+
+ // Is the value set?
+ if (isOutputModeSet(true)) {
+ // Then use it
+ $output_mode = $GLOBALS['output_mode'];
+ } // END - if
+
+ // Return it
+ return $output_mode;
+}
+
+// Setter for 'output_mode' value
+function setOutputMode ($newOutputMode) {
+ $GLOBALS['output_mode'] = (int) $newOutputMode;
+}
+
+// Checks wether output_mode is set and optionally aborts on miss
+function isOutputModeSet ($strict = false) {
+ // Check for it
+ $isset = (isset($GLOBALS['output_mode']));
+
+ // Should we abort here?
+ if (($strict === true) && ($isset === false)) {
+ // Output backtrace
+ debug_report_bug('output_mode is empty.');
+ } // END - if
+
+ // Return it
+ return $isset;
+}
+
+// Enables block-mode
+function enableBlockMode ($enabled = true) {
+ $GLOBALS['block_mode'] = $enabled;
+}
+
+// Checks wether block-mode is enabled
+function isBlockModeEnabled () {
+ // Abort if not set
+ if (!isset($GLOBALS['block_mode'])) {
+ // Needs to be fixed
+ debug_report_bug(__FUNCTION__ . ': block_mode is not set.');
+ } // END - if
+
+ // Return it
+ 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 for checking if extension is installed and newer or same version
+function isExtensionInstalledAndNewer ($ext_name, $version) {
+ // Return it
+ //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'=>'.$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.'<'.$version.'<br />';
+ return ((isExtensionInstalled($ext_name)) && (isExtensionOlder($ext_name, $version)));
+}
+
+// Set username
+function setUsername ($userName) {
+ $GLOBALS['username'] = (string) $userName;
+}
+
+// Get username
+function getUsername () {
+ // default is guest
+ $username = getMessage('USERNAME_GUEST');
+
+ // User name set?
+ if (isset($GLOBALS['username'])) {
+ // Use the set name
+ $username = $GLOBALS['username'];
+ } // END - if
+
+ // Return it
+ return $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 () {
+ return ((isExtensionActive('demo')) && (getSession('admin_login') == 'demo'));
+}
+
+// Wrapper function to redirect to de-refered URL
+function redirectToDereferedUrl ($URL) {
+ // De-refer the URL
+ $URL = generateDerefererUrl($URL);
+
+ // Redirect to to
+ redirectToUrl($URL);
+}
+
+// Getter for PHP caching value
+function getPhpCaching () {
+ return $GLOBALS['php_caching'];
+}
+
+// Checks wether the admin hash is set
+function isAdminHashSet ($admin) {
+ if (!isset($GLOBALS['cache_array']['admin'])) debug_report_bug('Cache not set.');
+ 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 () {
+ // 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]
?>
projects / mailer.git / blobdiff