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  * Copyright (c) 2009, 2010 by Mailer Developer Team                    *
  22  * For more information visit: http://www.mxchange.org                  *
  23  *                                                                      *
  24  * This program is free software; you can redistribute it and/or modify *
  25  * it under the terms of the GNU General Public License as published by *
  26  * the Free Software Foundation; either version 2 of the License, or    *
  27  * (at your option) any later version.                                  *
  28  *                                                                      *
  29  * This program is distributed in the hope that it will be useful,      *
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  32  * GNU General Public License for more details.                         *
  33  *                                                                      *
  34  * You should have received a copy of the GNU General Public License    *
  35  * along with this program; if not, write to the Free Software          *
  36  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  37  * MA  02110-1301  USA                                                  *
  38  ************************************************************************/
  39
  40 // Some security stuff...
  41 if (!defined('__SECURITY')) {
  42         die();
  43 } // END - if
  44
  45 // Read a given file
  46 function readFromFile ($FQFN) {
  47         // Sanity-check if file is there (should be there, but just to make it sure)
  48         if (!isFileReadable($FQFN)) {
  49                 // This should not happen
  50                 debug_report_bug(__FUNCTION__.': File ' . basename($FQFN) . ' is not readable!');
  51         } // END - if
  52
  53         // Is it cached?
  54         if (!isset($GLOBALS['file_content'][$FQFN])) {
  55                 // Load the file
  56                 if (function_exists('file_get_contents')) {
  57                         // Use new function
  58                         $GLOBALS['file_content'][$FQFN] = file_get_contents($FQFN);
  59                 } else {
  60                         // Fall-back to implode-file chain
  61                         $GLOBALS['file_content'][$FQFN] = implode('', file($FQFN));
  62                 }
  63         } // END - if
  64
  65         // Return the content
  66         return $GLOBALS['file_content'][$FQFN];
  67 }
  68
  69 // Writes content to a file
  70 function writeToFile ($FQFN, $content, $aquireLock = false) {
  71         // Is the file writeable?
  72         if ((isFileReadable($FQFN)) && (!is_writeable($FQFN)) && (!changeMode($FQFN, 0644))) {
  73                 // Not writeable!
  74                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File %s not writeable.", basename($FQFN)));
  75
  76                 // Failed! :(
  77                 return false;
  78         } // END - if
  79
  80         // By default all is failed...
  81         $return = false;
  82
  83         // Is the function there?
  84         if (function_exists('file_put_contents')) {
  85                 // With lock?
  86                 if ($aquireLock === true) {
  87                         // Write it directly with lock
  88                         $return = file_put_contents($FQFN, $content, LOCK_EX);
  89                 } else {
  90                         // Write it directly
  91                         $return = file_put_contents($FQFN, $content);
  92                 }
  93         } else {
  94                 // Write it with fopen
  95                 $fp = fopen($FQFN, 'w') or app_die(__FUNCTION__, __LINE__, "Cannot write file ".basename($FQFN).'!');
  96
  97                 // Aquire lock
  98                 if ($aquireLock === true) flock($fp, LOCK_EX);
  99
 100                 // Write content
 101                 fwrite($fp, $content);
 102
 103                 // Close stream
 104                 fclose($fp);
 105         }
 106
 107         // Mark it as readable
 108         $GLOBALS['file_readable'][$FQFN] = true;
 109
 110         // Remember content in cache
 111         $GLOBALS['file_content'][$FQFN] = $content;
 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
 174                 // Debug message
 175                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . basename($FQFN) . ' - CHECK! (' . intval($GLOBALS['file_readable'][$FQFN]) . ')');
 176         } else {
 177                 // Cache used
 178                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'file=' . basename($FQFN) . ' - CACHE! (' . intval($GLOBALS['file_readable'][$FQFN]) . ')');
 179         }
 180
 181         // Return result
 182         return $GLOBALS['file_readable'][$FQFN];
 183 }
 184
 185 // Checks wether the given FQFN is a directory and not ., .. or .svn
 186 function isDirectory ($FQFN) {
 187         // Do we have cache?
 188         if (!isset($GLOBALS['is_directory'][$FQFN])) {
 189                 // Generate baseName
 190                 $baseName = basename($FQFN);
 191
 192                 // Check it
 193                 $GLOBALS['is_directory'][$FQFN] = ((is_dir($FQFN)) && ($baseName != '.') && ($baseName != '..') && ($baseName != '.svn'));
 194         } // END - if
 195
 196         // Return the result
 197         return $GLOBALS['is_directory'][$FQFN];
 198 }
 199
 200 // "Getter" for remote IP number
 201 function detectRemoteAddr () {
 202         // Get remote ip from environment
 203         $remoteAddr = determineRealRemoteAddress();
 204
 205         // Is removeip installed?
 206         if (isExtensionActive('removeip')) {
 207                 // Then anonymize it
 208                 $remoteAddr = getAnonymousRemoteAddress($remoteAddr);
 209         } // END - if
 210
 211         // Return it
 212         return $remoteAddr;
 213 }
 214
 215 // "Getter" for remote hostname
 216 function detectRemoteHostname () {
 217         // Get remote ip from environment
 218         $remoteHost = getenv('REMOTE_HOST');
 219
 220         // Is removeip installed?
 221         if (isExtensionActive('removeip')) {
 222                 // Then anonymize it
 223                 $remoteHost = getAnonymousRemoteHost($remoteHost);
 224         } // END - if
 225
 226         // Return it
 227         return $remoteHost;
 228 }
 229
 230 // "Getter" for user agent
 231 function detectUserAgent ($alwaysReal = false) {
 232         // Get remote ip from environment
 233         $userAgent = getenv('HTTP_USER_AGENT');
 234
 235         // Is removeip installed?
 236         if ((isExtensionActive('removeip')) && ($alwaysReal === false)) {
 237                 // Then anonymize it
 238                 $userAgent = getAnonymousUserAgent($userAgent);
 239         } // END - if
 240
 241         // Return it
 242         return $userAgent;
 243 }
 244
 245 // "Getter" for referer
 246 function detectReferer () {
 247         // Get remote ip from environment
 248         $referer = getenv('HTTP_REFERER');
 249
 250         // Is removeip installed?
 251         if (isExtensionActive('removeip')) {
 252                 // Then anonymize it
 253                 $referer = getAnonymousReferer($referer);
 254         } // END - if
 255
 256         // Return it
 257         return $referer;
 258 }
 259
 260 // "Getter" for request URI
 261 function detectRequestUri () {
 262         // Return it
 263         return (getenv('REQUEST_URI'));
 264 }
 265
 266 // "Getter" for query string
 267 function detectQueryString () {
 268         return str_replace('&', '&amp;', (getenv('QUERY_STRING')));
 269 }
 270
 271 // "Getter" for SERVER_NAME
 272 function detectServerName () {
 273         // Return it
 274         return (getenv('SERVER_NAME'));
 275 }
 276
 277 // Check wether we are installing
 278 function isInstalling () {
 279         // Determine wether we are installing
 280         if (!isset($GLOBALS['mailer_installing'])) {
 281                 // Check URL (css.php/js.php need this)
 282                 $GLOBALS['mailer_installing'] = isGetRequestParameterSet('installing');
 283         } // END - if
 284
 285         // Return result
 286         return $GLOBALS['mailer_installing'];
 287 }
 288
 289 // Check wether this script is installed
 290 function isInstalled () {
 291         // Do we have cache?
 292         if (!isset($GLOBALS['is_installed'])) {
 293                 // Determine wether this script is installed
 294                 $GLOBALS['is_installed'] = (
 295                 (
 296                         // First is config
 297                         (
 298                                 (
 299                                         isConfigEntrySet('MXCHANGE_INSTALLED')
 300                                 ) && (
 301                                         getConfig('MXCHANGE_INSTALLED') == 'Y'
 302                                 )
 303                         )
 304                 ) || (
 305                         // New config file found and loaded
 306                         isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
 307                 ) || (
 308                         (
 309                                 // New config file found, but not yet read
 310                                 isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
 311                         ) && (
 312                                 (
 313                                         // Only new config file is found
 314                                         !isIncludeReadable('inc/config.php')
 315                                 ) || (
 316                                         // Is installation mode
 317                                         !isInstalling()
 318                                 )
 319                         )
 320                 ));
 321         } // END - if
 322
 323         // Then use the cache
 324         return $GLOBALS['is_installed'];
 325 }
 326
 327 // Check wether an admin is registered
 328 function isAdminRegistered () {
 329         // Is cache set?
 330         if (!isset($GLOBALS['is_admin_registered'])) {
 331                 // Simply check it
 332                 $GLOBALS['is_admin_registered'] = ((isConfigEntrySet('ADMIN_REGISTERED')) && (getConfig('ADMIN_REGISTERED') == 'Y'));
 333         } // END - if
 334
 335         // Return it
 336         return $GLOBALS['is_admin_registered'];
 337 }
 338
 339 // Checks wether the reset mode is active
 340 function isResetModeEnabled () {
 341         // Now simply check it
 342         return ((isset($GLOBALS['reset_enabled'])) && ($GLOBALS['reset_enabled'] === true));
 343 }
 344
 345 // Checks wether the debug mode is enabled
 346 function isDebugModeEnabled () {
 347         // Is cache set?
 348         if (!isset($GLOBALS['is_debugmode_enabled'])) {
 349                 // Simply check it
 350                 $GLOBALS['is_debugmode_enabled'] = ((isConfigEntrySet('DEBUG_MODE')) && (getConfig('DEBUG_MODE') == 'Y'));
 351         } // END - if
 352
 353         // Return it
 354         return $GLOBALS['is_debugmode_enabled'];
 355 }
 356
 357 // Checks wether SQL debugging is enabled
 358 function isSqlDebuggingEnabled () {
 359         // Is cache set?
 360         if (!isset($GLOBALS['is_sql_debug_enabled'])) {
 361                 // Determine if SQL debugging is enabled
 362                 $GLOBALS['is_sql_debug_enabled'] = ((isConfigEntrySet('DEBUG_SQL')) && (getConfig('DEBUG_SQL') == 'Y'));
 363         } // END - if
 364
 365         // Return it
 366         return $GLOBALS['is_sql_debug_enabled'];
 367 }
 368
 369 // Checks wether we shall debug regular expressions
 370 function isDebugRegularExpressionEnabled () {
 371         // Simply check it
 372         return ((isConfigEntrySet('DEBUG_REGEX')) && (getConfig('DEBUG_REGEX') == 'Y'));
 373 }
 374
 375 // Checks wether the cache instance is valid
 376 function isCacheInstanceValid () {
 377         return ((isset($GLOBALS['cache_instance'])) && (is_object($GLOBALS['cache_instance'])));
 378 }
 379
 380 // Copies a file from source to destination and verifies if that goes fine.
 381 // This function should wrap the copy() command and make a nicer debug backtrace
 382 // even if there is no xdebug extension installed.
 383 function copyFileVerified ($source, $dest, $chmod = '') {
 384         // Failed is the default
 385         $status = false;
 386
 387         // Is the source file there?
 388         if (!isFileReadable($source)) {
 389                 // Then abort here
 390                 debug_report_bug('Cannot read from source file ' . basename($source) . '.');
 391         } // END - if
 392
 393         // Is the target directory there?
 394         if (!isDirectory(dirname($dest))) {
 395                 // Then abort here
 396                 debug_report_bug('Cannot find directory ' . str_replace(getConfig('PATH'), '', dirname($dest)) . '.');
 397         } // END - if
 398
 399         // Now try to copy it
 400         if (!copy($source, $dest)) {
 401                 // Something went wrong
 402                 debug_report_bug('copy() has failed to copy the file.');
 403         } else {
 404                 // Reset cache
 405                 $GLOBALS['file_readable'][$dest] = true;
 406         }
 407
 408         // If there are chmod rights set, apply them
 409         if (!empty($chmod)) {
 410                 // Try to apply them
 411                 $status = changeMode($dest, $chmod);
 412         } else {
 413                 // All fine
 414                 $status = true;
 415         }
 416
 417         // All fine
 418         return $status;
 419 }
 420
 421 // Wrapper function for header()
 422 // Send a header but checks before if we can do so
 423 function sendHeader ($header) {
 424         // Send the header
 425         //* DEBUG: */ logDebugMessage(__FUNCTION__ . ': header=' . $header);
 426         $GLOBALS['header'][] = trim($header);
 427 }
 428
 429 // Flushes all headers
 430 function flushHeaders () {
 431         // Is the header already sent?
 432         if (headers_sent()) {
 433                 // Then abort here
 434                 debug_report_bug('Headers already sent!');
 435         } // END - if
 436
 437         // Flush all headers if found
 438         if ((isset($GLOBALS['header'])) && (is_array($GLOBALS['header']))) {
 439                 foreach ($GLOBALS['header'] as $header) {
 440                         header($header);
 441                 } // END - foreach
 442         } // END - if
 443
 444         // Mark them as flushed
 445         $GLOBALS['header'] = array();
 446 }
 447
 448 // Wrapper function for chmod()
 449 // @TODO Do some more sanity check here
 450 function changeMode ($FQFN, $mode) {
 451         // Is the file/directory there?
 452         if ((!isFileReadable($FQFN)) && (!isDirectory($FQFN))) {
 453                 // Neither, so abort here
 454                 debug_report_bug('Cannot chmod() on ' . basename($FQFN) . '.');
 455         } // END - if
 456
 457         // Try to set them
 458         chmod($FQFN, $mode);
 459 }
 460
 461 // Wrapper for unlink()
 462 function removeFile ($FQFN) {
 463         // Is the file there?
 464         if (isFileReadable($FQFN)) {
 465                 // Reset cache first
 466                 $GLOBALS['file_readable'][$FQFN] = false;
 467
 468                 // Yes, so remove it
 469                 return unlink($FQFN);
 470         } // END - if
 471
 472         // All fine if no file was removed. If we change this to 'false' or rewrite
 473         // above if() block it would be to restrictive.
 474         return true;
 475 }
 476
 477 // Wrapper for $_POST['sel']
 478 function countPostSelection ($element = 'sel') {
 479         // Is it set?
 480         if (isPostRequestParameterSet($element)) {
 481                 // Return counted elements
 482                 return countSelection(postRequestParameter($element));
 483         } else {
 484                 // Return zero if not found
 485                 return 0;
 486         }
 487 }
 488
 489 // Checks wether the config-local.php is loaded
 490 function isConfigLocalLoaded () {
 491         return ((isset($GLOBALS['config_local_loaded'])) && ($GLOBALS['config_local_loaded'] === true));
 492 }
 493
 494 // Checks wether a nickname or userid was entered and caches the result
 495 function isNicknameUsed ($userid) {
 496         // Default is false
 497         $isUsed = false;
 498
 499         // Is the cache there
 500         if (isset($GLOBALS['is_nickname_used'][$userid])) {
 501                 // Then use it
 502                 $isUsed = $GLOBALS['is_nickname_used'][$userid];
 503         } else {
 504                 // Determine it
 505                 $isUsed = (('' . round($userid) . '') != $userid);
 506
 507                 // And write it to the cache
 508                 $GLOBALS['is_nickname_used'][$userid] = $isUsed;
 509         }
 510
 511         // Return the result
 512         return $isUsed;
 513 }
 514
 515 // Getter for 'what' value
 516 function getWhat () {
 517         // Default is null
 518         $what = null;
 519
 520         // Is the value set?
 521         if (isWhatSet(true)) {
 522                 // Then use it
 523                 $what = $GLOBALS['what'];
 524         } // END - if
 525
 526         // Return it
 527         return $what;
 528 }
 529
 530 // Setter for 'what' value
 531 function setWhat ($newWhat) {
 532         $GLOBALS['what'] = SQL_ESCAPE($newWhat);
 533 }
 534
 535 // Setter for 'what' from configuration
 536 function setWhatFromConfig ($configEntry) {
 537         // Get 'what' from config
 538         $what = getConfig($configEntry);
 539
 540         // Set it
 541         setWhat($what);
 542 }
 543
 544 // Checks wether what is set and optionally aborts on miss
 545 function isWhatSet ($strict =  false) {
 546         // Check for it
 547         $isset = isset($GLOBALS['what']);
 548
 549         // Should we abort here?
 550         if (($strict === true) && ($isset === false)) {
 551                 // Output backtrace
 552                 debug_report_bug('what is empty.');
 553         } // END - if
 554
 555         // Return it
 556         return $isset;
 557 }
 558
 559 // Getter for 'action' value
 560 function getAction () {
 561         // Default is null
 562         $action = null;
 563
 564         // Is the value set?
 565         if (isActionSet(true)) {
 566                 // Then use it
 567                 $action = $GLOBALS['action'];
 568         } // END - if
 569
 570         // Return it
 571         return $action;
 572 }
 573
 574 // Setter for 'action' value
 575 function setAction ($newAction) {
 576         $GLOBALS['action'] = SQL_ESCAPE($newAction);
 577 }
 578
 579 // Checks wether action is set and optionally aborts on miss
 580 function isActionSet ($strict =  false) {
 581         // Check for it
 582         $isset = ((isset($GLOBALS['action'])) && (!empty($GLOBALS['action'])));
 583
 584         // Should we abort here?
 585         if (($strict === true) && ($isset === false)) {
 586                 // Output backtrace
 587                 debug_report_bug('action is empty.');
 588         } // END - if
 589
 590         // Return it
 591         return $isset;
 592 }
 593
 594 // Getter for 'module' value
 595 function getModule ($strict = true) {
 596         // Default is null
 597         $module = null;
 598
 599         // Is the value set?
 600         if (isModuleSet($strict)) {
 601                 // Then use it
 602                 $module = $GLOBALS['module'];
 603         } // END - if
 604
 605         // Return it
 606         return $module;
 607 }
 608
 609 // Setter for 'module' value
 610 function setModule ($newModule) {
 611         // Secure it and make all modules lower-case
 612         $GLOBALS['module'] = SQL_ESCAPE(strtolower($newModule));
 613 }
 614
 615 // Checks wether module is set and optionally aborts on miss
 616 function isModuleSet ($strict =  false) {
 617         // Check for it
 618         $isset = (!empty($GLOBALS['module']));
 619
 620         // Should we abort here?
 621         if (($strict === true) && ($isset === false)) {
 622                 // Output backtrace
 623                 debug_report_bug('module is empty.');
 624         } // END - if
 625
 626         // Return it
 627         return (($isset === true) && ($GLOBALS['module'] != 'unknown')) ;
 628 }
 629
 630 // Getter for 'output_mode' value
 631 function getOutputMode () {
 632         // Default is null
 633         $output_mode = null;
 634
 635         // Is the value set?
 636         if (isOutputModeSet(true)) {
 637                 // Then use it
 638                 $output_mode = $GLOBALS['output_mode'];
 639         } // END - if
 640
 641         // Return it
 642         return $output_mode;
 643 }
 644
 645 // Setter for 'output_mode' value
 646 function setOutputMode ($newOutputMode) {
 647         $GLOBALS['output_mode'] = (int) $newOutputMode;
 648 }
 649
 650 // Checks wether output_mode is set and optionally aborts on miss
 651 function isOutputModeSet ($strict =  false) {
 652         // Check for it
 653         $isset = (isset($GLOBALS['output_mode']));
 654
 655         // Should we abort here?
 656         if (($strict === true) && ($isset === false)) {
 657                 // Output backtrace
 658                 debug_report_bug('output_mode is empty.');
 659         } // END - if
 660
 661         // Return it
 662         return $isset;
 663 }
 664
 665 // Enables block-mode
 666 function enableBlockMode ($enabled = true) {
 667         $GLOBALS['block_mode'] = $enabled;
 668 }
 669
 670 // Checks wether block-mode is enabled
 671 function isBlockModeEnabled () {
 672         // Abort if not set
 673         if (!isset($GLOBALS['block_mode'])) {
 674                 // Needs to be fixed
 675                 debug_report_bug(__FUNCTION__ . ': block_mode is not set.');
 676         } // END - if
 677
 678         // Return it
 679         return $GLOBALS['block_mode'];
 680 }
 681
 682 // Wrapper function for addPointsThroughReferalSystem()
 683 function addPointsDirectly ($subject, $userid, $points) {
 684         // Reset level here
 685         unset($GLOBALS['ref_level']);
 686
 687         // Call more complicated method (due to more parameters)
 688         return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, false, 'direct');
 689 }
 690
 691 // Wrapper function to redirect from member-only modules to index
 692 function redirectToIndexMemberOnlyModule () {
 693         // Do the redirect here
 694         redirectToUrl('modules.php?module=index&code=' . getCode('MODULE_MEM_ONLY') . '&mod=' . getModule());
 695 }
 696
 697 // Wrapper function to redirect to current URL
 698 function redirectToRequestUri () {
 699         redirectToUrl(basename(detectRequestUri()));
 700 }
 701
 702 // Wrapper function to redirect to de-refered URL
 703 function redirectToDereferedUrl ($URL) {
 704         // Redirect to to
 705         redirectToUrl(generateDerefererUrl($URL));
 706 }
 707
 708 // Wrapper function for checking if extension is installed and newer or same version
 709 function isExtensionInstalledAndNewer ($ext_name, $version) {
 710         // Return it
 711         //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'=&gt;'.$version.'<br />';
 712         return ((isExtensionInstalled($ext_name)) && (getExtensionVersion($ext_name) >= $version));
 713 }
 714
 715 // Wrapper function for checking if extension is installed and older than given version
 716 function isExtensionInstalledAndOlder ($ext_name, $version) {
 717         // Return it
 718         //* DEBUG: */ print __FUNCTION__.':'.$ext_name.'&lt;'.$version.'<br />';
 719         return ((isExtensionInstalled($ext_name)) && (isExtensionOlder($ext_name, $version)));
 720 }
 721
 722 // Set username
 723 function setUsername ($userName) {
 724         $GLOBALS['username'] = (string) $userName;
 725 }
 726
 727 // Get username
 728 function getUsername () {
 729         // User name set?
 730         if (!isset($GLOBALS['username'])) {
 731                 // No, so it has to be a guest
 732                 $GLOBALS['username'] = getMessage('USERNAME_GUEST');
 733         } // END - if
 734
 735         // Return it
 736         return $GLOBALS['username'];
 737 }
 738
 739 // Wrapper function for installation phase
 740 function isInstallationPhase () {
 741         // Do we have cache?
 742         if (!isset($GLOBALS['installation_phase'])) {
 743                 // Determine it
 744                 $GLOBALS['installation_phase'] = ((!isInstalled()) || (isInstalling()));
 745         } // END - if
 746
 747         // Return result
 748         return $GLOBALS['installation_phase'];
 749 }
 750
 751 // Checks wether the extension demo is actuve and the admin login is demo (password needs to be demo, too!)
 752 function isDemoModeActive () {
 753         return ((isExtensionActive('demo')) && (getSession('admin_login') == 'demo'));
 754 }
 755
 756 // Getter for PHP caching value
 757 function getPhpCaching () {
 758         return $GLOBALS['php_caching'];
 759 }
 760
 761 // Checks wether the admin hash is set
 762 function isAdminHashSet ($admin) {
 763         /**
 764          * @TODO Do we really need this check? If yes, try to fix this:
 765          * 1.:functions.php:2504, debug_get_mailable_backtrace(0)
 766          * 2.:wrapper-functions.php:744, debug_report_bug(1)
 767          * 3.:mysql-manager.php:728, isAdminHashSet(1)
 768          * 4.:filters.php:384, isAdmin(0)
 769          * 5.:debug_get_mailable_backtrace:2457, FILTER_DETERMINE_USERNAME(1)
 770          * 6.:filter-functions.php:280, call_user_func_array(2)
 771          * 7.:load_cache.php:74, runFilterChain(1)
 772          * 8.:inc-functions.php:131, include(1)
 773          * 9.:inc-functions.php:145, loadInclude(1)
 774          * 10.:mysql-connect.php:104, loadIncludeOnce(1)
 775          * 11.:inc-functions.php:131, include(1)
 776          * 12.:inc-functions.php:145, loadInclude(1)
 777          * 13.:config-global.php:106, loadIncludeOnce(1)
 778          * 14.:js.php:57, require(1)
 779          */
 780         if (!isset($GLOBALS['cache_array']['admin'])) {
 781                 debug_report_bug('Cache not set.');
 782         } // END - if
 783
 784         // Check for admin hash
 785         return isset($GLOBALS['cache_array']['admin']['password'][$admin]);
 786 }
 787
 788 // Setter for admin hash
 789 function setAdminHash ($admin, $hash) {
 790         $GLOBALS['cache_array']['admin']['password'][$admin] = $hash;
 791 }
 792
 793 // Init user data array
 794 function initUserData () {
 795         // User id should not be zero
 796         if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
 797
 798         // Init the user
 799         $GLOBALS['user_data'][getCurrentUserId()] = array();
 800 }
 801
 802 // Getter for user data
 803 function getUserData ($column) {
 804         // User id should not be zero
 805         if (getCurrentUserId() < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
 806
 807         // Return the value
 808         return $GLOBALS['user_data'][getCurrentUserId()][$column];
 809 }
 810
 811 // Geter for whole user data array
 812 function getUserDataArray () {
 813         // Get user id
 814         $uid = getCurrentUserId();
 815
 816         // User id should not be zero
 817         if ($uid < 1) debug_report_bug(__FUNCTION__.': User id is zero.');
 818
 819         // Get the whole array if found
 820         if (isset($GLOBALS['user_data'][$uid])) {
 821                 // Found, so return it
 822                 return $GLOBALS['user_data'][$uid];
 823         } else {
 824                 // Return empty array
 825                 return array();
 826         }
 827 }
 828
 829 // Checks if the user data is valid, this may indicate that the user has logged
 830 // in, but you should use isMember() if you want to find that out.
 831 function isUserDataValid () {
 832         // User id should not be zero so abort here
 833         if (!isCurrentUserIdSet()) return false;
 834
 835         // Is it cached?
 836         if (!isset($GLOBALS['is_userdata_valid'][getCurrentUserId()])) {
 837                 // Determine it
 838                 $GLOBALS['is_userdata_valid'][getCurrentUserId()] = ((isset($GLOBALS['user_data'][getCurrentUserId()])) && (count($GLOBALS['user_data'][getCurrentUserId()]) > 1));
 839         } // END - if
 840
 841         // Return the result
 842         return $GLOBALS['is_userdata_valid'][getCurrentUserId()];
 843 }
 844
 845 // Setter for current userid
 846 function setCurrentUserId ($userid) {
 847         $GLOBALS['current_userid'] = bigintval($userid);
 848 }
 849
 850 // Getter for current userid
 851 function getCurrentUserId () {
 852         // Userid must be set before it can be used
 853         if (!isCurrentUserIdSet()) {
 854                 // Not set
 855                 debug_report_bug('User id is not set.');
 856         } // END - if
 857
 858         // Return the userid
 859         return $GLOBALS['current_userid'];
 860 }
 861
 862 // Checks if current userid is set
 863 function isCurrentUserIdSet () {
 864         return isset($GLOBALS['current_userid']);
 865 }
 866
 867 // Checks wether we are debugging template cache
 868 function isDebuggingTemplateCache () {
 869         return (getConfig('DEBUG_TEMPLATE_CACHE') == 'Y');
 870 }
 871
 872 // Wrapper for fetchUserData() and getUserData() calls
 873 function getFetchedUserData ($keyColumn, $userId, $valueColumn) {
 874         // Is it cached?
 875         if (!isset($GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn])) {
 876                 // Default is 'guest'
 877                 $data = getMessage('USERNAME_GUEST');
 878
 879                 // Can we fetch the user data?
 880                 if (($userId > 0) && (fetchUserData($userId, $keyColumn))) {
 881                         // Now get the data back
 882                         $data = getUserData($valueColumn);
 883                 } // END - if
 884
 885                 // Cache it
 886                 $GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn] = $data;
 887         } // END - if
 888
 889         // Return it
 890         return $GLOBALS['user_data_cache'][$userid][$keyColumn][$valueColumn];
 891 }
 892
 893 // Wrapper for strpos() to ease porting from deprecated ereg() function
 894 function isInString ($needle, $haystack) {
 895         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'needle=' . $needle . ', haystack=' . $haystack . ', returned=' . intval(strpos($haystack, $needle) !== false));
 896         return (strpos($haystack, $needle) !== false);
 897 }
 898
 899 // Wrapper for strpos() to ease porting from deprecated eregi() function
 900 // This function is case-insensitive
 901 function isInStringIgnoreCase ($needle, $haystack) {
 902         return (isInString(strtolower($needle), strtolower($haystack)));
 903 }
 904
 905 // Wrapper to check for if fatal errors where detected
 906 function ifFatalErrorsDetected () {
 907         // Just call the inner function
 908         return (getTotalFatalErrors() > 0);
 909 }
 910
 911 // [EOF]
 912 ?>