inc/functions.php

   1 <?php
   2 /************************************************************************
   3  * Mailer v0.2.1-FINAL                                Start: 08/25/2003 *
   4  * ===================                          Last change: 11/29/2005 *
   5  *                                                                      *
   6  * -------------------------------------------------------------------- *
   7  * File              : functions.php                                    *
   8  * -------------------------------------------------------------------- *
   9  * Short description : Many non-database functions (also file access)   *
  10  * -------------------------------------------------------------------- *
  11  * Kurzbeschreibung  : Viele Nicht-Datenbank-Funktionen                 *
  12  * -------------------------------------------------------------------- *
  13  * $Revision::                                                        $ *
  14  * $Date::                                                            $ *
  15  * $Tag:: 0.2.1-FINAL                                                 $ *
  16  * $Author::                                                          $ *
  17  * -------------------------------------------------------------------- *
  18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
  19  * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
  20  * For more information visit: http://mxchange.org                      *
  21  *                                                                      *
  22  * This program is free software; you can redistribute it and/or modify *
  23  * it under the terms of the GNU General Public License as published by *
  24  * the Free Software Foundation; either version 2 of the License, or    *
  25  * (at your option) any later version.                                  *
  26  *                                                                      *
  27  * This program is distributed in the hope that it will be useful,      *
  28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  30  * GNU General Public License for more details.                         *
  31  *                                                                      *
  32  * You should have received a copy of the GNU General Public License    *
  33  * along with this program; if not, write to the Free Software          *
  34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
  35  * MA  02110-1301  USA                                                  *
  36  ************************************************************************/
  37
  38 // Some security stuff...
  39 if (!defined('__SECURITY')) {
  40         die();
  41 } // END - if
  42
  43 // Init fatal message array
  44 function initFatalMessages () {
  45         $GLOBALS['fatal_messages'] = array();
  46 }
  47
  48 // Getter for whole fatal error messages
  49 function getFatalArray () {
  50         return $GLOBALS['fatal_messages'];
  51 }
  52
  53 // Add a fatal error message to the queue array
  54 function addFatalMessage ($F, $L, $message, $extra = '') {
  55         if (is_array($extra)) {
  56                 // Multiple extras for a message with masks
  57                 $message = call_user_func_array('sprintf', $extra);
  58         } elseif (!empty($extra)) {
  59                 // $message is text with a mask plus extras to insert into the text
  60                 $message = sprintf($message, $extra);
  61         }
  62
  63         // Add message to $GLOBALS['fatal_messages']
  64         array_push($GLOBALS['fatal_messages'], $message);
  65
  66         // Log fatal messages away
  67         logDebugMessage($F, $L, 'Fatal error message: ' . compileCode($message));
  68 }
  69
  70 // Getter for total fatal message count
  71 function getTotalFatalErrors () {
  72         // Init count
  73         $count = 0;
  74
  75         // Is there at least the first entry?
  76         if (!empty($GLOBALS['fatal_messages'][0])) {
  77                 // Get total count
  78                 $count = count($GLOBALS['fatal_messages']);
  79                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count=' . $count . ' - FROM ARRAY');
  80         } // END - if
  81
  82         // Return value
  83         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count=' . $count . ' - EXIT!');
  84         return $count;
  85 }
  86
  87 // Generate a password in a specified length or use default password length
  88 function generatePassword ($length = '0', $exclude = array()) {
  89         // Auto-fix invalid length of zero
  90         if ($length == '0') {
  91                 $length = getPassLen();
  92         } // END - if
  93
  94         // Exclude some entries
  95         $localAbc = array_diff($GLOBALS['_abc'], $exclude);
  96
  97         // $localAbc must have at least 10 entries
  98         assert(count($localAbc) >= 10);
  99
 100         // Start creating password
 101         $password = '';
 102         while (strlen($password) < $length) {
 103                 $password .= $localAbc[mt_rand(0, count($localAbc) -1)];
 104         } // END - while
 105
 106         /*
 107          * When the size is below 40 we can also add additional security by
 108          * scrambling it. Otherwise the hash may corrupted..
 109          */
 110         if (strlen($password) <= 40) {
 111                 // Also scramble the password
 112                 $password = scrambleString($password);
 113         } // END - if
 114
 115         // Return the password
 116         return $password;
 117 }
 118
 119 // Generates a human-readable timestamp from the Uni* stamp
 120 function generateDateTime ($time, $mode = '0') {
 121         // Is there cache?
 122         if (isset($GLOBALS[__FUNCTION__][$time][$mode])) {
 123                 // Return it instead
 124                 return $GLOBALS[__FUNCTION__][$time][$mode];
 125         } // END - if
 126
 127         // If the stamp is zero it mostly didn't "happen"
 128         if (($time == '0') || (is_null($time))) {
 129                 // Never happend
 130                 return '{--NEVER_HAPPENED--}';
 131         } // END - if
 132
 133         // Filter out numbers
 134         $timeSecured = bigintval($time);
 135
 136         // Detect language
 137         switch (getLanguage()) {
 138                 case 'de': // German date / time format
 139                         switch ($mode) {
 140                                 case '0': $ret = date("d.m.Y \u\m H:i \U\h\\r", $timeSecured); break;
 141                                 case '1': $ret = strtolower(date('d.m.Y - H:i', $timeSecured)); break;
 142                                 case '2': $ret = date('d.m.Y|H:i', $timeSecured); break;
 143                                 case '3': $ret = date('d.m.Y', $timeSecured); break;
 144                                 case '4': $ret = date('d.m.Y|H:i:s', $timeSecured); break;
 145                                 case '5': $ret = date('d-m-Y (l-F-T)', $timeSecured); break;
 146                                 case '6': $ret = date('Ymd', $timeSecured); break;
 147                                 case '7': $ret = date('Y-m-d H:i:s', $timeSecured); break; // Compatible with MySQL TIMESTAMP
 148                                 default:
 149                                         logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
 150                                         break;
 151                         } // END - switch
 152                         break;
 153
 154                 default: // Default is the US date / time format!
 155                         switch ($mode) {
 156                                 case '0': $ret = date('r', $timeSecured); break;
 157                                 case '1': $ret = strtolower(date('Y-m-d - g:i A', $timeSecured)); break;
 158                                 case '2': $ret = date('y-m-d|H:i', $timeSecured); break;
 159                                 case '3': $ret = date('y-m-d', $timeSecured); break;
 160                                 case '4': $ret = date('d.m.Y|H:i:s', $timeSecured); break;
 161                                 case '5': $ret = date('d-m-Y (l-F-T)', $timeSecured); break;
 162                                 case '6': $ret = date('Ymd', $timeSecured); break;
 163                                 case '7': $ret = date('Y-m-d H:i:s', $timeSecured); break; // Compatible with MySQL TIMESTAMP
 164                                 default:
 165                                         logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
 166                                         break;
 167                         } // END - switch
 168         } // END - switch
 169
 170         // Store it in cache
 171         $GLOBALS[__FUNCTION__][$time][$mode] = $ret;
 172
 173         // Return result
 174         return $ret;
 175 }
 176
 177 // Translates Y/N to yes/no
 178 function translateYesNo ($yn) {
 179         // Is it cached?
 180         if (!isset($GLOBALS[__FUNCTION__][$yn])) {
 181                 // Default
 182                 $GLOBALS[__FUNCTION__][$yn] = '??? (' . $yn . ')';
 183                 switch ($yn) {
 184                         case 'Y': $GLOBALS[__FUNCTION__][$yn] = '{--YES--}'; break;
 185                         case 'N': $GLOBALS[__FUNCTION__][$yn] = '{--NO--}'; break;
 186                         default:
 187                                 // Log unknown value
 188                                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown value %s. Expected: Y/N", $yn));
 189                                 break;
 190                 } // END - switch
 191         } // END - if
 192
 193         // Return it
 194         return $GLOBALS[__FUNCTION__][$yn];
 195 }
 196
 197 // "Translates" Y/N into "de-/active"
 198 function translateActivationStatus ($status) {
 199         // Is it cached?
 200         if (!isset($GLOBALS[__FUNCTION__][$status])) {
 201                 // Default
 202                 $GLOBALS[__FUNCTION__][$status] = '??? (' . $status . ')';
 203                 switch ($status) {
 204                         case 'Y': $GLOBALS[__FUNCTION__][$status] = '{--ACTIVATED--}'; break;
 205                         case 'N': $GLOBALS[__FUNCTION__][$status] = '{--DEACTIVATED--}'; break;
 206                         default:
 207                                 // Log unknown value
 208                                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown value %s. Expected: Y/N", $status));
 209                                 break;
 210                 } // END - switch
 211         } // END - if
 212
 213         // Return it
 214         return $GLOBALS[__FUNCTION__][$status];
 215 }
 216
 217 // Translates the american decimal dot into a german comma
 218 // OPPOMENT: convertCommaToDot()
 219 function translateComma ($dotted, $cut = TRUE, $max = '0') {
 220         // First, cast all to double, due to PHP changes
 221         $dotted = (double) $dotted;
 222
 223         // Default is 3 you can change this in admin area "Settings -> Misc Options"
 224         if (!isConfigEntrySet('max_comma')) {
 225                 setConfigEntry('max_comma', 3);
 226         } // END - if
 227
 228         // Use from config is default
 229         $maxComma = getConfig('max_comma');
 230
 231         // Use from parameter?
 232         if ($max > 0) {
 233                 $maxComma = $max;
 234         } // END - if
 235
 236         // Cut zeros off?
 237         if (($cut === TRUE) && ($max == '0')) {
 238                 // Test for commata if in cut-mode
 239                 $com = explode('.', $dotted);
 240                 if (count($com) < 2) {
 241                         // Don't display commatas even if there are none... ;-)
 242                         $maxComma = '0';
 243                 } // END - if
 244         } // END - if
 245
 246         // Debug log
 247
 248         // Translate it now
 249         $translated = $dotted;
 250         switch (getLanguage()) {
 251                 case 'de': // German language
 252                         $translated = number_format($dotted, $maxComma, ',', '.');
 253                         break;
 254
 255                 default: // All others
 256                         $translated = number_format($dotted, $maxComma, '.', ',');
 257                         break;
 258         } // END - switch
 259
 260         // Return translated value
 261         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dotted=' . $dotted . ',translated=' . $translated . ',maxComma=' . $maxComma);
 262         return $translated;
 263 }
 264
 265 // Translate Uni*-like gender to human-readable
 266 function translateGender ($gender) {
 267         // Default
 268         $ret = '!' . $gender . '!';
 269
 270         // Male/female or company?
 271         switch ($gender) {
 272                 case 'M': // Male
 273                 case 'F': // Female
 274                 case 'C': // Company
 275                         // Use generic function
 276                         $ret = translateGeneric('GENDER', $gender);
 277                         break;
 278
 279                 default:
 280                         // Please report bugs on unknown genders
 281                         reportBug(__FUNCTION__, __LINE__, sprintf("Unknown gender %s detected.", $gender));
 282                         break;
 283         } // END - switch
 284
 285         // Return translated gender
 286         return $ret;
 287 }
 288
 289 // "Translates" the user status
 290 function translateUserStatus ($status) {
 291         // Default status is unknown if something goes through
 292         $ret = '{--ACCOUNT_STATUS_UNKNOWN--}';
 293
 294         // Generate message depending on status
 295         switch ($status) {
 296                 case 'UNCONFIRMED':
 297                 case 'CONFIRMED':
 298                 case 'LOCKED':
 299                         // Use generic function for all "normal" cases"
 300                         $ret = translateGeneric('ACCOUNT_STATUS', $status);
 301                         break;
 302
 303                 case '': // Account deleted
 304                 case NULL: // Account deleted
 305                         $ret = '{--ACCOUNT_STATUS_DELETED--}';
 306                         break;
 307
 308                 default: // Please report all unknown status
 309                         reportBug(__FUNCTION__, __LINE__, sprintf("Unknown status %s(%s) detected.", $status, gettype($status)));
 310                         break;
 311         } // END - switch
 312
 313         // Return it
 314         return $ret;
 315 }
 316
 317 // "Translates" 'visible' and 'locked' to a CSS class
 318 function translateMenuVisibleLocked ($content, $prefix = '') {
 319         // Default is 'menu_unknown'
 320         $content['visible_css'] = $prefix . 'menu_unknown';
 321
 322         // Translate 'visible' and keep an eye on the prefix
 323         switch ($content['visible']) {
 324                 case 'Y': // Should be visible
 325                         $content['visible_css'] = $prefix . 'menu_visible';
 326                         break;
 327
 328                 case 'N': // Is invisible
 329                         $content['visible_css'] = $prefix . 'menu_invisible';
 330                         break;
 331
 332                 default: // Please report this
 333                         reportBug(__FUNCTION__, __LINE__, 'Unsupported visible value detected. content=<pre>' . print_r($content, TRUE) . '</pre>');
 334                         break;
 335         } // END - switch
 336
 337         // Translate 'locked' and keep an eye on the prefix
 338         switch ($content['locked']) {
 339                 case 'Y': // Should be locked, only admins can call this
 340                         $content['locked_css'] = $prefix . 'menu_locked';
 341                         break;
 342
 343                 case 'N': // Is unlocked and visible to members/guests/sponsors
 344                         $content['locked_css'] = $prefix . 'menu_unlocked';
 345                         break;
 346
 347                 default: // Please report this
 348                         reportBug(__FUNCTION__, __LINE__, 'Unsupported locked value detected. content=<pre>' . print_r($content, TRUE) . '</pre>');
 349                         break;
 350         } // END - switch
 351
 352         // Return the resulting array
 353         return $content;
 354 }
 355
 356 // Generates an URL for the dereferer
 357 function generateDereferrerUrl ($url) {
 358         // Don't de-refer our own links!
 359         if ((!empty($url)) && (substr($url, 0, strlen(getUrl())) != getUrl())) {
 360                 // Encode URL
 361                 $encodedUrl = encodeString(compileUriCode($url));
 362
 363                 // Generate hash
 364                 $hash = generateHash($url . getSiteKey() . getDateKey());
 365
 366                 // Log plain URL and hash
 367                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ',hash=' . $hash . '(' . strlen($hash) . ')');
 368
 369                 // De-refer this URL
 370                 $url = '{%url=modules.php?module=loader&amp;url=' . $encodedUrl . '&amp;hash=' . encodeHashForCookie($hash) . '&amp;salt=' . substr($hash, 0, getSaltLength()) . '%}';
 371         } // END - if
 372
 373         // Return link
 374         return $url;
 375 }
 376
 377 // Generates an URL for the frametester
 378 function generateFrametesterUrl ($url) {
 379         // Prepare frametester URL
 380         $frametesterUrl = sprintf("{%%url=modules.php?module=frametester&amp;url=%s%%}",
 381                 encodeString(compileUriCode($url))
 382         );
 383
 384         // Return the new URL
 385         return $frametesterUrl;
 386 }
 387
 388 // Count entries from e.g. a selection box
 389 function countSelection ($array) {
 390         // Integrity check
 391         if (!is_array($array)) {
 392                 // Not an array!
 393                 reportBug(__FUNCTION__, __LINE__, 'No array provided.');
 394         } // END - if
 395
 396         // Init count
 397         $ret = '0';
 398
 399         // Count all entries
 400         foreach ($array as $key => $selected) {
 401                 // Is it checked?
 402                 if (!empty($selected)) {
 403                         // Yes, then count it
 404                         $ret++;
 405                 } // END - if
 406         } // END - foreach
 407
 408         // Return counted selections
 409         return $ret;
 410 }
 411
 412 // Generates a timestamp (some wrapper for mktime())
 413 function makeTime ($hours, $minutes, $seconds, $stamp) {
 414         // Extract day, month and year from given timestamp
 415         $days   = getDay($stamp);
 416         $months = getMonth($stamp);
 417         $years  = getYear($stamp);
 418
 419         // Create timestamp for wished time which depends on extracted date
 420         return mktime(
 421                 $hours,
 422                 $minutes,
 423                 $seconds,
 424                 $months,
 425                 $days,
 426                 $years
 427         );
 428 }
 429
 430 // Redirects to an URL and if neccessarry extends it with own base URL
 431 function redirectToUrl ($url, $allowSpider = TRUE) {
 432         // Is the output mode -2?
 433         if (isAjaxOutputMode()) {
 434                 // This is always (!) an AJAX request and shall not be redirected
 435                 return;
 436         } // END - if
 437
 438         // Remove {%url=
 439         if (substr($url, 0, 6) == '{%url=') {
 440                 $url = substr($url, 6, -2);
 441         } // END - if
 442
 443         // Compile out codes
 444         eval('$url = "' . compileRawCode(encodeUrl($url)) . '";');
 445
 446         // Default 'rel' value is external, nofollow is evil from Google and hurts the Internet
 447         $rel = ' rel="external"';
 448
 449         // Is there internal or external URL?
 450         if (substr($url, 0, strlen(getUrl())) == getUrl()) {
 451                 // Own (=internal) URL
 452                 $rel = '';
 453         } // END - if
 454
 455         // Three different ways to debug...
 456         //* DEBUG: */ reportBug(__FUNCTION__, __LINE__, 'URL=' . $url);
 457         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'URL=' . $url);
 458         //* DEBUG: */ die($url);
 459
 460         // We should not sent a redirect if headers are already sent
 461         if (!headers_sent()) {
 462                 // Load URL when headers are not sent
 463                 sendRawRedirect(doFinalCompilation(str_replace('&amp;', '&', $url), FALSE));
 464         } else {
 465                 // Output error message
 466                 loadInclude('inc/header.php');
 467                 loadTemplate('redirect_url', FALSE, str_replace('&amp;', '&', $url));
 468                 loadInclude('inc/footer.php');
 469         }
 470
 471         // Shut the mailer down here
 472         doShutdown();
 473 }
 474
 475 /************************************************************************
 476  *                                                                      *
 477  * Gaenderter Sortier-Algorythmus, $array wird nach dem Array (!)       *
 478  * $a_sort sortiert:                                                    *
 479  *                                                                      *
 480  * $array - Das 3-dimensionale Array, das paralell sortiert werden soll *
 481  * $a_sort - Array, das die Sortiereihenfolge der ersten Elementeben    *
 482  * $primary_key - Primaerschl.ssel aus $a_sort, nach dem sortiert wird  *
 483  * $order - Sortiereihenfolge: -1 = a-Z, 0 = keine, 1 = Z-a             *
 484  * $nums - TRUE = Als Zahlen sortieren, FALSE = Als Zeichen sortieren   *
 485  *                                                                      *
 486  * $a_sort muss Elemente enthalten, deren Wert Schluessel von $array    *
 487  * sind... Klingt kompliziert, suchen Sie mal mein Beispiel, dann sehen *
 488  * Sie, dass es doch nicht so schwer ist! :-)                           *
 489  *                                                                      *
 490  ************************************************************************/
 491 function array_pk_sort (&$array, $a_sort, $primary_key = '0', $order = -1, $nums = FALSE) {
 492         $temporaryArray = $array;
 493         while ($primary_key < count($a_sort)) {
 494                 foreach ($temporaryArray[$a_sort[$primary_key]] as $key => $value) {
 495                         foreach ($temporaryArray[$a_sort[$primary_key]] as $key2 => $value2) {
 496                                 $match = FALSE;
 497                                 if ($nums === FALSE) {
 498                                         // Sort byte-by-byte (also numbers will be interpreted as chars! E.g.: "9" > "10")
 499                                         if (($key != $key2) && (strcmp(strtolower($temporaryArray[$a_sort[$primary_key]][$key]), strtolower($temporaryArray[$a_sort[$primary_key]][$key2])) == $order)) $match = TRUE;
 500                                 } elseif ($key != $key2) {
 501                                         // Sort numbers (E.g.: 9 < 10)
 502                                         if (($temporaryArray[$a_sort[$primary_key]][$key] < $temporaryArray[$a_sort[$primary_key]][$key2]) && ($order == -1)) $match = TRUE;
 503                                         if (($temporaryArray[$a_sort[$primary_key]][$key] > $temporaryArray[$a_sort[$primary_key]][$key2]) && ($order ==  1)) $match = TRUE;
 504                                 }
 505
 506                                 if ($match) {
 507                                         // We have found two different values, so let's sort whole array
 508                                         foreach ($temporaryArray as $sort_key => $sort_val) {
 509                                                 $t                       = $temporaryArray[$sort_key][$key];
 510                                                 $temporaryArray[$sort_key][$key]  = $temporaryArray[$sort_key][$key2];
 511                                                 $temporaryArray[$sort_key][$key2] = $t;
 512                                                 unset($t);
 513                                         } // END - foreach
 514                                 } // END - if
 515                         } // END - foreach
 516                 } // END - foreach
 517
 518                 // Count one up
 519                 $primary_key++;
 520         } // END - while
 521
 522         // Write back sorted array
 523         $array = $temporaryArray;
 524 }
 525
 526
 527 //
 528 // Deprecated : $length (still has one reference in this function)
 529 // Optional   : $extraData
 530 //
 531 function generateRandomCode ($length, $code, $userid, $extraData = '') {
 532         // Build server string
 533         $server = $_SERVER['PHP_SELF'] . getEncryptSeparator() . detectUserAgent() . getEncryptSeparator() . getenv('SERVER_SOFTWARE') . getEncryptSeparator() . detectRealIpAddress() . getEncryptSeparator() . detectRemoteAddr();
 534
 535         // Build key string
 536         $keys = getSiteKey() . getEncryptSeparator() . getDateKey();
 537         if (isConfigEntrySet('secret_key')) {
 538                 $keys .= getEncryptSeparator() . getSecretKey();
 539         } // END - if
 540         if (isConfigEntrySet('file_hash')) {
 541                 $keys .= getEncryptSeparator() . getFileHash();
 542         } // END - if
 543         $keys .= getEncryptSeparator() . getDateFromRepository();
 544         if (isConfigEntrySet('master_salt')) {
 545                 $keys .= getEncryptSeparator() . getMasterSalt();
 546         } // END - if
 547
 548         // Build string from misc data
 549         $data  = $code . getEncryptSeparator() . $userid . getEncryptSeparator() . $extraData;
 550
 551         // Add more additional data
 552         if (isSessionVariableSet('u_hash')) {
 553                 $data .= getEncryptSeparator() . getSession('u_hash');
 554         } // END - if
 555
 556         // Add referral id, language, theme and userid
 557         $data .= getEncryptSeparator() . determineReferralId();
 558         $data .= getEncryptSeparator() . getLanguage();
 559         $data .= getEncryptSeparator() . getCurrentTheme();
 560         $data .= getEncryptSeparator() . getMemberId();
 561
 562         // Calculate number for generating the code
 563         $a = $code + getConfig('_ADD') - 1;
 564
 565         if (isConfigEntrySet('master_salt')) {
 566                 // Generate hash with master salt from modula of number with the prime number and other data
 567                 $saltedHash = generateHash(($a % getPrime()) . getEncryptSeparator() . $server . getEncryptSeparator() . $keys . getEncryptSeparator() . $data . getEncryptSeparator() . getDateKey() . getEncryptSeparator() . $a, getMasterSalt());
 568         } else {
 569                 // Generate hash with "hash of site key" from modula of number with the prime number and other data
 570                 $saltedHash = generateHash(($a % getPrime()) . getEncryptSeparator() . $server . getEncryptSeparator() . $keys . getEncryptSeparator() . $data . getEncryptSeparator() . getDateKey() . getEncryptSeparator() . $a, substr(sha1(getSiteKey()), 0, getSaltLength()));
 571         }
 572
 573         // Create number from hash
 574         $rcode = hexdec(substr($saltedHash, getSaltLength(), 9)) / abs(getRandNo() - $a + sqrt(getConfig('_ADD'))) / pi();
 575
 576         // At least 10 numbers shall be secure enought!
 577         if (isExtensionActive('other')) {
 578                 $len = getCodeLength();
 579         } else {
 580                 $len = $length;
 581         } // END - if
 582
 583         // Smaller 1 is not okay
 584         if ($len < 1) {
 585                 // Fix it to 10
 586                 $len = 10;
 587         } // END - if
 588
 589         // Cut off requested counts of number, but skip first digit (which is mostly a zero)
 590         $return = substr($rcode, (strpos($rcode, '.') + 1), $len);
 591
 592         // Done building code
 593         return $return;
 594 }
 595
 596 // Does only allow numbers
 597 function bigintval ($num, $castValue = TRUE, $abortOnMismatch = TRUE) {
 598         //* DEBUG: */ debugOutput('[' . __FUNCTION__ . ':' . __LINE__ . '] ' . 'num=' . $num . ',castValue=' . intval($castValue) . ',abortOnMismatch=' . intval($abortOnMismatch) . ' - ENTERED!');
 599         // Filter all non-number chars out, so only number chars will remain
 600         $ret = preg_replace('/[^0123456789]/', '', $num);
 601
 602         // Shall we cast?
 603         if ($castValue === TRUE) {
 604                 // Cast to biggest numeric type
 605                 $ret = (double) $ret;
 606         } // END - if
 607
 608         // Has the whole value changed?
 609         if (('' . $ret . '' != '' . $num . '') && ($abortOnMismatch === TRUE) && (!is_null($num))) {
 610                 // Log the values
 611                 reportBug(__FUNCTION__, __LINE__, 'Problem with number found. ret[' . gettype($ret) . ']=' . $ret . ', num[' . gettype($num) . ']='. $num);
 612         } // END - if
 613
 614         // Return result
 615         //* DEBUG: */ debugOutput('[' . __FUNCTION__ . ':' . __LINE__ . '] ' . 'num=' . $num . ',castValue=' . intval($castValue) . ',abortOnMismatch=' . intval($abortOnMismatch) . ',ret=' . $ret . ' - EXIT!');
 616         return $ret;
 617 }
 618
 619 // Creates a Uni* timestamp from given selection data and prefix
 620 function createEpocheTimeFromSelections ($prefix, $postData) {
 621         // Initial return value
 622         $ret = '0';
 623
 624         // Is there a leap year?
 625         $SWITCH = '0';
 626         $TEST = getYear() / 4;
 627         $M1   = getMonth();
 628
 629         // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
 630         // 01     2     2         1    1           1    123     4                          43    3                                 32    233    4                          43    3                                 3210
 631         if ((floor($TEST) == $TEST) && ($M1 == '02') && (((isset($postData[$prefix . '_mo'])) && ($postData[$prefix . '_mo'] > '02')) || ((isset($postData[$prefix . '_mn'])) && ($postData[$prefix . '_mn'] > '02')))) {
 632                 $SWITCH = getOneDay();
 633         } // END - if
 634
 635         // First add years...
 636         $ret += $postData[$prefix . '_ye'] * (31536000 + $SWITCH);
 637
 638         // Next months...
 639         if (isset($postData[$prefix . '_mo'])) {
 640                 $ret += $postData[$prefix . '_mo'] * 2628000;
 641         } elseif (isset($postData[$prefix . '_mn'])) {
 642                 $ret += $postData[$prefix . '_mn'] * 2628000;
 643         }
 644
 645         // Next weeks
 646         $ret += $postData[$prefix . '_we'] * 604800;
 647
 648         // Next days...
 649         $ret += $postData[$prefix . '_da'] * 86400;
 650
 651         // Next hours...
 652         $ret += $postData[$prefix . '_ho'] * 3600;
 653
 654         // Next minutes..
 655         $ret += $postData[$prefix . '_mi'] * 60;
 656
 657         // And at last seconds...
 658         $ret += $postData[$prefix . '_se'];
 659
 660         // Return calculated value
 661         return $ret;
 662 }
 663
 664 // Creates a 'fancy' human-readable timestamp from a Uni* stamp
 665 function createFancyTime ($stamp) {
 666         // Get data array with years/months/weeks/days/...
 667         $data = createTimeSelections($stamp, '', '', '', TRUE);
 668         $ret = '';
 669         foreach ($data as $k => $v) {
 670                 if ($v > 0) {
 671                         // Value is greater than 0 "eval" data to return string
 672                         $ret .= ', ' . $v . ' {%pipe,translateTimeUnit=' . $k . '%}';
 673                         break;
 674                 } // END - if
 675         } // END - foreach
 676
 677         // Is something there?
 678         if (!empty($ret)) {
 679                 // Remove leading commata and space
 680                 $ret = substr($ret, 2);
 681         } else {
 682                 // Zero seconds
 683                 $ret = '0 {--TIME_UNIT_SECOND--}';
 684         }
 685
 686         // Return fancy time string
 687         return $ret;
 688 }
 689
 690 // Taken from www.php.net isInStringIgnoreCase() user comments
 691 function isEmailValid ($email) {
 692         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'email=' . $email . ' - ENTERED!');
 693
 694         // Is there cache?
 695         if (!isset($GLOBALS[__FUNCTION__][$email])) {
 696                 // Check first part of email address
 697                 $first = '[-a-z0-9!#$%&\'*+/=?^_<{|}~]+(\.[-a-zA-Z0-9!#$%&\'*+/=?^_<{|}~]+)*';
 698
 699                 //  Check domain
 700                 $domain = '[a-z0-9-]+(\.[a-z0-9-]{2,5})+';
 701
 702                 // Generate pattern
 703                 $regex = '@^' . $first . '\@' . $domain . '$@iU';
 704
 705                 // Determine it
 706                 $GLOBALS[__FUNCTION__][$email] = (($email != getMessage('DEFAULT_WEBMASTER')) && (preg_match($regex, $email)));
 707         } // END - if
 708
 709         // Return check result
 710         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'email=' . $email . ',isValid=' . intval($GLOBALS[__FUNCTION__][$email]) . ' - EXIT!');
 711         return $GLOBALS[__FUNCTION__][$email];;
 712 }
 713
 714 // Function taken from user comments on www.php.net / function isInStringIgnoreCase()
 715 function isUrlValid ($url, $compile = TRUE) {
 716         // Trim URL a little
 717         $url = trim(urldecode($url));
 718         //* DEBUG: */ debugOutput($url);
 719
 720         // Compile some chars out...
 721         if ($compile === TRUE) {
 722                 $url = compileUriCode($url, FALSE, FALSE, FALSE);
 723         } // END - if
 724         //* DEBUG: */ debugOutput($url);
 725
 726         // Check for the extension filter
 727         if (isExtensionActive('filter')) {
 728                 // Use the extension's filter set
 729                 return FILTER_VALIDATE_URL($url, FALSE);
 730         } // END - if
 731
 732         /*
 733          * If not installed, perform a simple test. Just make it sure there is always a
 734          * http:// or https:// in front of the URLs.
 735          */
 736         return isUrlValidSimple($url);
 737 }
 738
 739 // Generate a hash for extra-security for all passwords
 740 function generateHash ($plainText, $salt = '', $hash = TRUE) {
 741         // Debug output
 742         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'plainText('.strlen($plainText).')=' . $plainText . ',salt('.strlen($salt).')=' . $salt . ',hash=' . intval($hash));
 743
 744         // Is the required extension 'sql_patches' there and a salt is not given?
 745         // 123                            4                      43    3     4     432    2                  3             32    2                             3                32    2      3     3      21
 746         if (((isExtensionInstalledAndOlder('sql_patches', '0.3.6')) && (empty($salt))) || (!isExtensionActive('sql_patches')) || (!isExtensionInstalledAndNewer('other', '0.2.5')) || (strlen($salt) == 32)) {
 747                 // Extension ext-sql_patches is missing/outdated so we hash the plain text with MD5
 748                 if ($hash === TRUE) {
 749                         // Is plain password
 750                         return md5($plainText);
 751                 } else {
 752                         // Is already a hash
 753                         return $plainText;
 754                 }
 755         } // END - if
 756
 757         // Is an arry element missing here?
 758         if (!isConfigEntrySet('file_hash')) {
 759                 // Stop here
 760                 reportBug(__FUNCTION__, __LINE__, 'Missing file_hash in ' . __FUNCTION__ . '.');
 761         } // END - if
 762
 763         // When the salt is empty build a new one, else use the first x configured characters as the salt
 764         if (empty($salt)) {
 765                 // Build server string for more entropy
 766                 $server = $_SERVER['PHP_SELF'] . getEncryptSeparator() . detectUserAgent() . getEncryptSeparator() . getenv('SERVER_SOFTWARE') . getEncryptSeparator() . detectRealIpAddress() . getEncryptSeparator() . detectRemoteAddr();
 767
 768                 // Build key string
 769                 $keys   = getSiteKey() . getEncryptSeparator() . getDateKey() . getEncryptSeparator() . getSecretKey() . getEncryptSeparator() . getFileHash() . getEncryptSeparator() . getDateFromRepository() . getEncryptSeparator() . getMasterSalt();
 770
 771                 // Additional data
 772                 $data = $plainText . getEncryptSeparator() . uniqid(mt_rand(), TRUE) . getEncryptSeparator() . time();
 773
 774                 // Calculate number for generating the code
 775                 $a = time() + getConfig('_ADD') - 1;
 776
 777                 // Generate SHA1 sum from modula of number and the prime number
 778                 $sha1 = sha1(($a % getPrime()) . $server . getEncryptSeparator() . $keys . getEncryptSeparator() . $data . getEncryptSeparator() . getDateKey() . getEncryptSeparator() . $a);
 779                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SHA1=' . $sha1.' ('.strlen($sha1).')');
 780                 $sha1 = scrambleString($sha1);
 781                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Scrambled=' . $sha1.' ('.strlen($sha1).')');
 782                 //* DEBUG: */ $sha1b = descrambleString($sha1);
 783                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Descrambled=' . $sha1b.' ('.strlen($sha1b).')');
 784
 785                 // Generate the password salt string
 786                 $salt = substr($sha1, 0, getSaltLength());
 787                 //* DEBUG: */ debugOutput($salt.' ('.strlen($salt).')');
 788         } else {
 789                 // Use given salt
 790                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt=' . $salt);
 791                 $salt = substr($salt, 0, getSaltLength());
 792                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'salt=' . $salt . '(' . strlen($salt) . '/' . getSaltLength() . ')');
 793
 794                 // Sanity check on salt
 795                 if (strlen($salt) != getSaltLength()) {
 796                         // Not the same!
 797                         reportBug(__FUNCTION__, __LINE__, 'salt length mismatch! (' . strlen($salt) . '/' . getSaltLength() . ')');
 798                 } // END - if
 799         }
 800
 801         // Generate final hash (for debug output)
 802         $finalHash = $salt . sha1($salt . $plainText);
 803
 804         // Debug output
 805         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'finalHash('.strlen($finalHash).')=' . $finalHash);
 806
 807         // Return hash
 808         return $finalHash;
 809 }
 810
 811 // Scramble a string
 812 function scrambleString ($str) {
 813         // Init
 814         $scrambled = '';
 815
 816         // Final check, in case of failure it will return unscrambled string
 817         if (strlen($str) > 40) {
 818                 // The string is to long
 819                 return $str;
 820         } elseif (strlen($str) == 40) {
 821                 // From database
 822                 $scrambleNums = explode(':', getPassScramble());
 823         } else {
 824                 // Generate new numbers
 825                 $scrambleNums = explode(':', genScrambleString(strlen($str)));
 826         }
 827
 828         // Compare both lengths and abort if different
 829         if (strlen($str) != count($scrambleNums)) {
 830                 return $str;
 831         } // END - if
 832
 833         // Scramble string here
 834         //* DEBUG: */ debugOutput('***Original=' . $str.'***<br />');
 835         for ($idx = 0; $idx < strlen($str); $idx++) {
 836                 // Get char on scrambled position
 837                 $char = substr($str, $scrambleNums[$idx], 1);
 838
 839                 // Add it to final output string
 840                 $scrambled .= $char;
 841         } // END - for
 842
 843         // Return scrambled string
 844         //* DEBUG: */ debugOutput('***Scrambled=' . $scrambled.'***<br />');
 845         return $scrambled;
 846 }
 847
 848 // De-scramble a string scrambled by scrambleString()
 849 function descrambleString ($str) {
 850         // Scramble only 40 chars long strings
 851         if (strlen($str) != 40) {
 852                 return $str;
 853         } // END - if
 854
 855         // Load numbers from config
 856         $scrambleNums = explode(':', getPassScramble());
 857
 858         // Validate numbers
 859         if (count($scrambleNums) != 40) {
 860                 return $str;
 861         } // END - if
 862
 863         // Begin descrambling
 864         $orig = str_repeat(' ', 40);
 865         //* DEBUG: */ debugOutput('+++Scrambled=' . $str.'+++<br />');
 866         for ($idx = 0; $idx < 40; $idx++) {
 867                 $char = substr($str, $idx, 1);
 868                 $orig = substr_replace($orig, $char, $scrambleNums[$idx], 1);
 869         } // END - for
 870
 871         // Return scrambled string
 872         //* DEBUG: */ debugOutput('+++Original=' . $orig.'+++<br />');
 873         return $orig;
 874 }
 875
 876 // Generated a "string" for scrambling
 877 function genScrambleString ($len) {
 878         // Prepare array for the numbers
 879         $scrambleNumbers = array();
 880
 881         // First we need to setup randomized numbers from 0 to 31
 882         for ($idx = 0; $idx < $len; $idx++) {
 883                 // Generate number
 884                 $rand = mt_rand(0, ($len - 1));
 885
 886                 // Check for it by creating more numbers
 887                 while (array_key_exists($rand, $scrambleNumbers)) {
 888                         $rand = mt_rand(0, ($len - 1));
 889                 } // END - while
 890
 891                 // Add number
 892                 $scrambleNumbers[$rand] = $rand;
 893         } // END - for
 894
 895         // So let's create the string for storing it in database
 896         $scrambleString = implode(':', $scrambleNumbers);
 897         return $scrambleString;
 898 }
 899
 900 // Generate an PGP-like encrypted hash of given hash for e.g. cookies
 901 function encodeHashForCookie ($passHash) {
 902         // Return vanilla password hash
 903         $ret = $passHash;
 904
 905         // Is a secret key and master salt already initialized?
 906         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, intval(isExtensionInstalled('sql_patches')) . '/' . intval(isConfigEntrySet('_PRIME')) . '/' . intval(isConfigEntrySet('secret_key')) . '/' . intval(isConfigEntrySet('master_salt')));
 907         if ((isExtensionInstalled('sql_patches')) && (isConfigEntrySet('_PRIME')) && (isConfigEntrySet('secret_key')) && (isConfigEntrySet('master_salt'))) {
 908                 // Only calculate when the secret key is generated
 909                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, strlen($passHash) . '/' . strlen(getSecretKey()));
 910                 if ((strlen($passHash) != 49) || (strlen(getSecretKey()) != 40)) {
 911                         // Both keys must have same length so return unencrypted
 912                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, strlen($passHash) . '!=49/' . strlen(getSecretKey()) . '!=40 -  EXIT!');
 913                         return $ret;
 914                 } // END - if
 915
 916                 $newHash = ''; $start = 9;
 917                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'passHash=' . $passHash . '(' . strlen($passHash) . ')');
 918                 for ($idx = 0; $idx < 20; $idx++) {
 919                         // Get hash parts and convert them (00-FF) to matching ASCII value (0-255)
 920                         $part1 = hexdec(substr($passHash     , $start, 2));
 921                         $part2 = hexdec(substr(getSecretKey(), $start, 2));
 922
 923                         // Default is hexadecimal of index if both are same
 924                         $mod = dechex($idx);
 925                         // Is part1 larger or part2 than its counter part?
 926                         if ($part1 > $part2) {
 927                                 // part1 is larger
 928                                 $mod = dechex(sqrt(($part1 - $part2) * getPrime() / pi()));
 929                         } elseif ($part2 > $part1) {
 930                                 // part2 is larger
 931                                 $mod = dechex(sqrt(($part2 - $part1) * getPrime() / pi()));
 932                         }
 933
 934                         $mod = substr($mod, 0, 2);
 935                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'idx=' . $idx . ',part1=' . $part1 . '/part2=' . $part2 . '/mod=' . $mod . '(' . strlen($mod) . ')');
 936                         $mod = padLeftZero($mod);
 937                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'mod(' . ($idx * 2) . ')=' . $mod . '*');
 938                         $start += 2;
 939                         $newHash .= $mod;
 940                 } // END - for
 941
 942                 // Just copy it over, as the master salt is not really helpful here
 943                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $passHash . '(' . strlen($passHash) . '),' . $newHash . ' (' . strlen($newHash) . ')');
 944                 $ret = $newHash;
 945         } // END - if
 946
 947         // Return result
 948         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ret=' . $ret . '');
 949         return $ret;
 950 }
 951
 952 // Fix "deleted" cookies
 953 function fixDeletedCookies ($cookies) {
 954         // Is this an array with entries?
 955         if ((is_array($cookies)) && (count($cookies) > 0)) {
 956                 // Then check all cookies if they are marked as deleted!
 957                 foreach ($cookies as $cookieName) {
 958                         // Is the cookie set to "deleted"?
 959                         if (getSession($cookieName) == 'deleted') {
 960                                 setSession($cookieName, '');
 961                         } // END - if
 962                 } // END - foreach
 963         } // END - if
 964 }
 965
 966 // Checks if a given apache module is loaded
 967 function isApacheModuleLoaded ($apacheModule) {
 968         // Check it and return result
 969         return (((function_exists('apache_get_modules')) && (in_array($apacheModule, apache_get_modules()))) || (!function_exists('apache_get_modules')));
 970 }
 971
 972 // Get current theme name
 973 function getCurrentTheme () {
 974         // The default theme is 'default'... ;-)
 975         $ret = 'default';
 976
 977         // Is there ext-theme installed and active or is 'theme' in URL or POST data?
 978         if (isExtensionActive('theme')) {
 979                 // Call inner method
 980                 $ret = getActualTheme();
 981         } elseif ((isPostRequestElementSet('theme')) && (isIncludeReadable(sprintf("theme/%s/theme.php", postRequestElement('theme'))))) {
 982                 // Use value from POST data
 983                 $ret = postRequestElement('theme');
 984         } elseif ((isGetRequestElementSet('theme')) && (isIncludeReadable(sprintf("theme/%s/theme.php", getRequestElement('theme'))))) {
 985                 // Use value from GET data
 986                 $ret = getRequestElement('theme');
 987         } elseif ((isMailerThemeSet()) && (isIncludeReadable(sprintf("theme/%s/theme.php", getMailerTheme())))) {
 988                 // Use value from GET data
 989                 $ret = getMailerTheme();
 990         }
 991
 992         // Return theme value
 993         return $ret;
 994 }
 995
 996 // Generates an error code from given account status
 997 function generateErrorCodeFromUserStatus ($status = '') {
 998         // If no status is provided, use the default, cached
 999         if ((empty($status)) && (isMember())) {
1000                 // Get user status
1001                 $status = getUserData('status');
1002         } // END - if
1003
1004         // Default error code if unknown account status
1005         $errorCode = getCode('ACCOUNT_UNKNOWN');
1006
1007         // Generate constant name
1008         $codeName = sprintf("ACCOUNT_%s", strtoupper($status));
1009
1010         // Is the constant there?
1011         if (isCodeSet($codeName)) {
1012                 // Then get it!
1013                 $errorCode = getCode($codeName);
1014         } else {
1015                 // Unknown status
1016                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown error status %s detected.", $status));
1017         }
1018
1019         // Return error code
1020         return $errorCode;
1021 }
1022
1023 // Back-ported from the new ship-simu engine. :-)
1024 function debug_get_printable_backtrace () {
1025         // Init variable
1026         $backtrace = '<ol>';
1027
1028         // Get and prepare backtrace for output
1029         $backtraceArray = debug_backtrace();
1030         foreach ($backtraceArray as $key => $trace) {
1031                 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
1032                 if (!isset($trace['line'])) $trace['line'] = __LINE__;
1033                 if (!isset($trace['args'])) $trace['args'] = array();
1034                 $backtrace .= '<li class="debug_list"><span class="backtrace_file">' . basename($trace['file']) . '</span>:' . $trace['line'] . ', <span class="backtrace_function">' . $trace['function'] . '(' . count($trace['args']) . ')</span></li>';
1035         } // END - foreach
1036
1037         // Close it
1038         $backtrace .= '</ol>';
1039
1040         // Return the backtrace
1041         return $backtrace;
1042 }
1043
1044 // A mail-able backtrace
1045 function debug_get_mailable_backtrace () {
1046         // Init variable
1047         $backtrace = '';
1048
1049         // Get and prepare backtrace for output
1050         $backtraceArray = debug_backtrace();
1051         foreach ($backtraceArray as $key => $trace) {
1052                 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
1053                 if (!isset($trace['line'])) $trace['line'] = __LINE__;
1054                 if (!isset($trace['args'])) $trace['args'] = array();
1055                 $backtrace .= ($key+1) . '.:' . basename($trace['file']) . ':' . $trace['line'] . ', ' . $trace['function'] . '(' . count($trace['args']) . ")\n";
1056         } // END - foreach
1057
1058         // Return the backtrace
1059         return $backtrace;
1060 }
1061
1062 // Generates a ***weak*** seed
1063 function generateSeed () {
1064         return microtime(TRUE) * 100000;
1065 }
1066
1067 // Converts a message code to a human-readable message
1068 function getMessageFromErrorCode ($code) {
1069         // Default is an unknown error code
1070         $message = '{%message,UNKNOWN_ERROR_CODE=' . $code . '%}';
1071
1072         // Which code is provided?
1073         switch ($code) {
1074                 case '':
1075                         // No error code is bad coding practice
1076                         reportBug(__FUNCTION__, __LINE__, 'Empty error code supplied. Please fix your code.');
1077                         break;
1078
1079                 // All error messages
1080                 case getCode('LOGOUT_DONE')         : $message = '{--LOGOUT_DONE--}'; break;
1081                 case getCode('LOGOUT_FAILED')       : $message = '<span class="bad">{--LOGOUT_FAILED--}</span>'; break;
1082                 case getCode('DATA_INVALID')        : $message = '{--MAIL_DATA_INVALID--}'; break;
1083                 case getCode('POSSIBLE_INVALID')    : $message = '{--MAIL_POSSIBLE_INVALID--}'; break;
1084                 case getCode('USER_404')            : $message = '{--USER_404--}'; break;
1085                 case getCode('STATS_404')           : $message = '{--MAIL_STATS_404--}'; break;
1086                 case getCode('ALREADY_CONFIRMED')   : $message = '{--MAIL_ALREADY_CONFIRMED--}'; break;
1087                 case getCode('BEG_SAME_AS_OWN')     : $message = '{--BEG_SAME_USERID_AS_OWN--}'; break;
1088                 case getCode('LOGIN_FAILED')        : $message = '{--GUEST_LOGIN_FAILED_GENERAL--}'; break;
1089                 case getCode('MODULE_MEMBER_ONLY')  : $message = '{%message,MODULE_MEMBER_ONLY=' . getRequestElement('mod') . '%}'; break;
1090                 case getCode('OVERLENGTH')          : $message = '{--MEMBER_TEXT_OVERLENGTH--}'; break;
1091                 case getCode('URL_FOUND')           : $message = '{--MEMBER_TEXT_CONTAINS_URL--}'; break;
1092                 case getCode('SUBJECT_URL')         : $message = '{--MEMBER_SUBJECT_CONTAINS_URL--}'; break;
1093                 case getCode('BLIST_URL')           : $message = '{--MEMBER_URL_BLACK_LISTED--}<br />{--MEMBER_BLIST_TIME--}: ' . generateDateTime(getRequestElement('blist'), 0); break;
1094                 case getCode('NO_RECS_LEFT')        : $message = '{--MEMBER_SELECTED_MORE_RECS--}'; break;
1095                 case getCode('INVALID_TAGS')        : $message = '{--MEMBER_HTML_INVALID_TAGS--}'; break;
1096                 case getCode('MORE_POINTS')         : $message = '{--MEMBER_MORE_POINTS_NEEDED--}'; break;
1097                 case getCode('MORE_RECEIVERS1')     : $message = '{--MEMBER_ENTER_MORE_RECEIVERS--}'; break;
1098                 case getCode('MORE_RECEIVERS2')     : $message = '{--MEMBER_NO_MORE_RECEIVERS_FOUND--}'; break;
1099                 case getCode('MORE_RECEIVERS3')     : $message = '{--MEMBER_ENTER_MORE_MIN_RECEIVERS--}'; break;
1100                 case getCode('INVALID_URL')         : $message = '{--MEMBER_ENTER_INVALID_URL--}'; break;
1101                 case getCode('NO_MAIL_TYPE')        : $message = '{--MEMBER_NO_MAIL_TYPE_SELECTED--}'; break;
1102                 case getCode('PROFILE_UPDATED')     : $message = '{--MEMBER_PROFILE_UPDATED--}'; break;
1103                 case getCode('UNKNOWN_REDIRECT')    : $message = '{--UNKNOWN_REDIRECT_VALUE--}'; break;
1104                 case getCode('WRONG_PASS')          : $message = '{--LOGIN_WRONG_PASS--}'; break;
1105                 case getCode('WRONG_ID')            : $message = '{--LOGIN_WRONG_ID--}'; break;
1106                 case getCode('ACCOUNT_LOCKED')      : $message = '{--LOGIN_STATUS_LOCKED--}'; break;
1107                 case getCode('ACCOUNT_UNCONFIRMED') : $message = '{--LOGIN_STATUS_UNCONFIRMED--}'; break;
1108                 case getCode('COOKIES_DISABLED')    : $message = '{--LOGIN_COOKIES_DISABLED--}'; break;
1109                 case getCode('UNKNOWN_ERROR')       : $message = '{--LOGIN_UNKNOWN_ERROR--}'; break;
1110                 case getCode('UNKNOWN_STATUS')      : $message = '{--LOGIN_UNKNOWN_STATUS--}'; break;
1111                 case getCode('LOGIN_EMPTY_ID')      : $message = '{--LOGIN_ID_IS_EMPTY--}'; break;
1112                 case getCode('LOGIN_EMPTY_PASSWORD'): $message = '{--LOGIN_PASSWORD_IS_EMPTY--}'; break;
1113
1114                 case getCode('ERROR_MAILID'):
1115                         if (isExtensionActive('mailid', TRUE)) {
1116                                 $message = '{--ERROR_CONFIRMING_MAIL--}';
1117                         } else {
1118                                 $message = '{%pipe,generateExtensionInactiveNotInstalledMessage=mailid%}';
1119                         }
1120                         break;
1121
1122                 case getCode('EXTENSION_PROBLEM'):
1123                         if (isGetRequestElementSet('ext')) {
1124                                 $message = '{%pipe,generateExtensionInactiveNotInstalledMessage=' . getRequestElement('ext') . '%}';
1125                         } else {
1126                                 $message = '{--EXTENSION_PROBLEM_UNSET_EXT--}';
1127                         }
1128                         break;
1129
1130                 case getCode('URL_TIME_LOCK'):
1131                         // @TODO Move this SQL code into a function, let's say 'getTimestampFromPoolId($id) ?
1132                         $result = SQL_QUERY_ESC("SELECT `timestamp` FROM `{?_MYSQL_PREFIX?}_pool` WHERE `id`=%s LIMIT 1",
1133                                 array(bigintval(getRequestElement('id'))), __FUNCTION__, __LINE__);
1134
1135                         // Load timestamp from last order
1136                         $content = SQL_FETCHARRAY($result);
1137
1138                         // Free memory
1139                         SQL_FREERESULT($result);
1140
1141                         // Translate it for templates
1142                         $content['timestamp'] = generateDateTime($content['timestamp'], 1);
1143
1144                         // Calculate hours...
1145                         $content['hours'] = round(getUrlTlock() / 60 / 60);
1146
1147                         // Minutes...
1148                         $content['minutes'] = round((getUrlTlock() - $content['hours'] * 60 * 60) / 60);
1149
1150                         // And seconds
1151                         $content['seconds'] = round(getUrlTlock() - $content['hours'] * 60 * 60 - $content['minutes'] * 60);
1152
1153                         // Finally contruct the message
1154                         $message = loadTemplate('tlock_message', TRUE, $content);
1155                         break;
1156
1157                 default:
1158                         // Log missing/invalid error codes
1159                         logDebugMessage(__FUNCTION__, __LINE__, getMessage('UNKNOWN_MAILID_CODE', $code));
1160                         break;
1161         } // END - switch
1162
1163         // Return the message
1164         return $message;
1165 }
1166
1167 // Function taken from user comments on www.php.net / function isInStringIgnoreCase()
1168 function isUrlValidSimple ($url) {
1169         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ' - ENTERED!');
1170         // Prepare URL
1171         $url = secureString(str_replace(chr(92), '', compileRawCode(urldecode($url))));
1172
1173         // Allows http and https
1174         $http      = "(http|https)+(:\/\/)";
1175         // Test domain
1176         $domain1   = "([[:alnum:]]([-[:alnum:]])*\.)?([[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})?";
1177         // Test double-domains (e.g. .de.vu)
1178         $domain2   = "([-[:alnum:]])?(\.[[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})(\.[[:alpha:]]{2,5})?";
1179         // Test IP number
1180         $ip        = "([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})";
1181         // ... directory
1182         $dir       = "((/)+([-_\.[:alnum:]])+)*";
1183         // ... page
1184         $page      = "/([-_[:alnum:]][-\._[:alnum:]]*\.[[:alnum:]]{2,5})?";
1185         // ... and the string after and including question character
1186         $getstring1 = "([\?/]([[:alnum:]][-\._%[:alnum:]]*(=)?([-\@\._:%[:alnum:]])+)(&([[:alnum:]]([-_%[:alnum:]])*(=)?([-\@\[\._:%[:alnum:]])+(\])*))*)?";
1187         // Pattern for URLs like http://url/dir/doc.html?var=value
1188         $pattern['d1dpg1']  = $http . $domain1 . $dir . $page . $getstring1;
1189         $pattern['d2dpg1']  = $http . $domain2 . $dir . $page . $getstring1;
1190         $pattern['ipdpg1']  = $http . $ip . $dir . $page . $getstring1;
1191         // Pattern for URLs like http://url/dir/?var=value
1192         $pattern['d1dg1']  = $http . $domain1 . $dir.'/' . $getstring1;
1193         $pattern['d2dg1']  = $http . $domain2 . $dir.'/' . $getstring1;
1194         $pattern['ipdg1']  = $http . $ip . $dir.'/' . $getstring1;
1195         // Pattern for URLs like http://url/dir/page.ext
1196         $pattern['d1dp']  = $http . $domain1 . $dir . $page;
1197         $pattern['d1dp']  = $http . $domain2 . $dir . $page;
1198         $pattern['ipdp']  = $http . $ip . $dir . $page;
1199         // Pattern for URLs like http://url/dir
1200         $pattern['d1d']  = $http . $domain1 . $dir;
1201         $pattern['d2d']  = $http . $domain2 . $dir;
1202         $pattern['ipd']  = $http . $ip . $dir;
1203         // Pattern for URLs like http://url/?var=value
1204         $pattern['d1g1']  = $http . $domain1 . '/' . $getstring1;
1205         $pattern['d2g1']  = $http . $domain2 . '/' . $getstring1;
1206         $pattern['ipg1']  = $http . $ip . '/' . $getstring1;
1207         // Pattern for URLs like http://url?var=value
1208         $pattern['d1g12']  = $http . $domain1 . $getstring1;
1209         $pattern['d2g12']  = $http . $domain2 . $getstring1;
1210         $pattern['ipg12']  = $http . $ip . $getstring1;
1211
1212         // Test all patterns
1213         $reg = FALSE;
1214         foreach ($pattern as $key => $pat) {
1215                 // Debug regex?
1216                 if (isDebugRegularExpressionEnabled()) {
1217                         // @TODO Are these convertions still required?
1218                         $pat = str_replace('.', '&#92;&#46;', $pat);
1219                         $pat = str_replace('@', '&#92;&#64;', $pat);
1220                         //* DEBUG: */ debugOutput($key . '=&nbsp;' . $pat);
1221                 } // END - if
1222
1223                 // Check if expression matches
1224                 $reg = ($reg || preg_match(('^' . $pat . '^'), $url));
1225
1226                 // Does it match?
1227                 if ($reg === TRUE) {
1228                         break;
1229                 } // END - if
1230         } // END - foreach
1231
1232         // Return true/false
1233         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ',reg=' . intval($reg) . ' - EXIT!');
1234         return $reg;
1235 }
1236
1237 // Wtites data to a config.php-style file
1238 // @TODO Rewrite this function to use readFromFile() and writeToFile()
1239 function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $inserted, $seek = 0) {
1240         // Initialize some variables
1241         $done = FALSE;
1242         $seek++;
1243         $next  = -1;
1244         $found = FALSE;
1245
1246         // Is the file there and read-/write-able?
1247         if ((isFileReadable($FQFN)) && (is_writeable($FQFN))) {
1248                 $search = 'CFG: ' . $comment;
1249                 $tmp = $FQFN . '.tmp';
1250
1251                 // Open the source file
1252                 $fp = fopen($FQFN, 'r') or reportBug(__FUNCTION__, __LINE__, 'Cannot read. file=' . basename($FQFN));
1253
1254                 // Is the resource valid?
1255                 if (is_resource($fp)) {
1256                         // Open temporary file
1257                         $fp_tmp = fopen($tmp, 'w') or reportBug(__FUNCTION__, __LINE__, 'Cannot write. tmp=' . basename($tmp) . ',file=' . $FQFN);
1258
1259                         // Is the resource again valid?
1260                         if (is_resource($fp_tmp)) {
1261                                 // Mark temporary file as readable
1262                                 $GLOBALS['file_readable'][$tmp] = TRUE;
1263
1264                                 // Start reading
1265                                 while (!feof($fp)) {
1266                                         // Read from source file
1267                                         $line = fgets($fp, 1024);
1268
1269                                         if (isInString($search, $line)) {
1270                                                 $next = '0';
1271                                                 $found = TRUE;
1272                                         } // END - if
1273
1274                                         if ($next > -1) {
1275                                                 if ($next === $seek) {
1276                                                         $next = -1;
1277                                                         $line = $prefix . $inserted . $suffix . PHP_EOL;
1278                                                 } else {
1279                                                         $next++;
1280                                                 }
1281                                         } // END - if
1282
1283                                         // Write to temp file
1284                                         fwrite($fp_tmp, $line);
1285                                 } // END - while
1286
1287                                 // Close temp file
1288                                 fclose($fp_tmp);
1289
1290                                 // Finished writing tmp file
1291                                 $done = TRUE;
1292                         } // END - if
1293
1294                         // Close source file
1295                         fclose($fp);
1296
1297                         if (($done === TRUE) && ($found === TRUE)) {
1298                                 // Copy back temporary->FQFN file and ...
1299                                 copyFileVerified($tmp, $FQFN, 0644);
1300
1301                                 // ... delete temporay file :-)
1302                                 return removeFile($tmp);
1303                         } elseif ($found === FALSE) {
1304                                 // Entry not found
1305                                 logDebugMessage(__FUNCTION__, __LINE__, 'File ' . basename($FQFN) . ' cannot be changed: comment=' . $comment . ',prefix=' . $prefix . ',inserted=' . $inserted . ',seek=' . $seek . ' - 404!');
1306                         } else {
1307                                 // Temporary file not fully written
1308                                 logDebugMessage(__FUNCTION__, __LINE__, 'File ' . basename($FQFN) . ' cannot be changed: comment=' . $comment . ',prefix=' . $prefix . ',inserted=' . $inserted . ',seek=' . $seek . ' - Temporary file unfinished!');
1309                         }
1310                 }
1311         } else {
1312                 // File not found, not readable or writeable
1313                 reportBug(__FUNCTION__, __LINE__, 'File not readable/writeable. file=' . basename($FQFN) . ',comment=' . $comment . ',prefix=' . $prefix . ',inserted=' . $inserted . ',seek=' . $seek);
1314         }
1315
1316         // An error was detected!
1317         return FALSE;
1318 }
1319
1320 // Debug message logger
1321 function logDebugMessage ($funcFile, $line, $message, $force=true) {
1322         // Is debug mode enabled?
1323         if ((isDebugModeEnabled()) || ($force === TRUE)) {
1324                 // Remove CRLF
1325                 $message = str_replace(array(chr(13), PHP_EOL), array('', ''), $message);
1326
1327                 // Log this message away
1328                 appendLineToFile(getPath() . getCachePath() . 'debug.log', generateDateTime(time(), '4') . '|' . getModule(FALSE) . ':' . getExtraModule() . '|' . basename($funcFile) . '|' . $line . '|' . $message);
1329         } // END - if
1330 }
1331
1332 // Handle extra values
1333 function handleExtraValues ($filterFunction, $value, $extraValue) {
1334         // Default is the value itself
1335         $ret = $value;
1336
1337         // Is there a special filter function?
1338         if ((empty($filterFunction)) || (!function_exists($filterFunction))) {
1339                 // Call-back function does not exist or is empty
1340                 reportBug(__FUNCTION__, __LINE__, 'Filter function ' . $filterFunction . ' does not exist or is empty: value[' . gettype($value) . ']=' . $value . ',extraValue[' . gettype($extraValue) . ']=' . $extraValue);
1341         } // END - if
1342
1343         // Is there extra parameters here?
1344         if ((!is_null($extraValue)) && (!empty($extraValue))) {
1345                 // Put both parameters in one new array by default
1346                 $args = array($value, $extraValue);
1347
1348                 // If we have an array simply use it and pre-extend it with our value
1349                 if (is_array($extraValue)) {
1350                         // Make the new args array
1351                         $args = merge_array(array($value), $extraValue);
1352                 } // END - if
1353
1354                 // Call the multi-parameter call-back
1355                 $ret = call_user_func_array($filterFunction, $args);
1356
1357                 // Is $ret 'true'?
1358                 if ($ret === TRUE) {
1359                         // Test passed, so write direct value
1360                         $ret = $args;
1361                 } // END - if
1362         } else {
1363                 // One parameter call
1364                 $ret = call_user_func($filterFunction, $value);
1365                 //* BUG */ die('ret['.gettype($ret).']=' . $ret . ',value=' . $value.',filterFunction=' . $filterFunction);
1366
1367                 // Is $ret 'true'?
1368                 if ($ret === TRUE) {
1369                         // Test passed, so write direct value
1370                         $ret = $value;
1371                 } // END - if
1372         }
1373
1374         // Return the value
1375         return $ret;
1376 }
1377
1378 // Tries to determine if call-back functions and/or extra values shall be parsed
1379 function doHandleExtraValues ($filterFunctions, $extraValues, $key, $entries, $userIdColumn, $search, $id = NULL) {
1380         // Debug mode enabled?
1381         if (isDebugModeEnabled()) {
1382                 // Debug message
1383                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key . ',entries=' . $entries . ',userIdColumn=' . $userIdColumn[0] . ',search=' . $search . ',filterFunctions=' . print_r($filterFunctions, TRUE) . ',extraValues=' . print_r($extraValues, TRUE));
1384         } // END - if
1385
1386         // Send data through the filter function if found
1387         if ($key === $userIdColumn[0]) {
1388                 // Is the userid, we have to process it with convertZeroToNull()
1389                 $entries = convertZeroToNull($entries);
1390         } elseif ((!empty($filterFunctions[$key])) && (isset($extraValues[$key]))) {
1391                 // Debug mode enabled?
1392                 if (isDebugModeEnabled()) {
1393                         // Then log it
1394                         /* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'search=' . $search . ',filterFunctions=' . $filterFunctions[$key] . ',extraValues=' . $extraValues[$key] . ',key=' . $key . ',id=' . $id . ',entries[' . gettype($entries) . ']=' . $entries . ' - BEFORE!');
1395                 } // END - if
1396
1397                 // Filter function + extra value set
1398                 $entries = handleExtraValues($filterFunctions[$key], $entries, $extraValues[$key]);
1399
1400                 // Debug mode enabled?
1401                 if (isDebugModeEnabled()) {
1402                         // Then log it
1403                         /* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'search=' . $search . ',filterFunctions=' . $filterFunctions[$key] . ',extraValues=' . $extraValues[$key] . ',key=' . $key . ',id=' . $id . ',entries[' . gettype($entries) . ']=' . $entries . ' - AFTER!');
1404                 } // END - if
1405         } elseif ((!empty($filterFunctions[$search])) && (!empty($extraValues[$search]))) {
1406                 // Debug mode enabled?
1407                 if (isDebugModeEnabled()) {
1408                         // Then log it
1409                         /* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'search=' . $search . ',filterFunctions=' . $filterFunctions[$search] . ',key=' . $key . ',search=' . $search . ',entries[' . gettype($entries) . ']=' . $entries . ' - BEFORE!');
1410                 } // END - if
1411
1412                 // Handle extra values
1413                 $entries = handleExtraValues($filterFunctions[$search], $entries, $extraValues[$search]);
1414
1415                 // Debug mode enabled?
1416                 if (isDebugModeEnabled()) {
1417                         // Then log it
1418                         /* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'search=' . $search . ',filterFunctions=' . $filterFunctions[$search] . ',key=' . $key . ',search=' . $search . ',entries[' . gettype($entries) . ']=' . $entries . ' - AFTER!');
1419                 } // END - if
1420
1421                 // Make sure entries is not bool, then something went wrong
1422                 assert(!is_bool($entries));
1423         } elseif (!empty($filterFunctions[$search])) {
1424                 // Debug mode enabled?
1425                 if (isDebugModeEnabled()) {
1426                         // Then log it
1427                         /* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'search=' . $search . ',filterFunctions=' . $filterFunctions[$search] . ',key=' . $key . ',search=' . $search . ',entries[' . gettype($entries) . ']=' . $entries . ' - BEFORE!');
1428                 } // END - if
1429
1430                 // Handle extra values
1431                 $entries = handleExtraValues($filterFunctions[$search], $entries, NULL);
1432
1433                 // Debug mode enabled?
1434                 if (isDebugModeEnabled()) {
1435                         // Then log it
1436                         /* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'search=' . $search . ',filterFunctions=' . $filterFunctions[$search] . ',key=' . $key . ',search=' . $search . ',entries[' . gettype($entries) . ']=' . $entries . ' - AFTER!');
1437                 } // END - if
1438
1439                 // Make sure entries is not bool, then something went wrong
1440                 assert(!is_bool($entries));
1441         }
1442
1443         // Return value
1444         return $entries;
1445 }
1446
1447 // Converts timestamp selections into a timestamp
1448 function convertSelectionsToEpocheTime (array &$postData, array &$content, &$id, &$skip) {
1449         // Init test variable
1450         $skip  = FALSE;
1451         $test2 = '';
1452
1453         // Get last three chars
1454         $test = substr($id, -3);
1455
1456         // Improved way of checking! :-)
1457         if (in_array($test, array('_ye', '_mo', '_mn', '_we', '_da', '_ho', '_mi', '_se'))) {
1458                 // Found a multi-selection for timings?
1459                 $test = substr($id, 0, -3);
1460                 if ((isset($postData[$test . '_ye'])) && ((isset($postData[$test . '_mo'])) || (isset($postData[$test . '_mn']))) && (isset($postData[$test . '_we'])) && (isset($postData[$test . '_da'])) && (isset($postData[$test . '_ho'])) && (isset($postData[$test . '_mi'])) && (isset($postData[$test . '_se'])) && ($test != $test2)) {
1461                         // Generate timestamp
1462                         $postData[$test] = createEpocheTimeFromSelections($test, $postData);
1463                         array_push($content, sprintf("`%s`='%s'", $test, $postData[$test]));
1464                         $GLOBALS['skip_config'][$test] = TRUE;
1465
1466                         // Remove data from array
1467                         foreach (array('ye', 'mo', 'mn', 'we', 'da', 'ho', 'mi', 'se') as $rem) {
1468                                 unset($postData[$test . '_' . $rem]);
1469                         } // END - foreach
1470
1471                         // Skip adding
1472                         unset($id);
1473                         $skip = TRUE;
1474                         $test2 = $test;
1475                 } // END - if
1476         } // END - if
1477 }
1478
1479 // Reverts the german decimal comma into Computer decimal dot
1480 // OPPOMENT: translateComma()
1481 function convertCommaToDot ($str) {
1482         // Default float is not a float... ;-)
1483         $float = FALSE;
1484
1485         // Which language is selected?
1486         switch (getLanguage()) {
1487                 case 'de': // German language
1488                         // Remove german thousand dots first
1489                         $str = str_replace('.', '', $str);
1490
1491                         // Replace german commata with decimal dot and cast it
1492                         $float = sprintf(getConfig('FLOAT_MASK'), str_replace(',', '.', $str));
1493                         break;
1494
1495                 default: // US and so on
1496                         // Remove thousand commatas first and cast
1497                         $float = sprintf(getConfig('FLOAT_MASK'), str_replace(',', '', $str));
1498                         break;
1499         } // END - switch
1500
1501         // Return float
1502         return $float;
1503 }
1504
1505 // Handle menu-depending failed logins and return the rendered content
1506 function handleLoginFailures ($accessLevel) {
1507         // Default output is empty ;-)
1508         $OUT = '';
1509
1510         // Is the session data set?
1511         if ((isSessionVariableSet('mailer_' . $accessLevel . '_failures')) && (isSessionVariableSet('mailer_' . $accessLevel . '_last_failure'))) {
1512                 // Ignore zero values
1513                 if (getSession('mailer_' . $accessLevel . '_failures') > 0) {
1514                         // Non-guest has login failures found, get both data and prepare it for template
1515                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'accessLevel=' . $accessLevel . '<br />');
1516                         $content = array(
1517                                 'login_failures' => 'mailer_' . $accessLevel . '_failures',
1518                                 'last_failure'   => generateDateTime(getSession('mailer_' . $accessLevel . '_last_failure'), 2)
1519                         );
1520
1521                         // Load template
1522                         $OUT = loadTemplate('login_failures', TRUE, $content);
1523                 } // END - if
1524
1525                 // Reset session data
1526                 setSession('mailer_' . $accessLevel . '_failures', '');
1527                 setSession('mailer_' . $accessLevel . '_last_failure', '');
1528         } // END - if
1529
1530         // Return rendered content
1531         return $OUT;
1532 }
1533
1534 // Rebuild cache
1535 function rebuildCache ($cache, $inc = '', $force = FALSE) {
1536         // Debug message
1537         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("cache=%s, inc=%s, force=%s", $cache, $inc, intval($force)));
1538
1539         // Shall I remove the cache file?
1540         if ((isExtensionInstalled('cache')) && (isCacheInstanceValid()) && (isHtmlOutputMode())) {
1541                 // Rebuild cache only in HTML output-mode
1542                 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) {
1543                         // Destroy it
1544                         $GLOBALS['cache_instance']->removeCacheFile($force);
1545                 } // END - if
1546
1547                 // Include file given?
1548                 if (!empty($inc)) {
1549                         // Construct FQFN
1550                         $inc = sprintf("inc/loader/load-%s.php", $inc);
1551
1552                         // Is the include there?
1553                         if (isIncludeReadable($inc)) {
1554                                 // And rebuild it from scratch
1555                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'inc=' . $inc . ' - LOADED!');
1556                                 loadInclude($inc);
1557                         } else {
1558                                 // Include not found
1559                                 logDebugMessage(__FUNCTION__, __LINE__, 'Include ' . $inc . ' not found. cache=' . $cache);
1560                         }
1561                 } // END - if
1562         } // END - if
1563 }
1564
1565 // Determines the real remote address
1566 function determineRealRemoteAddress ($remoteAddr = FALSE) {
1567         // Default is 127.0.0.1
1568         $address = '127.0.0.1';
1569
1570         // Is a proxy in use?
1571         if ((isset($_SERVER['HTTP_X_FORWARDED_FOR'])) && (!$remoteAddr)) {
1572                 // Proxy was used
1573                 $address = $_SERVER['HTTP_X_FORWARDED_FOR'];
1574         } elseif ((isset($_SERVER['HTTP_CLIENT_IP'])) && (!$remoteAddr)) {
1575                 // Yet, another proxy
1576                 $address = $_SERVER['HTTP_CLIENT_IP'];
1577         } elseif (isset($_SERVER['REMOTE_ADDR'])) {
1578                 // The regular address when no proxy was used
1579                 $address = $_SERVER['REMOTE_ADDR'];
1580         }
1581
1582         // This strips out the real address from proxy output
1583         if (strstr($address, ',')) {
1584                 $addressArray = explode(',', $address);
1585                 $address = $addressArray[0];
1586         } // END - if
1587
1588         // Return the result
1589         return $address;
1590 }
1591
1592 // Adds a bonus mail to the queue
1593 // This is a high-level function!
1594 function addNewBonusMail ($data, $mode = '', $output = TRUE) {
1595         // Use mode from data if not set and availble ;-)
1596         if ((empty($mode)) && (isset($data['mail_mode']))) {
1597                 $mode = $data['mail_mode'];
1598         } // END - if
1599
1600         // Generate receiver list
1601         $receiver = generateReceiverList($data['cat'], $data['receiver'], $mode);
1602
1603         // Receivers added?
1604         if (!empty($receiver)) {
1605                 // Add bonus mail to queue
1606                 addBonusMailToQueue(
1607                         $data['subject'],
1608                         $data['text'],
1609                         $receiver,
1610                         $data['points'],
1611                         $data['seconds'],
1612                         $data['url'],
1613                         $data['cat'],
1614                         $mode,
1615                         $data['receiver']
1616                 );
1617
1618                 // Mail inserted into bonus pool
1619                 if ($output === TRUE) {
1620                         displayMessage('{--ADMIN_BONUS_SEND--}');
1621                 } // END - if
1622         } elseif ($output === TRUE) {
1623                 // More entered than can be reached!
1624                 displayMessage('{--ADMIN_MORE_SELECTED--}');
1625         } else {
1626                 // Debug log
1627                 logDebugMessage(__FUNCTION__, __LINE__, 'cat=' . $data['cat'] . ',receiver=' . $data['receiver'] . ',data=' . base64_encode(serialize($data)) . ' More selected, than available!');
1628         }
1629 }
1630
1631 // Enables the reset mode and runs it
1632 function doReset () {
1633         // Enable the reset mode
1634         $GLOBALS['reset_enabled'] = TRUE;
1635
1636         // Run filters
1637         runFilterChain('reset');
1638 }
1639
1640 // Enables the reset mode (hourly, weekly and monthly) and runs it
1641 function doHourly () {
1642         // Enable the hourly reset mode
1643         $GLOBALS['hourly_enabled'] = TRUE;
1644
1645         // Run filters (one always!)
1646         runFilterChain('hourly');
1647 }
1648
1649 // Shuts down the mailer (e.g. closing database link, flushing output/filters, etc.)
1650 function doShutdown () {
1651         // Call the filter chain 'shutdown'
1652         runFilterChain('shutdown', NULL);
1653
1654         // Check if link is up
1655         if (SQL_IS_LINK_UP()) {
1656                 // Close link
1657                 SQL_CLOSE(__FUNCTION__, __LINE__);
1658         } elseif (!isInstallationPhase()) {
1659                 // No database link
1660                 reportBug(__FUNCTION__, __LINE__, 'Database link is already down, while shutdown is running.');
1661         }
1662
1663         // Stop executing here
1664         exit;
1665 }
1666
1667 // Init member id
1668 function initMemberId () {
1669         $GLOBALS['member_id'] = '0';
1670 }
1671
1672 // Setter for member id
1673 function setMemberId ($memberId) {
1674         // We should not set member id to zero
1675         if (!isValidId($memberId)) {
1676                 reportBug(__FUNCTION__, __LINE__, 'Userid should not be set zero.');
1677         } // END - if
1678
1679         // Set it secured
1680         $GLOBALS['member_id'] = bigintval($memberId);
1681 }
1682
1683 // Getter for member id or returns zero
1684 function getMemberId () {
1685         // Default member id
1686         $memberId = '0';
1687
1688         // Is the member id set?
1689         if (isMemberIdSet()) {
1690                 // Then use it
1691                 $memberId = $GLOBALS['member_id'];
1692         } // END - if
1693
1694         // Return it
1695         return $memberId;
1696 }
1697
1698 // Checks ether the member id is set
1699 function isMemberIdSet () {
1700         return (isset($GLOBALS['member_id']));
1701 }
1702
1703 // Setter for extra title
1704 function setExtraTitle ($extraTitle) {
1705         $GLOBALS['extra_title'] = $extraTitle;
1706 }
1707
1708 // Getter for extra title
1709 function getExtraTitle () {
1710         // Is the extra title set?
1711         if (!isExtraTitleSet()) {
1712                 // No, then abort here
1713                 reportBug(__FUNCTION__, __LINE__, 'extra_title is not set!');
1714         } // END - if
1715
1716         // Return it
1717         return $GLOBALS['extra_title'];
1718 }
1719
1720 // Checks if the extra title is set
1721 function isExtraTitleSet () {
1722         return ((isset($GLOBALS['extra_title'])) && (!empty($GLOBALS['extra_title'])));
1723 }
1724
1725 /**
1726  * Reads a directory recursively by default and searches for files not matching
1727  * an exclusion pattern. You can now keep the exclusion pattern empty for reading
1728  * a whole directory.
1729  *
1730  * @param       $baseDir                        Relative base directory to PATH to scan from
1731  * @param       $prefix                         Prefix for all positive matches (which files should be found)
1732  * @param       $fileIncludeDirs        whether to include directories in the final output array
1733  * @param       $addBaseDir                     whether to add $baseDir to all array entries
1734  * @param       $excludeArray           Excluded files and directories, these must be full files names, e.g. 'what-' will exclude all files named 'what-' but won't exclude 'what-foo.php'
1735  * @param       $extension                      File extension for all positive matches
1736  * @param       $excludePattern         Regular expression to exclude more files (preg_match())
1737  * @param       $recursive                      whether to scan recursively
1738  * @param       $suffix                         Suffix for positive matches ($extension will be appended, too)
1739  * @return      $foundMatches           All found positive matches for above criteria
1740  */
1741 function getArrayFromDirectory ($baseDir, $prefix, $fileIncludeDirs = FALSE, $addBaseDir = TRUE, $excludeArray = array(), $extension = '.php', $excludePattern = '@(\.|\.\.)$@', $recursive = TRUE, $suffix = '') {
1742         // Add default entries we should always exclude
1743         array_unshift($excludeArray, '.', '..', '.svn', '.htaccess');
1744
1745         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'baseDir=' . $baseDir . ',prefix=' . $prefix . ' - Entered!');
1746         // Init found includes
1747         $foundMatches = array();
1748
1749         // Open directory
1750         $dirPointer = opendir(getPath() . $baseDir) or reportBug(__FUNCTION__, __LINE__, 'Cannot read directory ' . basename($baseDir) . '.');
1751
1752         // Read all entries
1753         while ($baseFile = readdir($dirPointer)) {
1754                 // Exclude '.', '..' and entries in $excludeArray automatically
1755                 if (in_array($baseFile, $excludeArray, TRUE))  {
1756                         // Exclude them
1757                         //* DEBUG: */ debugOutput('excluded=' . $baseFile);
1758                         continue;
1759                 } // END - if
1760
1761                 // Construct include filename and FQFN
1762                 $fileName = $baseDir . $baseFile;
1763                 $FQFN = getPath() . $fileName;
1764
1765                 // Remove double slashes
1766                 $FQFN = str_replace('//', '/', $FQFN);
1767
1768                 // Check if the base filenname matches an exclusion pattern and if the pattern is not empty
1769                 if ((!empty($excludePattern)) && (preg_match($excludePattern, $baseFile, $match))) {
1770                         // Debug message
1771                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'baseDir=' . $baseDir . ',baseFile=' . $baseFile . ',FQFN=' . $FQFN);
1772
1773                         // Exclude this one
1774                         continue;
1775                 } // END - if
1776
1777                 // Skip also files with non-matching prefix genericly
1778                 if (($recursive === TRUE) && (isDirectory($FQFN))) {
1779                         // Is a redirectory so read it as well
1780                         $foundMatches = merge_array($foundMatches, getArrayFromDirectory($baseDir . $baseFile . '/', $prefix, $fileIncludeDirs, $addBaseDir, $excludeArray, $extension, $excludePattern, $recursive));
1781
1782                         // And skip further processing
1783                         continue;
1784                 } elseif (!isFilePrefixFound($baseFile, $prefix)) {
1785                         // Skip this file
1786                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Invalid prefix in file ' . $baseFile . ', prefix=' . $prefix);
1787                         continue;
1788                 } elseif ((!empty($suffix)) && (substr($baseFile, -(strlen($suffix . $extension)), (strlen($suffix . $extension))) != $suffix . $extension)) {
1789                         // Skip wrong suffix as well
1790                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Invalid suffix in file ' . $baseFile . ', suffix=' . $suffix);
1791                         continue;
1792                 } elseif (!isFileReadable($FQFN)) {
1793                         // Not readable so skip it
1794                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File ' . $FQFN . ' is not readable!');
1795                 } elseif (filesize($FQFN) < 50) {
1796                         // Might be deprecated
1797                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File ' . $FQFN . ' is to small (' . filesize($FQFN) . ')!');
1798                         continue;
1799                 } elseif (($extension == '.php') && (filesize($FQFN) < 50)) {
1800                         // This PHP script is deprecated
1801                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File ' . $FQFN . ' is a deprecated PHP script!');
1802                         continue;
1803                 }
1804
1805                 // Get file' extension (last 4 chars)
1806                 $fileExtension = substr($baseFile, -4, 4);
1807
1808                 // Is the file a PHP script or other?
1809                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'baseDir=' . $baseDir . ',prefix=' . $prefix . ',baseFile=' . $baseFile);
1810                 if (($fileExtension == '.php') || (($fileIncludeDirs === TRUE) && (isDirectory($FQFN)))) {
1811                         // Is this a valid include file?
1812                         if ($extension == '.php') {
1813                                 // Remove both for extension name
1814                                 $extName = substr($baseFile, strlen($prefix), -4);
1815
1816                                 // Add file with or without base path
1817                                 if ($addBaseDir === TRUE) {
1818                                         // With base path
1819                                         array_push($foundMatches, $fileName);
1820                                 } else {
1821                                         // No base path
1822                                         array_push($foundMatches, $baseFile);
1823                                 }
1824                         } else {
1825                                 // We found .php file but should not search for them, why?
1826                                 reportBug(__FUNCTION__, __LINE__, 'We should find files with extension=' . $extension . ', but we found a PHP script. (baseFile=' . $baseFile . ')');
1827                         }
1828                 } elseif ($fileExtension == $extension) {
1829                         // Other, generic file found
1830                         array_push($foundMatches, $fileName);
1831                 }
1832         } // END - while
1833
1834         // Close directory
1835         closedir($dirPointer);
1836
1837         // Sort array
1838         sort($foundMatches);
1839
1840         // Return array with include files
1841         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Left!');
1842         return $foundMatches;
1843 }
1844
1845 // Checks whether $prefix is found in $fileName
1846 function isFilePrefixFound ($fileName, $prefix) {
1847         // @TODO Find a way to cache this
1848         return (substr($fileName, 0, strlen($prefix)) == $prefix);
1849 }
1850
1851 // Maps a module name into a database table name
1852 function mapModuleToTable ($moduleName) {
1853         // Map only these, still lame code...
1854         switch ($moduleName) {
1855                 case 'index': // 'index' is the guest's menu
1856                         $moduleName = 'guest';
1857                         break;
1858
1859                 case 'login': // ... and 'login' the member's menu
1860                         $moduleName = 'member';
1861                         break;
1862                 // Anything else will not be mapped, silently.
1863         } // END - switch
1864
1865         // Return result
1866         return $moduleName;
1867 }
1868
1869 // Add SQL debug data to array for later output
1870 function addSqlToDebug ($result, $sqlString, $timing, $F, $L) {
1871         // Is there cache?
1872         if (!isset($GLOBALS['debug_sql_available'])) {
1873                 // Check it and cache it in $GLOBALS
1874                 $GLOBALS['debug_sql_available'] = ((isConfigurationLoaded()) && (isDisplayDebugSqlEnabled()));
1875         } // END - if
1876
1877         // Don't execute anything here if we don't need or ext-other is missing
1878         if ($GLOBALS['debug_sql_available'] === FALSE) {
1879                 return;
1880         } // END - if
1881
1882         // Already executed?
1883         if (isset($GLOBALS['debug_sqls'][$F][$L][$sqlString])) {
1884                 // Then abort here, we don't need to profile a query twice
1885                 return;
1886         } // END - if
1887
1888         // Remeber this as profiled (or not, but we don't care here)
1889         $GLOBALS['debug_sqls'][$F][$L][$sqlString] = TRUE;
1890
1891         // Generate record
1892         $record = array(
1893                 'num_rows' => SQL_NUMROWS($result),
1894                 'affected' => SQL_AFFECTEDROWS(),
1895                 'sql_str'  => $sqlString,
1896                 'timing'   => $timing,
1897                 'file'     => basename($F),
1898                 'line'     => $L
1899         );
1900
1901         // Add it
1902         array_push($GLOBALS['debug_sqls'], $record);
1903 }
1904
1905 // Initializes the cache instance
1906 function initCacheInstance () {
1907         // Check for double-initialization
1908         if (isset($GLOBALS['cache_instance'])) {
1909                 // This should not happen and must be fixed
1910                 reportBug(__FUNCTION__, __LINE__, 'Double initialization of cache system detected. cache_instance[]=' . gettype($GLOBALS['cache_instance']));
1911         } // END - if
1912
1913         // Load include for CacheSystem class
1914         loadIncludeOnce('inc/classes/cachesystem.class.php');
1915
1916         // Initialize cache system only when it's needed
1917         $GLOBALS['cache_instance'] = new CacheSystem();
1918
1919         // Did it work?
1920         if ($GLOBALS['cache_instance']->getStatusCode() != 'done') {
1921                 // Failed to initialize cache sustem
1922                 reportBug(__FUNCTION__, __LINE__, 'Cache system returned with unexpected error. getStatusCode()=' . $GLOBALS['cache_instance']->getStatusCode());
1923         } // END - if
1924 }
1925
1926 // Getter for message from array or raw message
1927 function getMessageFromIndexedArray ($message, $pos, $array) {
1928         // Check if the requested message was found in array
1929         if (isset($array[$pos])) {
1930                 // ... if yes then use it!
1931                 $ret = $array[$pos];
1932         } else {
1933                 // ... else use default message
1934                 $ret = $message;
1935         }
1936
1937         // Return result
1938         return $ret;
1939 }
1940
1941 // Convert ';' to ', ' for e.g. receiver list
1942 function convertReceivers ($old) {
1943         return str_replace(';', ', ', $old);
1944 }
1945
1946 // Get a module from filename and access level
1947 function getModuleFromFileName ($file, $accessLevel) {
1948         // Default is 'invalid';
1949         $modCheck = 'invalid';
1950
1951         // @TODO This is still very static, rewrite it somehow
1952         switch ($accessLevel) {
1953                 case 'admin':
1954                         $modCheck = 'admin';
1955                         break;
1956
1957                 case 'sponsor':
1958                 case 'guest':
1959                 case 'member':
1960                         $modCheck = getModule();
1961                         break;
1962
1963                 default: // Unsupported file name / access level
1964                         reportBug(__FUNCTION__, __LINE__, 'Unsupported file name=' . basename($file) . '/access level=' . $accessLevel);
1965                         break;
1966         } // END - switch
1967
1968         // Return result
1969         return $modCheck;
1970 }
1971
1972 // Encodes an URL for adding session id, etc.
1973 function encodeUrl ($url, $outputMode = '0') {
1974         // Is there already have a PHPSESSID inside or view.php is called? Then abort here
1975         if ((isInStringIgnoreCase(session_name(), $url)) || (isRawOutputMode())) {
1976                 // Raw output mode detected or session_name() found in URL
1977                 return $url;
1978         } // END - if
1979
1980         // Is there a valid session?
1981         if ((!isSessionValid()) && (!isSpider())) {
1982                 // Determine right separator
1983                 $separator = '&amp;';
1984                 if (!isInString('?', $url)) {
1985                         // No question mark
1986                         $separator = '?';
1987                 } // END - if
1988
1989                 // Then add it to URL
1990                 $url .= $separator . session_name() . '=' . session_id();
1991         } // END - if
1992
1993         // Add {?URL?} ?
1994         if ((substr($url, 0, strlen(getUrl())) != getUrl()) && (substr($url, 0, 7) != '{?URL?}') && (substr($url, 0, 7) != 'http://') && (substr($url, 0, 8) != 'https://')) {
1995                 // Add it
1996                 $url = '{?URL?}/' . $url;
1997         } // END - if
1998
1999         // Debug message
2000         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ',isHtmlOutputMode()=' . intval(isHtmlOutputMode()) . ',outputMode=' . $outputMode);
2001
2002         // Is there to decode entities?
2003         if (!isHtmlOutputMode()) {
2004                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ' - BEFORE DECODING');
2005                 // Decode them for e.g. JavaScript parts
2006                 $url = decodeEntities($url);
2007                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ' - AFTER DECODING');
2008         } // END - if
2009
2010         // Debug log
2011         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ',outputMode=' . $outputMode);
2012
2013         // Return the encoded URL
2014         return $url;
2015 }
2016
2017 // Simple check for spider
2018 function isSpider () {
2019         // Get the UA and trim it down
2020         $userAgent = trim(detectUserAgent(TRUE));
2021
2022         // It should not be empty, if so it is better a browser
2023         if (empty($userAgent)) {
2024                 // It is a browser that blocks its UA string
2025                 return FALSE;
2026         } // END - if
2027
2028         // Is it a spider?
2029         return ((isInStringIgnoreCase('spider', $userAgent)) || (isInStringIgnoreCase('slurp', $userAgent)) || (isInStringIgnoreCase('bot', $userAgent)) || (isInStringIgnoreCase('archiver', $userAgent)));
2030 }
2031
2032 // Function to search for the last modified file
2033 function searchDirsRecursive ($dir, &$last_changed, $lookFor = 'Date') {
2034         // Get dir as array
2035         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dir=' . $dir);
2036         // Does it match what we are looking for? (We skip a lot files already!)
2037         // RegexPattern to exclude  ., .., .revision,  .svn, debug.log or .cache in the filenames
2038         $excludePattern = '@(\.revision|\.svn|debug\.log|\.cache|config\.php)$@';
2039
2040         $ds = getArrayFromDirectory($dir, '', FALSE, TRUE, array(), '.php', $excludePattern);
2041         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count(ds)='.count($ds));
2042
2043         // Walk through all entries
2044         foreach ($ds as $d) {
2045                 // Generate proper FQFN
2046                 $FQFN = str_replace('//', '/', getPath() . $dir . '/' . $d);
2047
2048                 // Is it a file and readable?
2049                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dir=' . $dir . ',d=' . $d);
2050                 if (isFileReadable($FQFN)) {
2051                         // $FQFN is a readable file so extract the requested data from it
2052                         $check = extractRevisionInfoFromFile($FQFN, $lookFor);
2053                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File: ' . $d . ' found. check=' . $check);
2054
2055                         // Is the file more recent?
2056                         if ((!isset($last_changed[$lookFor])) || ($last_changed[$lookFor] < $check)) {
2057                                 // This file is newer as the file before
2058                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'NEWER!');
2059                                 $last_changed['path_name'] = $FQFN;
2060                                 $last_changed[$lookFor] = $check;
2061                         } // END - if
2062                 } else {
2063                         // Not readable
2064                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File: ' . $d . ' not readable or directory.');
2065                 }
2066         } // END - foreach
2067 }
2068
2069 // Handles the braces [] of a field (e.g. value of 'name' attribute)
2070 function handleFieldWithBraces ($field) {
2071         // Are there braces [] at the end?
2072         if (substr($field, -2, 2) == '[]') {
2073                 /*
2074                  * Try to find one and replace it. I do it this way to allow easy
2075                  * extending of this code.
2076                  */
2077                 foreach (array('admin_list_builder_id_value') as $key) {
2078                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key);
2079                         // Is the cache entry set?
2080                         if (isset($GLOBALS[$key])) {
2081                                 // Insert it
2082                                 $field = str_replace('[]', '[' . $GLOBALS[$key] . ']', $field);
2083
2084                                 // And abort
2085                                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key, 'field=' . $field);
2086                                 break;
2087                         } // END - if
2088                 } // END - foreach
2089         } // END - if
2090
2091         // Return it
2092         return $field;
2093 }
2094
2095 // Converts a zero or NULL to word 'NULL'
2096 function convertZeroToNull ($number) {
2097         // Is it a valid username?
2098         if ((!is_null($number)) && (!empty($number)) && ($number > 0)) {
2099                 // Always secure it
2100                 $number = bigintval($number);
2101         } else {
2102                 // Is not valid or zero
2103                 $number = 'NULL';
2104         }
2105
2106         // Return it
2107         return $number;
2108 }
2109
2110 // Converts a NULL|empty string|< 1 to zero
2111 function convertNullToZero ($number) {
2112         // Is it a valid username?
2113         if ((is_null($number)) || (empty($number)) || ($number < 1)) {
2114                 // Is not valid or zero
2115                 $number = '0';
2116         } // END - if
2117
2118         // Return it
2119         return $number;
2120 }
2121
2122 // Capitalizes a string with underscores, e.g.: some_foo_string will become SomeFooString
2123 // Note: This function is cached
2124 function capitalizeUnderscoreString ($str) {
2125         // Is there cache?
2126         if (!isset($GLOBALS[__FUNCTION__][$str])) {
2127                 // Init target string
2128                 $capitalized = '';
2129
2130                 // Explode it with the underscore, but rewrite dashes to underscore before
2131                 $strArray = explode('_', str_replace('-', '_', $str));
2132
2133                 // "Walk" through all elements and make them lower-case but first upper-case
2134                 foreach ($strArray as $part) {
2135                         // Capitalize the string part
2136                         $capitalized .= firstCharUpperCase($part);
2137                 } // END - foreach
2138
2139                 // Store the converted string in cache array
2140                 $GLOBALS[__FUNCTION__][$str] = $capitalized;
2141         } // END - if
2142
2143         // Return cache
2144         return $GLOBALS[__FUNCTION__][$str];
2145 }
2146
2147 // Generate admin links for mail order
2148 // mailType can be: 'normal' or 'bonus'
2149 function generateAdminMailLinks ($mailType, $mailId) {
2150         // Init variables
2151         $OUT = '';
2152         $table = '';
2153
2154         // Default column for mail status is 'data_type'
2155         // @TODO Rename column data_type to e.g. mail_status
2156         $statusColumn = 'data_type';
2157
2158         // Which mail do we have?
2159         switch ($mailType) {
2160                 case 'bonus': // Bonus mail
2161                         $table = 'bonus';
2162                         break;
2163
2164                 case 'normal': // Member mail
2165                         $table = 'pool';
2166                         break;
2167
2168                 default: // Handle unsupported types
2169                         logDebugMessage(__FUNCTION__, __LINE__, 'Unsupported mail type ' . $mailType . ' for mailId=' . $mailId . ' detected.');
2170                         $OUT = '<div align="center">{%message,ADMIN_UNSUPPORTED_MAIL_TYPE_DETECTED=' . $mailType . '%}</div>';
2171                         break;
2172         } // END - switch
2173
2174         // Is the mail type supported?
2175         if (!empty($table)) {
2176                 // Query for the mail
2177                 $result = SQL_QUERY_ESC("SELECT `id`, `%s` AS `mail_status` FROM `{?_MYSQL_PREFIX?}_%s` WHERE `id`=%s LIMIT 1",
2178                         array(
2179                                 $statusColumn,
2180                                 $table,
2181                                 bigintval($mailId)
2182                         ), __FILE__, __LINE__);
2183
2184                 // Is there one entry there?
2185                 if (SQL_NUMROWS($result) == 1) {
2186                         // Load the entry
2187                         $content = SQL_FETCHARRAY($result);
2188
2189                         // Add output and type
2190                         $content['type']     = $mailType;
2191                         $content['__output'] = '';
2192
2193                         // Filter all data
2194                         $content = runFilterChain('generate_admin_mail_links', $content);
2195
2196                         // Get output back
2197                         $OUT = $content['__output'];
2198                 } // END - if
2199
2200                 // Free result
2201                 SQL_FREERESULT($result);
2202         } // END - if
2203
2204         // Return generated HTML code
2205         return $OUT;
2206 }
2207
2208
2209 /**
2210  * Determine if a string can represent a number in hexadecimal
2211  *
2212  * @param       $hex    A string to check if it is hex-encoded
2213  * @return      $foo    True if the string is a hex, otherwise false
2214  * @author      Marques Johansson
2215  * @link        http://php.net/manual/en/function.http-chunked-decode.php#89786
2216  */
2217 function isHexadecimal ($hex) {
2218         // Make it lowercase
2219         $hex = strtolower(trim(ltrim($hex, '0')));
2220
2221         // Fix empty strings to zero
2222         if (empty($hex)) {
2223                 $hex = 0;
2224         } // END - if
2225
2226         // Simply compare decode->encode result with original
2227         return ($hex == dechex(hexdec($hex)));
2228 }
2229
2230 /**
2231  * Replace chr(13) with "[r]" and PHP_EOL with "[n]" and add a final new-line to make
2232  * them visible to the developer. Use this function to debug e.g. buggy HTTP
2233  * response handler functions.
2234  *
2235  * @param       $str    String to overwork
2236  * @return      $str    Overworked string
2237  */
2238 function replaceReturnNewLine ($str) {
2239         return str_replace(array(chr(13), chr(10)), array('[r]', '[n]'), $str);
2240 }
2241
2242 // Converts a given string by splitting it up with given delimiter similar to
2243 // explode(), but appending the delimiter again
2244 function stringToArray ($delimiter, $string) {
2245         // Init array
2246         $strArray = array();
2247
2248         // "Walk" through all entries
2249         foreach (explode($delimiter, $string) as $split) {
2250                 //  Append the delimiter and add it to the array
2251                 array_push($strArray, $split . $delimiter);
2252         } // END - foreach
2253
2254         // Return array
2255         return $strArray;
2256 }
2257
2258 // Detects the prefix 'mb_' if a multi-byte string is given
2259 function detectMultiBytePrefix ($str) {
2260         // Default is without multi-byte
2261         $mbPrefix = '';
2262
2263         // Detect multi-byte (strictly)
2264         if (mb_detect_encoding($str, 'auto', TRUE) !== FALSE) {
2265                 // With multi-byte encoded string
2266                 $mbPrefix = 'mb_';
2267         } // END - if
2268
2269         // Return the prefix
2270         return $mbPrefix;
2271 }
2272
2273 // Searches given array for a sub-string match and returns all found keys in an array
2274 function getArrayKeysFromSubStrArray ($heystack, $needles, $offset = 0) {
2275         // Init array for all found keys
2276         $keys = array();
2277
2278         // Now check all entries
2279         foreach ($needles as $key => $needle) {
2280                 // Is there found a partial string?
2281                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'heystack='.$heystack.',key='.$key.',needle='.$needle.',offset='.$offset);
2282                 if (strpos($heystack, $needle, $offset) !== FALSE) {
2283                         // Add the found key
2284                         array_push($keys, $key);
2285                 } // END - if
2286         } // END - foreach
2287
2288         // Return the array
2289         return $keys;
2290 }
2291
2292 // Determines database column name from given subject and locked
2293 function determinePointsColumnFromSubjectLocked ($subject, $locked) {
2294         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',locked=' . intval($locked) . ' - ENTERED!');
2295         // Default is 'normal' points
2296         $pointsColumn = 'points';
2297
2298         // Which points, locked or normal?
2299         if ($locked === TRUE) {
2300                 $pointsColumn = 'locked_points';
2301         } // END - if
2302
2303         // Prepare array for filter
2304         $filterData = array(
2305                 'subject' => $subject,
2306                 'locked'  => $locked,
2307                 'column'  => $pointsColumn
2308         );
2309
2310         // Run the filter
2311         $filterData = runFilterChain('determine_points_column_name', $filterData);
2312
2313         // Extract column name from array
2314         $pointsColumn = $filterData['column'];
2315
2316         // Return it
2317         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',locked=' . intval($locked) . ',pointsColumn=' . $pointsColumn . ' - EXIT!');
2318         return $pointsColumn;
2319 }
2320
2321 // Converts a boolean variable into 'Y' for true and 'N' for false
2322 function convertBooleanToYesNo ($boolean) {
2323         // Default is 'N'
2324         $converted = 'N';
2325         if ($boolean === TRUE) {
2326                 // Set 'Y'
2327                 $converted = 'Y';
2328         } // END - if
2329
2330         // Return it
2331         return $converted;
2332 }
2333
2334 // "Translates" 'true' to true and 'false' to false
2335 function convertStringToBoolean ($str) {
2336         // Debug message (to measure how often this function is called)
2337         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'str=' . $str);
2338
2339         // Is there cache?
2340         if (!isset($GLOBALS[__FUNCTION__][$str])) {
2341                 // Trim it lower-case for validation
2342                 $strTrimmed = trim(strtolower($str));
2343
2344                 // Is it valid?
2345                 if (!in_array($strTrimmed, array('true', 'false'))) {
2346                         // Not valid!
2347                         reportBug(__FUNCTION__, __LINE__, 'str=' . $str . '(' . $strTrimmed . ') is not true/false');
2348                 } // END - if
2349
2350                 // Determine it
2351                 $GLOBALS[__FUNCTION__][$str] = ($strTrimmed == 'true');
2352         } // END - if
2353
2354         // Return cache
2355         return $GLOBALS[__FUNCTION__][$str];
2356 }
2357
2358 /**
2359  * "Makes" a variable in given string parseable, this function will throw an
2360  * error if the first character is not a dollar sign.
2361  *
2362  * @param       $varString      String which contains a variable
2363  * @return      $return         String with added single quotes for better parsing
2364  */
2365 function makeParseableVariable ($varString) {
2366         // The first character must be a dollar sign
2367         if (substr($varString, 0, 1) != '$') {
2368                 // Please report this
2369                 reportBug(__FUNCTION__, __LINE__, 'varString=' . $varString . ' - No dollar sign detected, will not parse it.');
2370         } // END - if
2371
2372         // Is there cache?
2373         if (!isset($GLOBALS[__FUNCTION__][$varString])) {
2374                 // Snap them in, if [,] are there
2375                 $GLOBALS[__FUNCTION__][$varString] = str_replace(array('[', ']'), array("['", "']"), $varString);
2376         } // END - if
2377
2378         // Return cache
2379         return $GLOBALS[__FUNCTION__][$varString];
2380 }
2381
2382 // "Getter" for random TAN
2383 function getRandomTan () {
2384         // Generate one
2385         return mt_rand(0, 99999);
2386 }
2387
2388 // Removes any : from subject
2389 function removeDoubleDotFromSubject ($subject) {
2390         // Remove it
2391         $subjectArray = explode(':', $subject);
2392         $subject = $subjectArray[0];
2393         unset($subjectArray);
2394
2395         // Return it
2396         return $subject;
2397 }
2398
2399 // Adds a given entry to the database
2400 function memberAddEntries ($tableName, $columns = array(), $filterFunctions = array(), $extraValues = array(), $timeColumns = array(), $columnIndex = NULL) {
2401         // Is it a member?
2402         if (!isMember()) {
2403                 // Then abort here
2404                 return FALSE;
2405         } // END - if
2406
2407         // Set POST data generic userid
2408         setPostRequestElement('userid', getMemberId());
2409
2410         // Call inner function
2411         doGenericAddEntries($tableName, $columns, $filterFunctions, $extraValues, $timeColumns, $columnIndex);
2412
2413         // Entry has been added?
2414         if ((!SQL_HASZEROAFFECTED()) && ($GLOBALS['__XML_PARSE_RESULT'] === TRUE)) {
2415                 // Display success message
2416                 displayMessage('{--MEMBER_ENTRY_ADDED--}');
2417         } else {
2418                 // Display failed message
2419                 displayMessage('{--MEMBER_ENTRY_NOT_ADDED--}');
2420         }
2421 }
2422
2423 // Edit rows by given id numbers
2424 function memberEditEntriesConfirm ($tableName, $columns = array(), $filterFunctions = array(), $extraValues = array(), $timeColumns = array(), $editNow = array(FALSE), $idColumn = array('id'), $userIdColumn = array('userid'), $rawUserId = array('userid'), $cacheFiles = array(), $content = array()) {
2425         // $tableName must be an array
2426         if ((!is_array($tableName)) || (count($tableName) != 1)) {
2427                 // No tableName specified
2428                 reportBug(__FUNCTION__, __LINE__, 'tableName is not given. Please fix your XML,tableName[]=' . gettype($tableName) . '!=array: userIdColumn=' . $userIdColumn);
2429         } elseif (!is_array($idColumn)) {
2430                 // $idColumn is no array
2431                 reportBug(__FUNCTION__, __LINE__, 'idColumn[]=' . gettype($idColumn) . '!=array: userIdColumn=' . $userIdColumn);
2432         } elseif (!is_array($userIdColumn)) {
2433                 // $userIdColumn is no array
2434                 reportBug(__FUNCTION__, __LINE__, 'userIdColumn[]=' . gettype($userIdColumn) . '!=array: userIdColumn=' . $userIdColumn);
2435         } elseif (!is_array($editNow)) {
2436                 // $editNow is no array
2437                 reportBug(__FUNCTION__, __LINE__, 'editNow[]=' . gettype($editNow) . '!=array: userIdColumn=' . $userIdColumn);
2438         } // END - if
2439
2440         // Shall we change here or list for editing?
2441         if ($editNow[0] === TRUE) {
2442                 // Add generic userid field
2443                 setPostRequestElement('userid', getMemberId());
2444
2445                 // Call generic change method
2446                 $affected = doGenericEditEntriesConfirm($tableName, $columns, $filterFunctions, $extraValues, $timeColumns, $editNow, $idColumn, $userIdColumn, $rawUserId, $cacheFiles, 'mem_edit');
2447
2448                 // Was this fine?
2449                 if ($affected == countPostSelection($idColumn[0])) {
2450                         // All deleted
2451                         displayMessage('{--MEMBER_ALL_ENTRIES_EDITED--}');
2452                 } else {
2453                         // Some are still there :(
2454                         displayMessage(sprintf(getMessage('MEMBER_SOME_ENTRIES_NOT_EDITED'), $affected, countPostSelection($idColumn[0])));
2455                 }
2456         } else {
2457                 // List for editing
2458                 memberListBuilder('edit', $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn, $rawUserId, $content);
2459         }
2460 }
2461
2462 // Delete rows by given id numbers
2463 function memberDeleteEntriesConfirm ($tableName, $columns = array(), $filterFunctions = array(), $extraValues = array(), $deleteNow = array(FALSE), $idColumn = array('id'), $userIdColumn = array('userid'), $rawUserId = array('userid'), $cacheFiles = array(), $content = array()) {
2464         // Do this only for members
2465         assert(isMember());
2466
2467         // $tableName must be an array
2468         if ((!is_array($tableName)) || (count($tableName) != 1)) {
2469                 // No tableName specified
2470                 reportBug(__FUNCTION__, __LINE__, 'tableName is not given. Please fix your XML,tableName[]=' . gettype($tableName) . '!=array: userIdColumn=' . $userIdColumn);
2471         } elseif (!is_array($idColumn)) {
2472                 // $idColumn is no array
2473                 reportBug(__FUNCTION__, __LINE__, 'idColumn[]=' . gettype($idColumn) . '!=array: userIdColumn=' . $userIdColumn);
2474         } elseif (!is_array($userIdColumn)) {
2475                 // $userIdColumn is no array
2476                 reportBug(__FUNCTION__, __LINE__, 'userIdColumn[]=' . gettype($userIdColumn) . '!=array: userIdColumn=' . $userIdColumn);
2477         } elseif (!is_array($deleteNow)) {
2478                 // $deleteNow is no array
2479                 reportBug(__FUNCTION__, __LINE__, 'deleteNow[]=' . gettype($deleteNow) . '!=array: userIdColumn=' . $userIdColumn);
2480         } // END - if
2481
2482         // Shall we delete here or list for deletion?
2483         if ($deleteNow[0] === TRUE) {
2484                 // Add generic userid field
2485                 setPostRequestElement('userid', getMemberId());
2486
2487                 // Call generic function
2488                 $affected = doGenericDeleteEntriesConfirm($tableName, $columns, $filterFunctions, $extraValues, $deleteNow, $idColumn, $userIdColumn, $rawUserId, $cacheFiles, 'mem_delete');
2489
2490                 // Was this fine?
2491                 if ($affected == countPostSelection($idColumn[0])) {
2492                         // All deleted
2493                         displayMessage('{--MEMBER_ALL_ENTRIES_REMOVED--}');
2494                 } else {
2495                         // Some are still there :(
2496                         displayMessage(sprintf(getMessage('MEMBER_SOME_ENTRIES_NOT_DELETED'), SQL_AFFECTEDROWS(), countPostSelection($idColumn[0])));
2497                 }
2498         } else {
2499                 // List for deletion confirmation
2500                 memberListBuilder('delete', $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn, $rawUSerId, $content);
2501         }
2502 }
2503
2504 // Build a special template list
2505 // @TODO cacheFiles is not yet supported
2506 function memberListBuilder ($listType, $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn, $rawUserId = array('userid'), $content = array()) {
2507         // Do this only for logged in member
2508         assert(isMember());
2509
2510         // Call inner (general) function
2511         doGenericListBuilder('member', $listType, $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn, $rawUserId, $content);
2512 }
2513
2514 // Checks whether given address is IPv4
2515 function isIp4AddressValid ($address) {
2516         // Is there cache?
2517         if (!isset($GLOBALS[__FUNCTION__][$address])) {
2518                 // Determine it ...
2519                 $GLOBALS[__FUNCTION__][$address] = preg_match('/((25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9])\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9]|0)\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[1-9]|0)\.(25[0-5]|2[0-4][0-9]|[0-1]{1}[0-9]{2}|[1-9]{1}[0-9]{1}|[0-9]))/', $address);
2520         } // END - if
2521
2522         // Return cache
2523         return $GLOBALS[__FUNCTION__][$address];
2524 }
2525
2526 // Returns the string if not empty or FALSE if empty
2527 function validateIsEmpty ($str) {
2528         // Trim it
2529         $trimmed = trim($str);
2530
2531         // Is the string empty?
2532         if (empty($trimmed)) {
2533                 // Then set FALSE
2534                 $str = FALSE;
2535         } // END - if
2536
2537         // Return it
2538         return $str;
2539 }
2540
2541 // "Getter" for seconds from given time unit
2542 function getSecondsFromTimeUnit ($timeUnit) {
2543         // Default is not found
2544         $seconds = NULL;
2545
2546         // "Detect" it
2547         switch ($timeUnit) {
2548                 case 's': // Seconds = 1
2549                         $seconds = 1;
2550                         break;
2551
2552                 case 'm': // Minutes
2553                         $seconds = 60;
2554                         break;
2555
2556                 case 'h': // Hours
2557                         $seconds = 60*60;
2558                         break;
2559
2560                 case 'D': // Days
2561                         $seconds = 60*60*24;
2562                         break;
2563
2564                 case 'W': // Weeks
2565                         $seconds = 60*60*24*7;
2566                         break;
2567
2568                 default: // Unsupported
2569                         reportBug(__FUNCTION__, __LINE__, 'Unsupported time unit ' . $timeUnit . ' detected.');
2570                         break;
2571         } // END - switch
2572
2573         // Return value
2574         return $seconds;
2575 }
2576
2577 // Calulates value for given seconds and time unit
2578 function caluculateTimeUnitValue ($seconds, $timeUnit) {
2579         // Calculate it
2580         return ($seconds / getSecondsFromTimeUnit($timeUnit));
2581 }
2582
2583 // "Getter" for an array from given one but only one index of it
2584 function getArrayFromArrayIndex ($array, $key) {
2585         // Some simple validation
2586         assert(isset($array[0][$key]));
2587
2588         // Init new array
2589         $newArray = array();
2590
2591         // "Walk" through all elements
2592         foreach ($array as $element) {
2593                 $newArray[] = $element[$key];
2594         } // END - if
2595
2596         // Return it
2597         return $newArray;
2598 }
2599
2600 /**
2601  * Compress given data and encodes it into BASE64 to be stored in database with
2602  * SQL_QUERY_ESC()
2603  *
2604  * @param       $data   Data to be compressed and encoded
2605  * @return      $data   Compressed+encoded data
2606  */
2607 function compress ($data) {
2608         // Compress it
2609         return base64_encode(gzcompress($data));
2610 }
2611
2612 /**
2613  * Decompress given data previously compressed with compress().
2614  *
2615  * @param       $data   Data compressed with compress()
2616  * @reurn       $data   Uncompressed data
2617  */
2618 function decompress ($data) {
2619         // Decompress it
2620         return gzuncompress(base64_decode($data));
2621 }
2622
2623 /**
2624  * Converts given charset in given string to UTF-8 if not UTF-8. This function
2625  * is currently limited to iconv().
2626  *
2627  * @param       $str            String to convert charset in
2628  * @param       $charset        Charset to convert from
2629  * @return      $str            Converted string
2630  */
2631 function convertCharsetToUtf8 ($str, $charset) {
2632         // Is iconv() available?
2633         if (!function_exists('iconv')) {
2634                 // Please make it sure
2635                 reportBug(__FUNCTION__, __LINE__, 'PHP function iconv() is currently required to do charset convertion.');
2636         } // END - if
2637
2638         // Is the charset not UTF-8?
2639         if (strtoupper($charset) != 'UTF-8') {
2640                 // Convert it to UTF-8
2641                 $str = iconv(strtoupper($charset), 'UTF-8//TRANSLIT', $str);
2642         } // END - if
2643
2644         // Return converted string
2645         return $str;
2646 }
2647
2648 // ----------------------------------------------------------------------------
2649 //              "Translatation" functions for points_data table
2650 // ----------------------------------------------------------------------------
2651
2652 // Translates generically some data into a target string
2653 function translateGeneric ($messagePrefix, $data, $messageSuffix = '') {
2654         // Is the method null or empty?
2655         if (is_null($data)) {
2656                 // Is NULL
2657                 $data = 'NULL';
2658         } elseif (empty($data)) {
2659                 // Is empty (string)
2660                 $data = 'EMPTY';
2661         } // END - if
2662
2663         // Default column name is unknown
2664         $return = '{%message,' . $messagePrefix . '_UNKNOWN' . $messageSuffix . '=' . strtoupper($data) . '%}';
2665
2666         // Construct message id
2667         $messageId = $messagePrefix . '_' . strtoupper($data) . $messageSuffix;
2668
2669         // Is it there?
2670         if (isMessageIdValid($messageId)) {
2671                 // Then use it as message string
2672                 $return = '{--' . $messageId . '--}';
2673         } // END - if
2674
2675         // Return the column name
2676         return $return;
2677 }
2678
2679 // Translates points subject to human-readable
2680 function translatePointsSubject ($subject) {
2681         // Remove any :x
2682         $subject = removeDoubleDotFromSubject($subject);
2683
2684         // Return it
2685         return translateGeneric('POINTS_SUBJECT', $subject);
2686 }
2687
2688 // "Translates" given points account type
2689 function translatePointsAccountType ($accountType) {
2690         // Return it
2691         return translateGeneric('POINTS_ACCOUNT_TYPE', $accountType);
2692 }
2693
2694 // "Translates" given points "locked mode"
2695 function translatePointsLockedMode ($lockedMode) {
2696         // Return it
2697         return translateGeneric('POINTS_LOCKED_MODE', $lockedMode);
2698 }
2699
2700 // "Translates" given points payment method
2701 function translatePointsPaymentMethod ($paymentMethod) {
2702         // Return it
2703         return translateGeneric('POINTS_PAYMENT_METHOD', $paymentMethod);
2704 }
2705
2706 // "Translates" given points account provider
2707 function translatePointsAccountProvider ($accountProvider) {
2708         // Return it
2709         return translateGeneric('POINTS_ACCOUNT_PROVIDER', $accountProvider);
2710 }
2711
2712 // "Translates" given points notify recipient
2713 function translatePointsNotifyRecipient ($notifyRecipient) {
2714         // Return it
2715         return translateGeneric('POINTS_NOTIFY_RECIPIENT', $notifyRecipient);
2716 }
2717
2718 // "Translates" given mode to a human-readable version
2719 function translatePointsMode ($pointsMode) {
2720         // Return it
2721         return translateGeneric('POINTS_MODE', $pointsMode);
2722 }
2723
2724 // "Translates" task type to a human-readable version
2725 function translateTaskType ($taskType) {
2726         // Return it
2727         return translateGeneric('ADMIN_TASK_TYPE', $taskType);
2728 }
2729
2730 //-----------------------------------------------------------------------------
2731 // Automatically re-created functions, all taken from user comments on www.php.net
2732 //-----------------------------------------------------------------------------
2733 if (!function_exists('html_entity_decode')) {
2734         // Taken from documentation on www.php.net
2735         function html_entity_decode ($string) {
2736                 $trans_tbl = get_html_translation_table(HTML_ENTITIES);
2737                 $trans_tbl = array_flip($trans_tbl);
2738                 return strtr($string, $trans_tbl);
2739         }
2740 } // END - if
2741
2742 // [EOF]
2743 ?>