inc/wrapper-functions.php

   1 <?php
   2 /************************************************************************
   3  * MXChange v0.2.1                                    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 // Smartly adds slashes
 141 function smartAddSlashes ($unquoted) {
 142         // Do we have cache?
 143         if (!isset($GLOBALS['smart_addslashes'][$unquoted])) {
 144                 // Remove slashe
 145                 $unquoted = str_replace("\\", '', $unquoted);
 146
 147                 // Put it in cache and add slashes
 148                 $GLOBALS['smart_addslashes'][$unquoted] = addslashes($unquoted);
 149         } // END - if
 150
 151         // Return result
 152         return $GLOBALS['smart_addslashes'][$unquoted];
 153 }
 154
 155 // Decode entities in a nicer way
 156 function decodeEntities ($str) {
 157         // Decode the entities to UTF-8 now
 158         $decodedString = html_entity_decode($str, ENT_NOQUOTES, 'UTF-8');
 159
 160         // Return decoded string
 161         return $decodedString;
 162 }
 163
 164 // Merges an array together but only if both are arrays
 165 function merge_array ($array1, $array2) {
 166         // Are both an array?
 167         if ((!is_array($array1)) && (!is_array($array2))) {
 168                 // Both are not arrays
 169                 debug_report_bug(__FUNCTION__ . ': No arrays provided!');
 170         } elseif (!is_array($array1)) {
 171                 // Left one is not an array
 172                 debug_report_bug(sprintf("[%s:%s] array1 is not an array. array != %s", __FUNCTION__, __LINE__, gettype($array1)));
 173         } elseif (!is_array($array2)) {
 174                 // Right one is not an array
 175                 debug_report_bug(sprintf("[%s:%s] array2 is not an array. array != %s", __FUNCTION__, __LINE__, gettype($array2)));
 176         }
 177
 178         // Merge all together
 179         return array_merge($array1, $array2);
 180 }
 181
 182 // Check if given FQFN is a readable file
 183 function isFileReadable ($FQFN) {
 184         // Do we have cache?
 185         if (!isset($GLOBALS['file_readable'][$FQFN])) {
 186                 // Check all...
 187                 $GLOBALS['file_readable'][$FQFN] = ((file_exists($FQFN)) && (is_file($FQFN)) && (is_readable($FQFN)));
 188         } // END - if
 189
 190         // Return result
 191         return $GLOBALS['file_readable'][$FQFN];
 192 }
 193
 194 // Checks wether the given FQFN is a directory and not ., .. or .svn
 195 function isDirectory ($FQFN) {
 196         // Do we have cache?
 197         if (!isset($GLOBALS['is_directory'][$FQFN])) {
 198                 // Generate baseName
 199                 $baseName = basename($FQFN);
 200
 201                 // Check it
 202                 $GLOBALS['is_directory'][$FQFN] = ((is_dir($FQFN)) && ($baseName != '.') && ($baseName != '..') && ($baseName != '.svn'));
 203         } // END - if
 204
 205         // Return the result
 206         return $GLOBALS['is_directory'][$FQFN];
 207 }
 208
 209 // "Getter" for remote IP number
 210 function detectRemoteAddr () {
 211         // Get remote ip from environment
 212         $remoteAddr = determineRealRemoteAddress();
 213
 214         // Is removeip installed?
 215         if (isExtensionActive('removeip')) {
 216                 // Then anonymize it
 217                 $remoteAddr = getAnonymousRemoteAddress($remoteAddr);
 218         } // END - if
 219
 220         // Return it
 221         return $remoteAddr;
 222 }
 223
 224 // "Getter" for remote hostname
 225 function detectRemoteHostname () {
 226         // Get remote ip from environment
 227         $remoteHost = getenv('REMOTE_HOST');
 228
 229         // Is removeip installed?
 230         if (isExtensionActive('removeip')) {
 231                 // Then anonymize it
 232                 $remoteHost = getAnonymousRemoteHost($remoteHost);
 233         } // END - if
 234
 235         // Return it
 236         return $remoteHost;
 237 }
 238
 239 // "Getter" for user agent
 240 function detectUserAgent () {
 241         // Get remote ip from environment
 242         $userAgent = getenv('HTTP_USER_AGENT');
 243
 244         // Is removeip installed?
 245         if (isExtensionActive('removeip')) {
 246                 // Then anonymize it
 247                 $userAgent = getAnonymousUserAgent($userAgent);
 248         } // END - if
 249
 250         // Return it
 251         return $userAgent;
 252 }
 253
 254 // "Getter" for referer
 255 function detectReferer () {
 256         // Get remote ip from environment
 257         $referer = getenv('HTTP_REFERER');
 258
 259         // Is removeip installed?
 260         if (isExtensionActive('removeip')) {
 261                 // Then anonymize it
 262                 $referer = getAnonymousReferer($referer);
 263         } // END - if
 264
 265         // Return it
 266         return $referer;
 267 }
 268
 269 // Check wether we are installing
 270 function isInstalling () {
 271         // Determine wether we are installing
 272         if (!isset($GLOBALS['mxchange_installing'])) {
 273                 // Check URL (css.php/js.php need this)
 274                 $GLOBALS['mxchange_installing'] = isGetRequestElementSet('installing');
 275         } // END - if
 276
 277         // Return result
 278         return $GLOBALS['mxchange_installing'];
 279 }
 280
 281 // Check wether this script is installed
 282 function isInstalled () {
 283         // Do we have cache?
 284         if (!isset($GLOBALS['is_installed'])) {
 285                 // Determine wether this script is installed
 286                 $GLOBALS['is_installed'] = (
 287                 (
 288                         // First is config
 289                         getConfig('MXCHANGE_INSTALLED') == 'Y'
 290                 ) || (
 291                         // New config file found and loaded
 292                         isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
 293                 ) || (
 294                         (
 295                                 // New config file found, but not yet read
 296                                 isIncludeReadable(getConfig('CACHE_PATH') . 'config-local.php')
 297                         ) && (
 298                                 (
 299                                         // Only new config file is found
 300                                         !isIncludeReadable('inc/config.php')
 301                                 ) || (
 302                                         // Is installation mode
 303                                         !isInstalling()
 304                                 )
 305                         )
 306                 ));
 307         } // END - if
 308
 309         // Then use the cache
 310         return $GLOBALS['is_installed'];
 311 }
 312
 313 // Check wether an admin is registered
 314 function isAdminRegistered () {
 315         return (getConfig('ADMIN_REGISTERED') == 'Y');
 316 }
 317
 318 // Checks wether the reset mode is active
 319 function isResetModeEnabled () {
 320         // Now simply check it
 321         return ((isset($GLOBALS['reset_enabled'])) && ($GLOBALS['reset_enabled'] === true));
 322 }
 323
 324 // Checks wether the debug mode is enabled
 325 function isDebugModeEnabled () {
 326         // Simply check it
 327         return (getConfig('DEBUG_MODE') == 'Y');
 328 }
 329
 330 // Checks wether we shall debug regular expressions
 331 function isDebugRegExpressionEnabled () {
 332         // Simply check it
 333         return (getConfig('DEBUG_REGEX') == 'Y');
 334 }
 335
 336 // Checks wether the cache instance is valid
 337 function isCacheInstanceValid () {
 338         return ((isset($GLOBALS['cache_instance'])) && (is_object($GLOBALS['cache_instance'])));
 339 }
 340
 341 // Copies a file from source to destination and verifies if that goes fine.
 342 // This function should wrap the copy() command and make a nicer debug backtrace
 343 // even if there is no xdebug extension installed.
 344 function copyFileVerified ($source, $dest, $chmod = '') {
 345         // Failed is the default
 346         $status = false;
 347
 348         // Is the source file there?
 349         if (!isFileReadable($source)) {
 350                 // Then abort here
 351                 debug_report_bug('Cannot read from source file ' . basename($source) . '.');
 352         } // END - if
 353
 354         // Is the target directory there?
 355         if (!isDirectory(dirname($dest))) {
 356                 // Then abort here
 357                 debug_report_bug('Cannot find directory ' . str_replace(getConfig('PATH'), '', dirname($dest)) . '.');
 358         } // END - if
 359
 360         // Now try to copy it
 361         if (!copy($source, $dest)) {
 362                 // Something went wrong
 363                 debug_report_bug('copy() has failed to copy the file.');
 364         } else {
 365                 // Reset cache
 366                 $GLOBALS['file_readable'][$dest] = true;
 367         }
 368
 369         // If there are chmod rights set, apply them
 370         if (!empty($chmod)) {
 371                 // Try to apply them
 372                 $status = changeMode($dest, $chmod);
 373         } else {
 374                 // All fine
 375                 $status = true;
 376         }
 377
 378         // All fine
 379         return $status;
 380 }
 381
 382 // Wrapper function for header()
 383 // Send a header but checks before if we can do so
 384 function sendHeader ($header) {
 385         // Is the header already sent?
 386         if (headers_sent()) {
 387                 // Then abort here
 388                 debug_report_bug('Headers already sent!');
 389         } // END - if
 390
 391         // Send the header
 392         header(trim($header));
 393 }
 394
 395 // Wrapper function for chmod()
 396 // @TODO Do some more sanity check here
 397 function changeMode ($FQFN, $mode) {
 398         // Is the file/directory there?
 399         if ((!isFileReadable($FQFN)) && (!isDirectory($FQFN))) {
 400                 // Neither, so abort here
 401                 debug_report_bug('Cannot chmod() on ' . basename($FQFN) . '.');
 402         } // END - if
 403
 404         // Try to set them
 405         chmod($FQFN, $mode);
 406 }
 407
 408 // Wrapper for unlink()
 409 function removeFile ($FQFN) {
 410         // Is the file there?
 411         if (isFileReadable($FQFN)) {
 412                 // Reset cache first
 413                 $GLOBALS['file_readable'][$FQFN] = false;
 414
 415                 // Yes, so remove it
 416                 return unlink($FQFN);
 417         } // END - if
 418
 419         // All fine if no file was removed. If we change this to 'false' or rewrite
 420         // above if() block it would be to restrictive.
 421         return true;
 422 }
 423
 424 // Wrapper for $_POST['sel']
 425 function countPostSelection () {
 426         return countSelection(postRequestElement('sel'));
 427 }
 428
 429 // Checks wether the config-local.php is loaded
 430 function isConfigLocalLoaded () {
 431         return ((isset($GLOBALS['config_local_loaded'])) && ($GLOBALS['config_local_loaded'] === true));
 432 }
 433
 434 // Checks wether a nickname or userid was entered and caches the result
 435 function isNicknameUsed ($userid) {
 436         // Default is false
 437         $isUsed = false;
 438
 439         // Is the cache there
 440         if (isset($GLOBALS['cache_probe_nicknames'][$userid])) {
 441                 // Then use it
 442                 $isUsed = $GLOBALS['cache_probe_nicknames'][$userid];
 443         } else {
 444                 // Determine it
 445                 $isUsed = ((isExtensionActive('nickname')) && (('' . round($userid) . '') != $userid));
 446
 447                 // And write it to the cache
 448                 $GLOBALS['cache_probe_nicknames'][$userid] = $isUsed;
 449         }
 450
 451         // Return the result
 452         return $isUsed;
 453 }
 454
 455 // Getter for 'what' value
 456 function getWhat () {
 457         // Default is null
 458         $what = null;
 459
 460         // Is the value set?
 461         if (isWhatSet(true)) {
 462                 // Then use it
 463                 $what = $GLOBALS['what'];
 464         } // END - if
 465
 466         // Return it
 467         return $what;
 468 }
 469
 470 // Setter for 'what' value
 471 function setWhat ($newWhat) {
 472         $GLOBALS['what'] = SQL_ESCAPE($newWhat);
 473 }
 474
 475 // Setter for 'what' from configuration
 476 function setWhatFromConfig ($configEntry) {
 477         // Get 'what' from config
 478         $what = getConfig($configEntry);
 479
 480         // Set it
 481         setWhat($what);
 482 }
 483
 484 // Checks wether what is set and optionally aborts on miss
 485 function isWhatSet ($abortOnMiss =  false) {
 486         // Check for it
 487         $isset = (isset($GLOBALS['what']));
 488
 489         // Should we abort here?
 490         if (($abortOnMiss === true) && ($isset === false)) {
 491                 // Output backtrace
 492                 debug_report_bug('what is empty.');
 493         } // END - if
 494
 495         // Return it
 496         return $isset;
 497 }
 498
 499 // Getter for 'action' value
 500 function getAction () {
 501         // Default is null
 502         $action = null;
 503
 504         // Is the value set?
 505         if (isActionSet(true)) {
 506                 // Then use it
 507                 $action = $GLOBALS['action'];
 508         } // END - if
 509
 510         // Return it
 511         return $action;
 512 }
 513
 514 // Setter for 'action' value
 515 function setAction ($newAction) {
 516         $GLOBALS['action'] = SQL_ESCAPE($newAction);
 517 }
 518
 519 // Checks wether action is set and optionally aborts on miss
 520 function isActionSet ($abortOnMiss =  false) {
 521         // Check for it
 522         $isset = (isset($GLOBALS['action']));
 523
 524         // Should we abort here?
 525         if (($abortOnMiss === true) && ($isset === false)) {
 526                 // Output backtrace
 527                 debug_report_bug('action is empty.');
 528         } // END - if
 529
 530         // Return it
 531         return $isset;
 532 }
 533
 534 // Getter for 'module' value
 535 function getModule () {
 536         // Default is null
 537         $module = null;
 538
 539         // Is the value set?
 540         if (isModuleSet(true)) {
 541                 // Then use it
 542                 $module = $GLOBALS['module'];
 543         } // END - if
 544
 545         // Return it
 546         return $module;
 547 }
 548
 549 // Setter for 'module' value
 550 function setModule ($newModule) {
 551         // Secure it and make all modules lower-case
 552         $GLOBALS['module'] = SQL_ESCAPE(strtolower($newModule));
 553 }
 554
 555 // Checks wether module is set and optionally aborts on miss
 556 function isModuleSet ($abortOnMiss =  false) {
 557         // Check for it
 558         $isset = (!empty($GLOBALS['module']));
 559
 560         // Should we abort here?
 561         if (($abortOnMiss === true) && ($isset === false)) {
 562                 // Output backtrace
 563                 print '<pre>';
 564                 debug_print_backtrace();
 565                 die('</pre');
 566                 debug_report_bug('module is empty.');
 567         } // END - if
 568
 569         // Return it
 570         return $isset;
 571 }
 572
 573 // Getter for 'output_mode' value
 574 function getOutputMode () {
 575         // Default is null
 576         $output_mode = null;
 577
 578         // Is the value set?
 579         if (isOutputModeSet(true)) {
 580                 // Then use it
 581                 $output_mode = $GLOBALS['output_mode'];
 582         } // END - if
 583
 584         // Return it
 585         return $output_mode;
 586 }
 587
 588 // Setter for 'output_mode' value
 589 function setOutputMode ($newOutputMode) {
 590         $GLOBALS['output_mode'] = SQL_ESCAPE($newOutputMode);
 591 }
 592
 593 // Checks wether output_mode is set and optionally aborts on miss
 594 function isOutputModeSet ($abortOnMiss =  false) {
 595         // Check for it
 596         $isset = (isset($GLOBALS['output_mode']));
 597
 598         // Should we abort here?
 599         if (($abortOnMiss === true) && ($isset === false)) {
 600                 // Output backtrace
 601                 debug_report_bug('output_mode is empty.');
 602         } // END - if
 603
 604         // Return it
 605         return $isset;
 606 }
 607
 608 // Enables block-mode
 609 function enableBlockMode ($enabled = true) {
 610         $GLOBALS['block_mode'] = $enabled;
 611 }
 612
 613 // Checks wether block-mode is enabled
 614 function isBlockModeEnabled () {
 615         // Abort if not set
 616         if (!isset($GLOBALS['block_mode'])) {
 617                 // Needs to be fixed
 618                 debug_report_bug(__FUNCTION__ . ': block_mode is not set.');
 619         } // END - if
 620
 621         // Return it
 622         return $GLOBALS['block_mode'];
 623 }
 624
 625 // Wrapper function for addPointsThroughReferalSystem()
 626 function addPointsDirectly ($subject, $userid, $points) {
 627         // Reset level here
 628         unset($GLOBALS['ref_level']);
 629
 630         // Call more complicated method (due to more parameters)
 631         return addPointsThroughReferalSystem($subject, $userid, $points, false, 0, false, 'direct');
 632 }
 633
 634 // Wrapper function to redirect from member-only modules to index
 635 function redirectToIndexMemberOnlyModule () {
 636         // Do the redirect here
 637         redirectToUrl('modules.php?module=index&amp;code=' . getCode('MODULE_MEM_ONLY') . '&amp;mod=' . getModule());
 638 }
 639
 640 // Wrapper function for checking if extension is installed and newer or same version
 641 function isExtensionInstalledAndNewer ($ext_name, $version) {
 642         // Return it
 643         return ((isExtensionInstalled($ext_name)) && (getExtensionVersion($ext_name) >= $version));
 644 }
 645
 646 // Wrapper function for checking if extension is installed and older than given version
 647 function isExtensionInstalledAndOlder ($ext_name, $version) {
 648         // Return it
 649         return ((isExtensionInstalled($ext_name)) && (isExtensionOlder($ext_name, $version)));
 650 }
 651
 652 // Set username
 653 function setUsername ($userName) {
 654         $GLOBALS['username'] = (string) $userName;
 655 }
 656
 657 // Get username
 658 function getUsername () {
 659         return $GLOBALS['username'];
 660 }
 661
 662 // Wrapper function for installation phase
 663 function isInstallationPhase () {
 664         // Do we have cache?
 665         if (!isset($GLOBALS['installation_phase'])) {
 666                 // Determine it
 667                 $GLOBALS['installation_phase'] = ((!isInstalled()) || (isInstalling()));
 668         } // END - if
 669
 670         // Return result
 671         return $GLOBALS['installation_phase'];
 672 }
 673
 674 // Checks wether the extension demo is actuve and the admin login is demo (password needs to be demo, too!)
 675 function isDemoModeActive () {
 676         return ((isExtensionActive('demo')) && (getSession('admin_login') == 'demo'));
 677 }
 678
 679 // Wrapper function to redirect to de-refered URL
 680 function redirectToDereferedUrl ($URL) {
 681         // De-refer the URL
 682         $URL = generateDerefererUrl($URL);
 683
 684         // Redirect to to
 685         redirectToUrl($URL);
 686 }
 687
 688 // Getter for PHP caching value
 689 function getPhpCaching () {
 690         return $GLOBALS['php_caching'];
 691 }
 692
 693 // Checks wether the admin hash is set
 694 function isAdminHashSet ($admin) {
 695         return isset($GLOBALS['cache_array']['admin']['password'][$admin]);
 696 }
 697
 698 // Setter for admin hash
 699 function setAdminHash ($admin, $hash) {
 700         $GLOBALS['cache_array']['admin']['password'][$admin] = $hash;
 701 }
 702
 703 // [EOF]
 704 ?>