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