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