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 // Check wether we are installing
 255 function isInstalling () {
 256         // Determine wether we are installing
 257         if (!isset($GLOBALS['mxchange_installing'])) {
 258                 // Check URL (css.php/js.php need this)
 259                 $GLOBALS['mxchange_installing'] = isGetRequestElementSet('installing');
 260         } // END - if
 261
 262         // Return result
 263         return $GLOBALS['mxchange_installing'];
 264 }
 265
 266 // Check wether this script is installed
 267 function isInstalled () {
 268         // Do we have cache?
 269         if (!isset($GLOBALS['is_installed'])) {
 270                 // Determine wether this script is installed
 271                 $GLOBALS['is_installed'] = (
 272                 (
 273                         // First is config
 274                         (
 275                                 (
 276                                         isConfigEntrySet('MXCHANGE_INSTALLED')
 277                                 ) && (
 278                                         getConfig('MXCHANGE_INSTALLED') == 'Y'
 279                                 )
 280                         )
 281                 ) || (
 282                         // New config file found and loaded
 283                         isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
 284                 ) || (
 285                         (
 286                                 // New config file found, but not yet read
 287                                 isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
 288                         ) && (
 289                                 (
 290                                         // Only new config file is found
 291                                         !isIncludeReadable('inc/config.php')
 292                                 ) || (
 293                                         // Is installation mode
 294                                         !isInstalling()
 295                                 )
 296                         )
 297                 ));
 298         } // END - if
 299
 300         // Then use the cache
 301         return $GLOBALS['is_installed'];
 302 }
 303
 304 // Check wether an admin is registered
 305 function isAdminRegistered () {
 306         return ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y'));
 307 }
 308
 309 // Checks wether the reset mode is active
 310 function isResetModeEnabled () {
 311         // Now simply check it
 312         return ((isset($GLOBALS['reset_enabled'])) && ($GLOBALS['reset_enabled'] === true));
 313 }
 314
 315 // Checks wether the debug mode is enabled
 316 function isDebugModeEnabled () {
 317         // Simply check it
 318         return ((isConfigEntrySet('DEBUG_MODE')) && (getConfig('DEBUG_MODE') == 'Y'));
 319 }
 320
 321 // Checks wether we shall debug regular expressions
 322 function isDebugRegExpressionEnabled () {
 323         // Simply check it
 324         return ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y'));
 325 }
 326
 327 // Checks wether the cache instance is valid
 328 function isCacheInstanceValid () {
 329         return ((isset($GLOBALS['cache_instance'])) && (is_object($GLOBALS['cache_instance'])));
 330 }
 331
 332 // Copies a file from source to destination and verifies if that goes fine.
 333 // This function should wrap the copy() command and make a nicer debug backtrace
 334 // even if there is no xdebug extension installed.
 335 function copyFileVerified ($source, $dest, $chmod = '') {
 336         // Failed is the default
 337         $status = false;
 338
 339         // Is the source file there?
 340         if (!isFileReadable($source)) {
 341                 // Then abort here
 342                 debug_report_bug('Cannot read from source file ' . basename($source) . '.');
 343         } // END - if
 344
 345         // Is the target directory there?
 346         if (!isDirectory(dirname($dest))) {
 347                 // Then abort here
 348                 debug_report_bug('Cannot find directory ' . str_replace(getConfig('PATH'), '', dirname($dest)) . '.');
 349         } // END - if
 350
 351         // Now try to copy it
 352         if (!copy($source, $dest)) {
 353                 // Something went wrong
 354                 debug_report_bug('copy() has failed to copy the file.');
 355         } else {
 356                 // Reset cache
 357                 $GLOBALS['file_readable'][$dest] = true;
 358         }
 359
 360         // If there are chmod rights set, apply them
 361         if (!empty($chmod)) {
 362                 // Try to apply them
 363                 $status = changeMode($dest, $chmod);
 364         } else {
 365                 // All fine
 366                 $status = true;
 367         }
 368
 369         // All fine
 370         return $status;
 371 }
 372
 373 // Wrapper function for header()
 374 // Send a header but checks before if we can do so
 375 function sendHeader ($header) {
 376         // Is the header already sent?
 377         if (headers_sent()) {
 378                 // Then abort here
 379                 debug_report_bug('Headers already sent!');
 380         } // END - if
 381
 382         // Send the header
 383         header(trim($header));
 384 }
 385
 386 // Wrapper function for chmod()
 387 // @TODO Do some more sanity check here
 388 function changeMode ($FQFN, $mode) {
 389         // Is the file/directory there?
 390         if ((!isFileReadable($FQFN)) && (!isDirectory($FQFN))) {
 391                 // Neither, so abort here
 392                 debug_report_bug('Cannot chmod() on ' . basename($FQFN) . '.');
 393         } // END - if
 394
 395         // Try to set them
 396         chmod($FQFN, $mode);
 397 }
 398
 399 // Wrapper for unlink()
 400 function removeFile ($FQFN) {
 401         // Is the file there?
 402         if (isFileReadable($FQFN)) {
 403                 // Reset cache first
 404                 $GLOBALS['file_readable'][$FQFN] = false;
 405
 406                 // Yes, so remove it
 407                 return unlink($FQFN);
 408         } // END - if
 409
 410         // All fine if no file was removed. If we change this to 'false' or rewrite
 411         // above if() block it would be to restrictive.
 412         return true;
 413 }
 414
 415 // Wrapper for $_POST['sel']
 416 function countPostSelection ($element = 'sel') {
 417         // Is it set?
 418         if (isPostRequestElementSet($element)) {
 419                 // Return counted elements
 420                 return countSelection(postRequestElement($element));
 421         } else {
 422                 // Return zero if not found
 423                 return 0;
 424         }
 425 }
 426
 427 // Checks wether the config-local.php is loaded
 428 function isConfigLocalLoaded () {
 429         return ((isset($GLOBALS['config_local_loaded'])) && ($GLOBALS['config_local_loaded'] === true));
 430 }
 431
 432 // Checks wether a nickname or userid was entered and caches the result
 433 function isNicknameUsed ($userid) {
 434         // Default is false
 435         $isUsed = false;
 436
 437         // Is the cache there
 438         if (isset($GLOBALS['is_nickname_used'][$userid])) {
 439                 // Then use it
 440                 $isUsed = $GLOBALS['is_nickname_used'][$userid];
 441         } else {
 442                 // Determine it
 443                 $isUsed = (('' . round($userid) . '') != $userid);
 444
 445                 // And write it to the cache
 446                 $GLOBALS['is_nickname_used'][$userid] = $isUsed;
 447         }
 448
 449         // Return the result
 450         return $isUsed;
 451 }
 452
 453 // Getter for 'what' value
 454 function getWhat () {
 455         // Default is null
 456         $what = null;
 457
 458         // Is the value set?
 459         if (isWhatSet(true)) {
 460                 // Then use it
 461                 $what = $GLOBALS['what'];
 462         } // END - if
 463
 464         // Return it
 465         return $what;
 466 }
 467
 468 // Setter for 'what' value
 469 function setWhat ($newWhat) {
 470         $GLOBALS['what'] = SQL_ESCAPE($newWhat);
 471 }
 472
 473 // Setter for 'what' from configuration
 474 function setWhatFromConfig ($configEntry) {
 475         // Get 'what' from config
 476         $what = getConfig($configEntry);
 477
 478         // Set it
 479         setWhat($what);
 480 }
 481
 482 // Checks wether what is set and optionally aborts on miss
 483 function isWhatSet ($strict =  false) {
 484         // Check for it
 485         $isset = (isset($GLOBALS['what']));
 486
 487         // Should we abort here?
 488         if (($strict === true) && ($isset === false)) {
 489                 // Output backtrace
 490                 debug_report_bug('what is empty.');
 491         } // END - if
 492
 493         // Return it
 494         return $isset;
 495 }
 496
 497 // Getter for 'action' value
 498 function getAction () {
 499         // Default is null
 500         $action = null;
 501
 502         // Is the value set?
 503         if (isActionSet(true)) {
 504                 // Then use it
 505                 $action = $GLOBALS['action'];
 506         } // END - if
 507
 508         // Return it
 509         return $action;
 510 }
 511
 512 // Setter for 'action' value
 513 function setAction ($newAction) {
 514         $GLOBALS['action'] = SQL_ESCAPE($newAction);
 515 }
 516
 517 // Checks wether action is set and optionally aborts on miss
 518 function isActionSet ($strict =  false) {
 519         // Check for it
 520         $isset = (isset($GLOBALS['action']));
 521
 522         // Should we abort here?
 523         if (($strict === true) && ($isset === false)) {
 524                 // Output backtrace
 525                 debug_report_bug('action is empty.');
 526         } // END - if
 527
 528         // Return it
 529         return $isset;
 530 }
 531
 532 // Getter for 'module' value
 533 function getModule ($strict = true) {
 534         // Default is null
 535         $module = null;
 536
 537         // Is the value set?
 538         if (isModuleSet($strict)) {
 539                 // Then use it
 540                 $module = $GLOBALS['module'];
 541         } // END - if
 542
 543         // Return it
 544         return $module;
 545 }
 546
 547 // Setter for 'module' value
 548 function setModule ($newModule) {
 549         // Secure it and make all modules lower-case
 550         $GLOBALS['module'] = SQL_ESCAPE(strtolower($newModule));
 551 }
 552
 553 // Checks wether module is set and optionally aborts on miss
 554 function isModuleSet ($strict =  false) {
 555         // Check for it
 556         $isset = (!empty($GLOBALS['module']));
 557
 558         // Should we abort here?
 559         if (($strict === true) && ($isset === false)) {
 560                 // Output backtrace
 561                 debug_report_bug('module is empty.');
 562         } // END - if
 563
 564         // Return it
 565         return (($isset === true) && ($GLOBALS['module'] != 'unknown')) ;
 566 }
 567
 568 // Getter for 'output_mode' value
 569 function getOutputMode () {
 570         // Default is null
 571         $output_mode = null;
 572
 573         // Is the value set?
 574         if (isOutputModeSet(true)) {
 575                 // Then use it
 576                 $output_mode = $GLOBALS['output_mode'];
 577         } // END - if
 578
 579         // Return it
 580         return $output_mode;
 581 }
 582
 583 // Setter for 'output_mode' value
 584 function setOutputMode ($newOutputMode) {
 585         $GLOBALS['output_mode'] = (int) $newOutputMode;
 586 }
 587
 588 // Checks wether output_mode is set and optionally aborts on miss
 589 function isOutputModeSet ($strict =  false) {
 590         // Check for it
 591         $isset = (isset($GLOBALS['output_mode']));
 592
 593         // Should we abort here?
 594         if (($strict === true) && ($isset === false)) {
 595                 // Output backtrace
 596                 debug_report_bug('output_mode is empty.');
 597         } // END - if
 598
 599         // Return it
 600         return $isset;
 601 }
 602
 603 // Enables block-mode
 604 function enableBlockMode ($enabled = true) {
 605         $GLOBALS['block_mode'] = $enabled;
 606 }
 607
 608 // Checks wether block-mode is enabled
 609 function isBlockModeEnabled () {
 610         // Abort if not set
 611         if (!isset($GLOBALS['block_mode'])) {
 612                 // Needs to be fixed
 613                 debug_report_bug(__FUNCTION__ . ': block_mode is not set.');
 614         } // END - if
 615
 616         // Return it
 617         return $GLOBALS['block_mode'];
 618 }
 619
 620 // Wrapper function for addPointsThroughReferalSystem()
 621 function addPointsDirectly ($subject, $userid, $points) {
 622         // Reset level here
 623         unset($GLOBALS['ref_level']);
 624
 625         // Call more complicated method (due to more parameters)
 626         return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, false, 'direct');
 627 }
 628
 629 // Wrapper function to redirect from member-only modules to index
 630 function redirectToIndexMemberOnlyModule () {
 631         // Do the redirect here
 632         redirectToUrl('modules.php?module=index&amp;code=' . getCode('MODULE_MEM_ONLY') . '&amp;mod=' . getModule());
 633 }
 634
 635 // Wrapper function for checking if extension is installed and newer or same version
 636 function isExtensionInstalledAndNewer ($ext_name, $version) {
 637         // Return it
 638         //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'=&gt;'.$version.'<br />';
 639         return ((isExtensionInstalled($ext_name)) && (getExtensionVersion($ext_name) >= $version));
 640 }
 641
 642 // Wrapper function for checking if extension is installed and older than given version
 643 function isExtensionInstalledAndOlder ($ext_name, $version) {
 644         // Return it
 645         //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'&lt;'.$version.'<br />';
 646         return ((isExtensionInstalled($ext_name)) && (isExtensionOlder($ext_name, $version)));
 647 }
 648
 649 // Set username
 650 function setUsername ($userName) {
 651         $GLOBALS['username'] = (string) $userName;
 652 }
 653
 654 // Get username
 655 function getUsername () {
 656         return $GLOBALS['username'];
 657 }
 658
 659 // Wrapper function for installation phase
 660 function isInstallationPhase () {
 661         // Do we have cache?
 662         if (!isset($GLOBALS['installation_phase'])) {
 663                 // Determine it
 664                 $GLOBALS['installation_phase'] = ((!isInstalled()) || (isInstalling()));
 665         } // END - if
 666
 667         // Return result
 668         return $GLOBALS['installation_phase'];
 669 }
 670
 671 // Checks wether the extension demo is actuve and the admin login is demo (password needs to be demo, too!)
 672 function isDemoModeActive () {
 673         return ((isExtensionActive('demo')) && (getSession('admin_login') == 'demo'));
 674 }
 675
 676 // Wrapper function to redirect to de-refered URL
 677 function redirectToDereferedUrl ($URL) {
 678         // De-refer the URL
 679         $URL = generateDerefererUrl($URL);
 680
 681         // Redirect to to
 682         redirectToUrl($URL);
 683 }
 684
 685 // Getter for PHP caching value
 686 function getPhpCaching () {
 687         return $GLOBALS['php_caching'];
 688 }
 689
 690 // Checks wether the admin hash is set
 691 function isAdminHashSet ($admin) {
 692         return isset($GLOBALS['cache_array']['admin']['password'][$admin]);
 693 }
 694
 695 // Setter for admin hash
 696 function setAdminHash ($admin, $hash) {
 697         $GLOBALS['cache_array']['admin']['password'][$admin] = $hash;
 698 }
 699
 700 // Init user data array
 701 function initUserData () {
 702         // User id should not be zero
 703         if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
 704
 705         // Init the user
 706         $GLOBALS['user_data'][getCurrentUserId()] = array();
 707 }
 708
 709 // Getter for user data
 710 function getUserData ($column) {
 711         // User id should not be zero
 712         if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
 713
 714         // Return the value
 715         return $GLOBALS['user_data'][getCurrentUserId()][$column];
 716 }
 717
 718 // Geter for whole user data array
 719 function getUserDataArray () {
 720         // User id should not be zero
 721         if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
 722
 723         // Get the whole array
 724         return $GLOBALS['user_data'][getCurrentUserId()];
 725 }
 726
 727 // Checks if the user data is valid, this may indicate that the user has logged
 728 // in, but you should use isMember() if you want to find that out.
 729 function isUserDataValid () {
 730         // User id should not be zero so abort here
 731         if (!isCurrentUserIdSet()) return false;
 732
 733         // Is the array there and filled?
 734         return ((isset($GLOBALS['user_data'][getCurrentUserId()])) && (count($GLOBALS['user_data'][getCurrentUserId()]) > 1));
 735 }
 736
 737 // Setter for current userid
 738 function setCurrentUserId ($userid) {
 739         $GLOBALS['current_userid'] = bigintval($userid);
 740 }
 741
 742 // Getter for current userid
 743 function getCurrentUserId () {
 744         // Userid must be set before it can be used
 745         if (!isCurrentUserIdSet()) {
 746                 // Not set
 747                 debug_report_bug('User id is not set.');
 748         } // END - if
 749
 750         // Return the userid
 751         return $GLOBALS['current_userid'];
 752 }
 753
 754 // Checks if current userid is set
 755 function isCurrentUserIdSet () {
 756         return isset($GLOBALS['current_userid']);
 757 }
 758
 759 // Checks wether we are debugging template cache
 760 function isDebuggingTemplateCache () {
 761         return (getConfig('DEBUG_TEMPLATE_CACHE') == 'Y');
 762 }
 763
 764 // [EOF]
 765 ?>