inc/wrapper-functions.php

   1 <?php
   2 /************************************************************************
   3  * Mailer v0.2.1-FINAL                                Start: 04/04/2009 *
   4  * ===================                          Last change: 04/04/2009 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : wrapper-functions.php                            *
   8  * -------------------------------------------------------------------- *
   9  * Short description : Wrapper functions                                *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Wrapper-Funktionen                               *
  12  * -------------------------------------------------------------------- *
  13  * $Revision::                                                        $ *
  14  * $Date::                                                            $ *
  15  * $Tag:: 0.2.1-FINAL                                                 $ *
  16  * $Author::                                                          $ *
  17  * Needs to be in all Files and every File needs "svn propset           *
  18  * svn:keywords Date Revision" (autoprobset!) at least!!!!!!            *
  19  * -------------------------------------------------------------------- *
  20  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
  21  * For more information visit: http://www.mxchange.org                  *
  22  *                                                                      *
  23  * This program is free software; you can redistribute it and/or modify *
  24  * it under the terms of the GNU General Public License as published by *
  25  * the Free Software Foundation; either version 2 of the License, or    *
  26  * (at your option) any later version.                                  *
  27  *                                                                      *
  28  * This program is distributed in the hope that it will be useful,      *
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  31  * GNU General Public License for more details.                         *
  32  *                                                                      *
  33  * You should have received a copy of the GNU General Public License    *
  34  * along with this program; if not, write to the Free Software          *
  35  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  36  * MA  02110-1301  USA                                                  *
  37  ************************************************************************/
  38
  39 // Some security stuff...
  40 if (!defined('__SECURITY')) {
  41         die();
  42 } // END - if
  43
  44 // Read a given file
  45 function readFromFile ($FQFN, $sqlPrepare = false) {
  46         // Sanity-check if file is there (should be there, but just to make it sure)
  47         if (!isFileReadable($FQFN)) {
  48                 // This should not happen
  49                 debug_report_bug(__FUNCTION__.': File ' . basename($FQFN) . ' is not readable!');
  50         } // END - if
  51
  52         // Load the file
  53         if (function_exists('file_get_contents')) {
  54                 // Use new function
  55                 $content = file_get_contents($FQFN);
  56         } else {
  57                 // Fall-back to implode-file chain
  58                 $content = implode('', file($FQFN));
  59         }
  60
  61         // Prepare SQL queries?
  62         if ($sqlPrepare === true) {
  63                 // Remove some unwanted chars
  64                 $content = str_replace("\r", '', $content);
  65                 $content = str_replace("\n\n", "\n", $content);
  66         } // END - if
  67
  68         // Return the content
  69         return $content;
  70 }
  71
  72 // Writes content to a file
  73 function writeToFile ($FQFN, $content, $aquireLock = false) {
  74         // Is the file writeable?
  75         if ((isFileReadable($FQFN)) && (!is_writeable($FQFN)) && (!changeMode($FQFN, 0644))) {
  76                 // Not writeable!
  77                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File %s not writeable.", basename($FQFN)));
  78
  79                 // Failed! :(
  80                 return false;
  81         } // END - if
  82
  83         // By default all is failed...
  84         $return = false;
  85
  86         // Is the function there?
  87         if (function_exists('file_put_contents')) {
  88                 // With lock?
  89                 if ($aquireLock === true) {
  90                         // Write it directly with lock
  91                         $return = file_put_contents($FQFN, $content, LOCK_EX);
  92                 } else {
  93                         // Write it directly
  94                         $return = file_put_contents($FQFN, $content);
  95                 }
  96         } else {
  97                 // Write it with fopen
  98                 $fp = fopen($FQFN, 'w') or app_die(__FUNCTION__, __LINE__, "Cannot write file ".basename($FQFN).'!');
  99
 100                 // Aquire lock
 101                 if ($aquireLock === true) flock($fp, LOCK_EX);
 102
 103                 // Write content
 104                 fwrite($fp, $content);
 105
 106                 // Close stream
 107                 fclose($fp);
 108         }
 109
 110         // Mark it as readable
 111         $GLOBALS['file_readable'][$FQFN] = true;
 112
 113         // Return status
 114         return changeMode($FQFN, 0644);
 115 }
 116
 117 // Clears the output buffer. This function does *NOT* backup sent content.
 118 function clearOutputBuffer () {
 119         // Trigger an error on failure
 120         if (!ob_end_clean()) {
 121                 // Failed!
 122                 debug_report_bug(__FUNCTION__.': Failed to clean output buffer.');
 123         } // END - if
 124 }
 125
 126 // Encode strings
 127 // @TODO Implement $compress
 128 function encodeString ($str, $compress = true) {
 129         $str = urlencode(base64_encode(compileUriCode($str)));
 130         return $str;
 131 }
 132
 133 // Decode strings encoded with encodeString()
 134 // @TODO Implement $decompress
 135 function decodeString ($str, $decompress = true) {
 136         $str = compileUriCode(base64_decode(urldecode(compileUriCode($str))));
 137         return $str;
 138 }
 139
 140 // Decode entities in a nicer way
 141 function decodeEntities ($str, $quote = ENT_NOQUOTES) {
 142         // Decode the entities to UTF-8 now
 143         $decodedString = html_entity_decode($str, $quote, 'UTF-8');
 144
 145         // Return decoded string
 146         return $decodedString;
 147 }
 148
 149 // Merges an array together but only if both are arrays
 150 function merge_array ($array1, $array2) {
 151         // Are both an array?
 152         if ((!is_array($array1)) && (!is_array($array2))) {
 153                 // Both are not arrays
 154                 debug_report_bug(__FUNCTION__ . ': No arrays provided!');
 155         } elseif (!is_array($array1)) {
 156                 // Left one is not an array
 157                 debug_report_bug(sprintf("[%s:%s] array1 is not an array. array != %s", __FUNCTION__, __LINE__, gettype($array1)));
 158         } elseif (!is_array($array2)) {
 159                 // Right one is not an array
 160                 debug_report_bug(sprintf("[%s:%s] array2 is not an array. array != %s", __FUNCTION__, __LINE__, gettype($array2)));
 161         }
 162
 163         // Merge all together
 164         return array_merge($array1, $array2);
 165 }
 166
 167 // Check if given FQFN is a readable file
 168 function isFileReadable ($FQFN) {
 169         // Do we have cache?
 170         if (!isset($GLOBALS['file_readable'][$FQFN])) {
 171                 // Check all...
 172                 $GLOBALS['file_readable'][$FQFN] = ((file_exists($FQFN)) && (is_file($FQFN)) && (is_readable($FQFN)));
 173         } // END - if
 174
 175         // Return result
 176         return $GLOBALS['file_readable'][$FQFN];
 177 }
 178
 179 // Checks wether the given FQFN is a directory and not ., .. or .svn
 180 function isDirectory ($FQFN) {
 181         // Do we have cache?
 182         if (!isset($GLOBALS['is_directory'][$FQFN])) {
 183                 // Generate baseName
 184                 $baseName = basename($FQFN);
 185
 186                 // Check it
 187                 $GLOBALS['is_directory'][$FQFN] = ((is_dir($FQFN)) && ($baseName != '.') && ($baseName != '..') && ($baseName != '.svn'));
 188         } // END - if
 189
 190         // Return the result
 191         return $GLOBALS['is_directory'][$FQFN];
 192 }
 193
 194 // "Getter" for remote IP number
 195 function detectRemoteAddr () {
 196         // Get remote ip from environment
 197         $remoteAddr = determineRealRemoteAddress();
 198
 199         // Is removeip installed?
 200         if (isExtensionActive('removeip')) {
 201                 // Then anonymize it
 202                 $remoteAddr = getAnonymousRemoteAddress($remoteAddr);
 203         } // END - if
 204
 205         // Return it
 206         return $remoteAddr;
 207 }
 208
 209 // "Getter" for remote hostname
 210 function detectRemoteHostname () {
 211         // Get remote ip from environment
 212         $remoteHost = getenv('REMOTE_HOST');
 213
 214         // Is removeip installed?
 215         if (isExtensionActive('removeip')) {
 216                 // Then anonymize it
 217                 $remoteHost = getAnonymousRemoteHost($remoteHost);
 218         } // END - if
 219
 220         // Return it
 221         return $remoteHost;
 222 }
 223
 224 // "Getter" for user agent
 225 function detectUserAgent ($alwaysReal = false) {
 226         // Get remote ip from environment
 227         $userAgent = getenv('HTTP_USER_AGENT');
 228
 229         // Is removeip installed?
 230         if ((isExtensionActive('removeip')) && ($alwaysReal === false)) {
 231                 // Then anonymize it
 232                 $userAgent = getAnonymousUserAgent($userAgent);
 233         } // END - if
 234
 235         // Return it
 236         return $userAgent;
 237 }
 238
 239 // "Getter" for referer
 240 function detectReferer () {
 241         // Get remote ip from environment
 242         $referer = getenv('HTTP_REFERER');
 243
 244         // Is removeip installed?
 245         if (isExtensionActive('removeip')) {
 246                 // Then anonymize it
 247                 $referer = getAnonymousReferer($referer);
 248         } // END - if
 249
 250         // Return it
 251         return $referer;
 252 }
 253
 254 // "Getter" for request URI
 255 function detectRequestUri () {
 256         // Return it
 257         return (getenv('REQUEST_URI'));
 258 }
 259
 260 // Check wether we are installing
 261 function isInstalling () {
 262         // Determine wether we are installing
 263         if (!isset($GLOBALS['mxchange_installing'])) {
 264                 // Check URL (css.php/js.php need this)
 265                 $GLOBALS['mxchange_installing'] = isGetRequestElementSet('installing');
 266         } // END - if
 267
 268         // Return result
 269         return $GLOBALS['mxchange_installing'];
 270 }
 271
 272 // Check wether this script is installed
 273 function isInstalled () {
 274         // Do we have cache?
 275         if (!isset($GLOBALS['is_installed'])) {
 276                 // Determine wether this script is installed
 277                 $GLOBALS['is_installed'] = (
 278                 (
 279                         // First is config
 280                         (
 281                                 (
 282                                         isConfigEntrySet('MXCHANGE_INSTALLED')
 283                                 ) && (
 284                                         getConfig('MXCHANGE_INSTALLED') == 'Y'
 285                                 )
 286                         )
 287                 ) || (
 288                         // New config file found and loaded
 289                         isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
 290                 ) || (
 291                         (
 292                                 // New config file found, but not yet read
 293                                 isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
 294                         ) && (
 295                                 (
 296                                         // Only new config file is found
 297                                         !isIncludeReadable('inc/config.php')
 298                                 ) || (
 299                                         // Is installation mode
 300                                         !isInstalling()
 301                                 )
 302                         )
 303                 ));
 304         } // END - if
 305
 306         // Then use the cache
 307         return $GLOBALS['is_installed'];
 308 }
 309
 310 // Check wether an admin is registered
 311 function isAdminRegistered () {
 312         return ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y'));
 313 }
 314
 315 // Checks wether the reset mode is active
 316 function isResetModeEnabled () {
 317         // Now simply check it
 318         return ((isset($GLOBALS['reset_enabled'])) && ($GLOBALS['reset_enabled'] === true));
 319 }
 320
 321 // Checks wether the debug mode is enabled
 322 function isDebugModeEnabled () {
 323         // Simply check it
 324         return ((isConfigEntrySet('DEBUG_MODE')) && (getConfig('DEBUG_MODE') == 'Y'));
 325 }
 326
 327 // Checks wether we shall debug regular expressions
 328 function isDebugRegExpressionEnabled () {
 329         // Simply check it
 330         return ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y'));
 331 }
 332
 333 // Checks wether the cache instance is valid
 334 function isCacheInstanceValid () {
 335         return ((isset($GLOBALS['cache_instance'])) && (is_object($GLOBALS['cache_instance'])));
 336 }
 337
 338 // Copies a file from source to destination and verifies if that goes fine.
 339 // This function should wrap the copy() command and make a nicer debug backtrace
 340 // even if there is no xdebug extension installed.
 341 function copyFileVerified ($source, $dest, $chmod = '') {
 342         // Failed is the default
 343         $status = false;
 344
 345         // Is the source file there?
 346         if (!isFileReadable($source)) {
 347                 // Then abort here
 348                 debug_report_bug('Cannot read from source file ' . basename($source) . '.');
 349         } // END - if
 350
 351         // Is the target directory there?
 352         if (!isDirectory(dirname($dest))) {
 353                 // Then abort here
 354                 debug_report_bug('Cannot find directory ' . str_replace(getConfig('PATH'), '', dirname($dest)) . '.');
 355         } // END - if
 356
 357         // Now try to copy it
 358         if (!copy($source, $dest)) {
 359                 // Something went wrong
 360                 debug_report_bug('copy() has failed to copy the file.');
 361         } else {
 362                 // Reset cache
 363                 $GLOBALS['file_readable'][$dest] = true;
 364         }
 365
 366         // If there are chmod rights set, apply them
 367         if (!empty($chmod)) {
 368                 // Try to apply them
 369                 $status = changeMode($dest, $chmod);
 370         } else {
 371                 // All fine
 372                 $status = true;
 373         }
 374
 375         // All fine
 376         return $status;
 377 }
 378
 379 // Wrapper function for header()
 380 // Send a header but checks before if we can do so
 381 function sendHeader ($header) {
 382         // Is the header already sent?
 383         if (headers_sent()) {
 384                 // Then abort here
 385                 debug_report_bug('Headers already sent!');
 386         } // END - if
 387
 388         // Send the header
 389         header(trim($header));
 390 }
 391
 392 // Wrapper function for chmod()
 393 // @TODO Do some more sanity check here
 394 function changeMode ($FQFN, $mode) {
 395         // Is the file/directory there?
 396         if ((!isFileReadable($FQFN)) && (!isDirectory($FQFN))) {
 397                 // Neither, so abort here
 398                 debug_report_bug('Cannot chmod() on ' . basename($FQFN) . '.');
 399         } // END - if
 400
 401         // Try to set them
 402         chmod($FQFN, $mode);
 403 }
 404
 405 // Wrapper for unlink()
 406 function removeFile ($FQFN) {
 407         // Is the file there?
 408         if (isFileReadable($FQFN)) {
 409                 // Reset cache first
 410                 $GLOBALS['file_readable'][$FQFN] = false;
 411
 412                 // Yes, so remove it
 413                 return unlink($FQFN);
 414         } // END - if
 415
 416         // All fine if no file was removed. If we change this to 'false' or rewrite
 417         // above if() block it would be to restrictive.
 418         return true;
 419 }
 420
 421 // Wrapper for $_POST['sel']
 422 function countPostSelection ($element = 'sel') {
 423         // Is it set?
 424         if (isPostRequestElementSet($element)) {
 425                 // Return counted elements
 426                 return countSelection(postRequestElement($element));
 427         } else {
 428                 // Return zero if not found
 429                 return 0;
 430         }
 431 }
 432
 433 // Checks wether the config-local.php is loaded
 434 function isConfigLocalLoaded () {
 435         return ((isset($GLOBALS['config_local_loaded'])) && ($GLOBALS['config_local_loaded'] === true));
 436 }
 437
 438 // Checks wether a nickname or userid was entered and caches the result
 439 function isNicknameUsed ($userid) {
 440         // Default is false
 441         $isUsed = false;
 442
 443         // Is the cache there
 444         if (isset($GLOBALS['is_nickname_used'][$userid])) {
 445                 // Then use it
 446                 $isUsed = $GLOBALS['is_nickname_used'][$userid];
 447         } else {
 448                 // Determine it
 449                 $isUsed = (('' . round($userid) . '') != $userid);
 450
 451                 // And write it to the cache
 452                 $GLOBALS['is_nickname_used'][$userid] = $isUsed;
 453         }
 454
 455         // Return the result
 456         return $isUsed;
 457 }
 458
 459 // Getter for 'what' value
 460 function getWhat () {
 461         // Default is null
 462         $what = null;
 463
 464         // Is the value set?
 465         if (isWhatSet(true)) {
 466                 // Then use it
 467                 $what = $GLOBALS['what'];
 468         } // END - if
 469
 470         // Return it
 471         return $what;
 472 }
 473
 474 // Setter for 'what' value
 475 function setWhat ($newWhat) {
 476         $GLOBALS['what'] = SQL_ESCAPE($newWhat);
 477 }
 478
 479 // Setter for 'what' from configuration
 480 function setWhatFromConfig ($configEntry) {
 481         // Get 'what' from config
 482         $what = getConfig($configEntry);
 483
 484         // Set it
 485         setWhat($what);
 486 }
 487
 488 // Checks wether what is set and optionally aborts on miss
 489 function isWhatSet ($strict =  false) {
 490         // Check for it
 491         $isset = (isset($GLOBALS['what']));
 492
 493         // Should we abort here?
 494         if (($strict === true) && ($isset === false)) {
 495                 // Output backtrace
 496                 debug_report_bug('what is empty.');
 497         } // END - if
 498
 499         // Return it
 500         return $isset;
 501 }
 502
 503 // Getter for 'action' value
 504 function getAction () {
 505         // Default is null
 506         $action = null;
 507
 508         // Is the value set?
 509         if (isActionSet(true)) {
 510                 // Then use it
 511                 $action = $GLOBALS['action'];
 512         } // END - if
 513
 514         // Return it
 515         return $action;
 516 }
 517
 518 // Setter for 'action' value
 519 function setAction ($newAction) {
 520         $GLOBALS['action'] = SQL_ESCAPE($newAction);
 521 }
 522
 523 // Checks wether action is set and optionally aborts on miss
 524 function isActionSet ($strict =  false) {
 525         // Check for it
 526         $isset = (isset($GLOBALS['action']));
 527
 528         // Should we abort here?
 529         if (($strict === true) && ($isset === false)) {
 530                 // Output backtrace
 531                 debug_report_bug('action is empty.');
 532         } // END - if
 533
 534         // Return it
 535         return $isset;
 536 }
 537
 538 // Getter for 'module' value
 539 function getModule ($strict = true) {
 540         // Default is null
 541         $module = null;
 542
 543         // Is the value set?
 544         if (isModuleSet($strict)) {
 545                 // Then use it
 546                 $module = $GLOBALS['module'];
 547         } // END - if
 548
 549         // Return it
 550         return $module;
 551 }
 552
 553 // Setter for 'module' value
 554 function setModule ($newModule) {
 555         // Secure it and make all modules lower-case
 556         $GLOBALS['module'] = SQL_ESCAPE(strtolower($newModule));
 557 }
 558
 559 // Checks wether module is set and optionally aborts on miss
 560 function isModuleSet ($strict =  false) {
 561         // Check for it
 562         $isset = (!empty($GLOBALS['module']));
 563
 564         // Should we abort here?
 565         if (($strict === true) && ($isset === false)) {
 566                 // Output backtrace
 567                 debug_report_bug('module is empty.');
 568         } // END - if
 569
 570         // Return it
 571         return (($isset === true) && ($GLOBALS['module'] != 'unknown')) ;
 572 }
 573
 574 // Getter for 'output_mode' value
 575 function getOutputMode () {
 576         // Default is null
 577         $output_mode = null;
 578
 579         // Is the value set?
 580         if (isOutputModeSet(true)) {
 581                 // Then use it
 582                 $output_mode = $GLOBALS['output_mode'];
 583         } // END - if
 584
 585         // Return it
 586         return $output_mode;
 587 }
 588
 589 // Setter for 'output_mode' value
 590 function setOutputMode ($newOutputMode) {
 591         $GLOBALS['output_mode'] = (int) $newOutputMode;
 592 }
 593
 594 // Checks wether output_mode is set and optionally aborts on miss
 595 function isOutputModeSet ($strict =  false) {
 596         // Check for it
 597         $isset = (isset($GLOBALS['output_mode']));
 598
 599         // Should we abort here?
 600         if (($strict === true) && ($isset === false)) {
 601                 // Output backtrace
 602                 debug_report_bug('output_mode is empty.');
 603         } // END - if
 604
 605         // Return it
 606         return $isset;
 607 }
 608
 609 // Enables block-mode
 610 function enableBlockMode ($enabled = true) {
 611         $GLOBALS['block_mode'] = $enabled;
 612 }
 613
 614 // Checks wether block-mode is enabled
 615 function isBlockModeEnabled () {
 616         // Abort if not set
 617         if (!isset($GLOBALS['block_mode'])) {
 618                 // Needs to be fixed
 619                 debug_report_bug(__FUNCTION__ . ': block_mode is not set.');
 620         } // END - if
 621
 622         // Return it
 623         return $GLOBALS['block_mode'];
 624 }
 625
 626 // Wrapper function for addPointsThroughReferalSystem()
 627 function addPointsDirectly ($subject, $userid, $points) {
 628         // Reset level here
 629         unset($GLOBALS['ref_level']);
 630
 631         // Call more complicated method (due to more parameters)
 632         return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, false, 'direct');
 633 }
 634
 635 // Wrapper function to redirect from member-only modules to index
 636 function redirectToIndexMemberOnlyModule () {
 637         // Do the redirect here
 638         redirectToUrl('modules.php?module=index&amp;code=' . getCode('MODULE_MEM_ONLY') . '&amp;mod=' . getModule());
 639 }
 640
 641 // Wrapper function for checking if extension is installed and newer or same version
 642 function isExtensionInstalledAndNewer ($ext_name, $version) {
 643         // Return it
 644         //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'=&gt;'.$version.'<br />';
 645         return ((isExtensionInstalled($ext_name)) && (getExtensionVersion($ext_name) >= $version));
 646 }
 647
 648 // Wrapper function for checking if extension is installed and older than given version
 649 function isExtensionInstalledAndOlder ($ext_name, $version) {
 650         // Return it
 651         //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'&lt;'.$version.'<br />';
 652         return ((isExtensionInstalled($ext_name)) && (isExtensionOlder($ext_name, $version)));
 653 }
 654
 655 // Set username
 656 function setUsername ($userName) {
 657         $GLOBALS['username'] = (string) $userName;
 658 }
 659
 660 // Get username
 661 function getUsername () {
 662         return $GLOBALS['username'];
 663 }
 664
 665 // Wrapper function for installation phase
 666 function isInstallationPhase () {
 667         // Do we have cache?
 668         if (!isset($GLOBALS['installation_phase'])) {
 669                 // Determine it
 670                 $GLOBALS['installation_phase'] = ((!isInstalled()) || (isInstalling()));
 671         } // END - if
 672
 673         // Return result
 674         return $GLOBALS['installation_phase'];
 675 }
 676
 677 // Checks wether the extension demo is actuve and the admin login is demo (password needs to be demo, too!)
 678 function isDemoModeActive () {
 679         return ((isExtensionActive('demo')) && (getSession('admin_login') == 'demo'));
 680 }
 681
 682 // Wrapper function to redirect to de-refered URL
 683 function redirectToDereferedUrl ($URL) {
 684         // De-refer the URL
 685         $URL = generateDerefererUrl($URL);
 686
 687         // Redirect to to
 688         redirectToUrl($URL);
 689 }
 690
 691 // Getter for PHP caching value
 692 function getPhpCaching () {
 693         return $GLOBALS['php_caching'];
 694 }
 695
 696 // Checks wether the admin hash is set
 697 function isAdminHashSet ($admin) {
 698         return isset($GLOBALS['cache_array']['admin']['password'][$admin]);
 699 }
 700
 701 // Setter for admin hash
 702 function setAdminHash ($admin, $hash) {
 703         $GLOBALS['cache_array']['admin']['password'][$admin] = $hash;
 704 }
 705
 706 // Init user data array
 707 function initUserData () {
 708         // User id should not be zero
 709         if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
 710
 711         // Init the user
 712         $GLOBALS['user_data'][getCurrentUserId()] = array();
 713 }
 714
 715 // Getter for user data
 716 function getUserData ($column) {
 717         // User id should not be zero
 718         if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
 719
 720         // Return the value
 721         return $GLOBALS['user_data'][getCurrentUserId()][$column];
 722 }
 723
 724 // Geter for whole user data array
 725 function getUserDataArray () {
 726         // User id should not be zero
 727         if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
 728
 729         // Get the whole array
 730         return $GLOBALS['user_data'][getCurrentUserId()];
 731 }
 732
 733 // Checks if the user data is valid, this may indicate that the user has logged
 734 // in, but you should use isMember() if you want to find that out.
 735 function isUserDataValid () {
 736         // User id should not be zero so abort here
 737         if (!isCurrentUserIdSet()) return false;
 738
 739         // Is the array there and filled?
 740         return ((isset($GLOBALS['user_data'][getCurrentUserId()])) && (count($GLOBALS['user_data'][getCurrentUserId()]) > 1));
 741 }
 742
 743 // Setter for current userid
 744 function setCurrentUserId ($userid) {
 745         $GLOBALS['current_userid'] = bigintval($userid);
 746 }
 747
 748 // Getter for current userid
 749 function getCurrentUserId () {
 750         // Userid must be set before it can be used
 751         if (!isCurrentUserIdSet()) {
 752                 // Not set
 753                 debug_report_bug('User id is not set.');
 754         } // END - if
 755
 756         // Return the userid
 757         return $GLOBALS['current_userid'];
 758 }
 759
 760 // Checks if current userid is set
 761 function isCurrentUserIdSet () {
 762         return isset($GLOBALS['current_userid']);
 763 }
 764
 765 // Checks wether we are debugging template cache
 766 function isDebuggingTemplateCache () {
 767         return (getConfig('DEBUG_TEMPLATE_CACHE') == 'Y');
 768 }
 769
 770 // Wrapper for fetchUserData() and getUserData() calls
 771 function getFetchedUserData ($keyColumn, $userId, $valueColumn) {
 772         // Default is 'guest'
 773         $data = getMessage('USERNAME_GUEST');
 774
 775         // Can we fetch the user data?
 776         if (($userId > 0) && (fetchUserData($userId, $keyColumn))) {
 777                 // Now get the data back
 778                 $data = getUserData($valueColumn);
 779         } // END - if
 780
 781         // Return it
 782         return $data;
 783 }
 784
 785 // [EOF]
 786 ?>