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)) . '%}';
 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                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $passHash . ',' . $newHash . ' (' . strlen($newHash) . ')');
 902                 $ret = generateHash($newHash, getMasterSalt());
 903         } // END - if
 904
 905         // Return result
 906         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ret=' . $ret . '');
 907         return $ret;
 908 }
 909
 910 // Fix "deleted" cookies
 911 function fixDeletedCookies ($cookies) {
 912         // Is this an array with entries?
 913         if ((is_array($cookies)) && (count($cookies) > 0)) {
 914                 // Then check all cookies if they are marked as deleted!
 915                 foreach ($cookies as $cookieName) {
 916                         // Is the cookie set to "deleted"?
 917                         if (getSession($cookieName) == 'deleted') {
 918                                 setSession($cookieName, '');
 919                         } // END - if
 920                 } // END - foreach
 921         } // END - if
 922 }
 923
 924 // Checks if a given apache module is loaded
 925 function isApacheModuleLoaded ($apacheModule) {
 926         // Check it and return result
 927         return (((function_exists('apache_get_modules')) && (in_array($apacheModule, apache_get_modules()))) || (!function_exists('apache_get_modules')));
 928 }
 929
 930 // Get current theme name
 931 function getCurrentTheme () {
 932         // The default theme is 'default'... ;-)
 933         $ret = 'default';
 934
 935         // Is there ext-theme installed and active or is 'theme' in URL or POST data?
 936         if (isExtensionActive('theme')) {
 937                 // Call inner method
 938                 $ret = getActualTheme();
 939         } elseif ((isPostRequestElementSet('theme')) && (isIncludeReadable(sprintf("theme/%s/theme.php", postRequestElement('theme'))))) {
 940                 // Use value from POST data
 941                 $ret = postRequestElement('theme');
 942         } elseif ((isGetRequestElementSet('theme')) && (isIncludeReadable(sprintf("theme/%s/theme.php", getRequestElement('theme'))))) {
 943                 // Use value from GET data
 944                 $ret = getRequestElement('theme');
 945         } elseif ((isMailerThemeSet()) && (isIncludeReadable(sprintf("theme/%s/theme.php", getMailerTheme())))) {
 946                 // Use value from GET data
 947                 $ret = getMailerTheme();
 948         }
 949
 950         // Return theme value
 951         return $ret;
 952 }
 953
 954 // Generates an error code from given account status
 955 function generateErrorCodeFromUserStatus ($status = '') {
 956         // If no status is provided, use the default, cached
 957         if ((empty($status)) && (isMember())) {
 958                 // Get user status
 959                 $status = getUserData('status');
 960         } // END - if
 961
 962         // Default error code if unknown account status
 963         $errorCode = getCode('ACCOUNT_UNKNOWN');
 964
 965         // Generate constant name
 966         $codeName = sprintf("ACCOUNT_%s", strtoupper($status));
 967
 968         // Is the constant there?
 969         if (isCodeSet($codeName)) {
 970                 // Then get it!
 971                 $errorCode = getCode($codeName);
 972         } else {
 973                 // Unknown status
 974                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown error status %s detected.", $status));
 975         }
 976
 977         // Return error code
 978         return $errorCode;
 979 }
 980
 981 // Back-ported from the new ship-simu engine. :-)
 982 function debug_get_printable_backtrace () {
 983         // Init variable
 984         $backtrace = '<ol>';
 985
 986         // Get and prepare backtrace for output
 987         $backtraceArray = debug_backtrace();
 988         foreach ($backtraceArray as $key => $trace) {
 989                 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
 990                 if (!isset($trace['line'])) $trace['line'] = __LINE__;
 991                 if (!isset($trace['args'])) $trace['args'] = array();
 992                 $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>';
 993         } // END - foreach
 994
 995         // Close it
 996         $backtrace .= '</ol>';
 997
 998         // Return the backtrace
 999         return $backtrace;
1000 }
1001
1002 // A mail-able backtrace
1003 function debug_get_mailable_backtrace () {
1004         // Init variable
1005         $backtrace = '';
1006
1007         // Get and prepare backtrace for output
1008         $backtraceArray = debug_backtrace();
1009         foreach ($backtraceArray as $key => $trace) {
1010                 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
1011                 if (!isset($trace['line'])) $trace['line'] = __LINE__;
1012                 if (!isset($trace['args'])) $trace['args'] = array();
1013                 $backtrace .= ($key+1) . '.:' . basename($trace['file']) . ':' . $trace['line'] . ', ' . $trace['function'] . '(' . count($trace['args']) . ")\n";
1014         } // END - foreach
1015
1016         // Return the backtrace
1017         return $backtrace;
1018 }
1019
1020 // Generates a ***weak*** seed
1021 function generateSeed () {
1022         return microtime(TRUE) * 100000;
1023 }
1024
1025 // Converts a message code to a human-readable message
1026 function getMessageFromErrorCode ($code) {
1027         // Default is an unknown error code
1028         $message = '{%message,UNKNOWN_ERROR_CODE=' . $code . '%}';
1029
1030         // Which code is provided?
1031         switch ($code) {
1032                 case '':
1033                         // No error code is bad coding practice
1034                         reportBug(__FUNCTION__, __LINE__, 'Empty error code supplied. Please fix your code.');
1035                         break;
1036
1037                 // All error messages
1038                 case getCode('LOGOUT_DONE')         : $message = '{--LOGOUT_DONE--}'; break;
1039                 case getCode('LOGOUT_FAILED')       : $message = '<span class="bad">{--LOGOUT_FAILED--}</span>'; break;
1040                 case getCode('DATA_INVALID')        : $message = '{--MAIL_DATA_INVALID--}'; break;
1041                 case getCode('POSSIBLE_INVALID')    : $message = '{--MAIL_POSSIBLE_INVALID--}'; break;
1042                 case getCode('USER_404')            : $message = '{--USER_404--}'; break;
1043                 case getCode('STATS_404')           : $message = '{--MAIL_STATS_404--}'; break;
1044                 case getCode('ALREADY_CONFIRMED')   : $message = '{--MAIL_ALREADY_CONFIRMED--}'; break;
1045                 case getCode('BEG_SAME_AS_OWN')     : $message = '{--BEG_SAME_USERID_AS_OWN--}'; break;
1046                 case getCode('LOGIN_FAILED')        : $message = '{--GUEST_LOGIN_FAILED_GENERAL--}'; break;
1047                 case getCode('MODULE_MEMBER_ONLY')  : $message = '{%message,MODULE_MEMBER_ONLY=' . getRequestElement('mod') . '%}'; break;
1048                 case getCode('OVERLENGTH')          : $message = '{--MEMBER_TEXT_OVERLENGTH--}'; break;
1049                 case getCode('URL_FOUND')           : $message = '{--MEMBER_TEXT_CONTAINS_URL--}'; break;
1050                 case getCode('SUBJECT_URL')         : $message = '{--MEMBER_SUBJECT_CONTAINS_URL--}'; break;
1051                 case getCode('BLIST_URL')           : $message = '{--MEMBER_URL_BLACK_LISTED--}<br />{--MEMBER_BLIST_TIME--}: ' . generateDateTime(getRequestElement('blist'), 0); break;
1052                 case getCode('NO_RECS_LEFT')        : $message = '{--MEMBER_SELECTED_MORE_RECS--}'; break;
1053                 case getCode('INVALID_TAGS')        : $message = '{--MEMBER_HTML_INVALID_TAGS--}'; break;
1054                 case getCode('MORE_POINTS')         : $message = '{--MEMBER_MORE_POINTS_NEEDED--}'; break;
1055                 case getCode('MORE_RECEIVERS1')     : $message = '{--MEMBER_ENTER_MORE_RECEIVERS--}'; break;
1056                 case getCode('MORE_RECEIVERS2')     : $message = '{--MEMBER_NO_MORE_RECEIVERS_FOUND--}'; break;
1057                 case getCode('MORE_RECEIVERS3')     : $message = '{--MEMBER_ENTER_MORE_MIN_RECEIVERS--}'; break;
1058                 case getCode('INVALID_URL')         : $message = '{--MEMBER_ENTER_INVALID_URL--}'; break;
1059                 case getCode('NO_MAIL_TYPE')        : $message = '{--MEMBER_NO_MAIL_TYPE_SELECTED--}'; break;
1060                 case getCode('PROFILE_UPDATED')     : $message = '{--MEMBER_PROFILE_UPDATED--}'; break;
1061                 case getCode('UNKNOWN_REDIRECT')    : $message = '{--UNKNOWN_REDIRECT_VALUE--}'; break;
1062                 case getCode('WRONG_PASS')          : $message = '{--LOGIN_WRONG_PASS--}'; break;
1063                 case getCode('WRONG_ID')            : $message = '{--LOGIN_WRONG_ID--}'; break;
1064                 case getCode('ACCOUNT_LOCKED')      : $message = '{--LOGIN_STATUS_LOCKED--}'; break;
1065                 case getCode('ACCOUNT_UNCONFIRMED') : $message = '{--LOGIN_STATUS_UNCONFIRMED--}'; break;
1066                 case getCode('COOKIES_DISABLED')    : $message = '{--LOGIN_COOKIES_DISABLED--}'; break;
1067                 case getCode('UNKNOWN_ERROR')       : $message = '{--LOGIN_UNKNOWN_ERROR--}'; break;
1068                 case getCode('UNKNOWN_STATUS')      : $message = '{--LOGIN_UNKNOWN_STATUS--}'; break;
1069                 case getCode('LOGIN_EMPTY_ID')      : $message = '{--LOGIN_ID_IS_EMPTY--}'; break;
1070                 case getCode('LOGIN_EMPTY_PASSWORD'): $message = '{--LOGIN_PASSWORD_IS_EMPTY--}'; break;
1071
1072                 case getCode('ERROR_MAILID'):
1073                         if (isExtensionActive('mailid', TRUE)) {
1074                                 $message = '{--ERROR_CONFIRMING_MAIL--}';
1075                         } else {
1076                                 $message = '{%pipe,generateExtensionInactiveNotInstalledMessage=mailid%}';
1077                         }
1078                         break;
1079
1080                 case getCode('EXTENSION_PROBLEM'):
1081                         if (isGetRequestElementSet('ext')) {
1082                                 $message = '{%pipe,generateExtensionInactiveNotInstalledMessage=' . getRequestElement('ext') . '%}';
1083                         } else {
1084                                 $message = '{--EXTENSION_PROBLEM_UNSET_EXT--}';
1085                         }
1086                         break;
1087
1088                 case getCode('URL_TIME_LOCK'):
1089                         // @TODO Move this SQL code into a function, let's say 'getTimestampFromPoolId($id) ?
1090                         $result = SQL_QUERY_ESC("SELECT `timestamp` FROM `{?_MYSQL_PREFIX?}_pool` WHERE `id`=%s LIMIT 1",
1091                                 array(bigintval(getRequestElement('id'))), __FUNCTION__, __LINE__);
1092
1093                         // Load timestamp from last order
1094                         $content = SQL_FETCHARRAY($result);
1095
1096                         // Free memory
1097                         SQL_FREERESULT($result);
1098
1099                         // Translate it for templates
1100                         $content['timestamp'] = generateDateTime($content['timestamp'], 1);
1101
1102                         // Calculate hours...
1103                         $content['hours'] = round(getUrlTlock() / 60 / 60);
1104
1105                         // Minutes...
1106                         $content['minutes'] = round((getUrlTlock() - $content['hours'] * 60 * 60) / 60);
1107
1108                         // And seconds
1109                         $content['seconds'] = round(getUrlTlock() - $content['hours'] * 60 * 60 - $content['minutes'] * 60);
1110
1111                         // Finally contruct the message
1112                         $message = loadTemplate('tlock_message', TRUE, $content);
1113                         break;
1114
1115                 default:
1116                         // Log missing/invalid error codes
1117                         logDebugMessage(__FUNCTION__, __LINE__, getMessage('UNKNOWN_MAILID_CODE', $code));
1118                         break;
1119         } // END - switch
1120
1121         // Return the message
1122         return $message;
1123 }
1124
1125 // Function taken from user comments on www.php.net / function isInStringIgnoreCase()
1126 function isUrlValidSimple ($url) {
1127         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ' - ENTERED!');
1128         // Prepare URL
1129         $url = secureString(str_replace(chr(92), '', compileRawCode(urldecode($url))));
1130
1131         // Allows http and https
1132         $http      = "(http|https)+(:\/\/)";
1133         // Test domain
1134         $domain1   = "([[:alnum:]]([-[:alnum:]])*\.)?([[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})?";
1135         // Test double-domains (e.g. .de.vu)
1136         $domain2   = "([-[:alnum:]])?(\.[[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})(\.[[:alpha:]]{2,5})?";
1137         // Test IP number
1138         $ip        = "([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})";
1139         // ... directory
1140         $dir       = "((/)+([-_\.[:alnum:]])+)*";
1141         // ... page
1142         $page      = "/([-_[:alnum:]][-\._[:alnum:]]*\.[[:alnum:]]{2,5})?";
1143         // ... and the string after and including question character
1144         $getstring1 = "([\?/]([[:alnum:]][-\._%[:alnum:]]*(=)?([-\@\._:%[:alnum:]])+)(&([[:alnum:]]([-_%[:alnum:]])*(=)?([-\@\[\._:%[:alnum:]])+(\])*))*)?";
1145         // Pattern for URLs like http://url/dir/doc.html?var=value
1146         $pattern['d1dpg1']  = $http . $domain1 . $dir . $page . $getstring1;
1147         $pattern['d2dpg1']  = $http . $domain2 . $dir . $page . $getstring1;
1148         $pattern['ipdpg1']  = $http . $ip . $dir . $page . $getstring1;
1149         // Pattern for URLs like http://url/dir/?var=value
1150         $pattern['d1dg1']  = $http . $domain1 . $dir.'/' . $getstring1;
1151         $pattern['d2dg1']  = $http . $domain2 . $dir.'/' . $getstring1;
1152         $pattern['ipdg1']  = $http . $ip . $dir.'/' . $getstring1;
1153         // Pattern for URLs like http://url/dir/page.ext
1154         $pattern['d1dp']  = $http . $domain1 . $dir . $page;
1155         $pattern['d1dp']  = $http . $domain2 . $dir . $page;
1156         $pattern['ipdp']  = $http . $ip . $dir . $page;
1157         // Pattern for URLs like http://url/dir
1158         $pattern['d1d']  = $http . $domain1 . $dir;
1159         $pattern['d2d']  = $http . $domain2 . $dir;
1160         $pattern['ipd']  = $http . $ip . $dir;
1161         // Pattern for URLs like http://url/?var=value
1162         $pattern['d1g1']  = $http . $domain1 . '/' . $getstring1;
1163         $pattern['d2g1']  = $http . $domain2 . '/' . $getstring1;
1164         $pattern['ipg1']  = $http . $ip . '/' . $getstring1;
1165         // Pattern for URLs like http://url?var=value
1166         $pattern['d1g12']  = $http . $domain1 . $getstring1;
1167         $pattern['d2g12']  = $http . $domain2 . $getstring1;
1168         $pattern['ipg12']  = $http . $ip . $getstring1;
1169
1170         // Test all patterns
1171         $reg = FALSE;
1172         foreach ($pattern as $key => $pat) {
1173                 // Debug regex?
1174                 if (isDebugRegularExpressionEnabled()) {
1175                         // @TODO Are these convertions still required?
1176                         $pat = str_replace('.', '&#92;&#46;', $pat);
1177                         $pat = str_replace('@', '&#92;&#64;', $pat);
1178                         //* DEBUG: */ debugOutput($key . '=&nbsp;' . $pat);
1179                 } // END - if
1180
1181                 // Check if expression matches
1182                 $reg = ($reg || preg_match(('^' . $pat . '^'), $url));
1183
1184                 // Does it match?
1185                 if ($reg === TRUE) {
1186                         break;
1187                 } // END - if
1188         } // END - foreach
1189
1190         // Return true/false
1191         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ',reg=' . intval($reg) . ' - EXIT!');
1192         return $reg;
1193 }
1194
1195 // Wtites data to a config.php-style file
1196 // @TODO Rewrite this function to use readFromFile() and writeToFile()
1197 function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $inserted, $seek=0) {
1198         // Initialize some variables
1199         $done = FALSE;
1200         $seek++;
1201         $next  = -1;
1202         $found = FALSE;
1203
1204         // Is the file there and read-/write-able?
1205         if ((isFileReadable($FQFN)) && (is_writeable($FQFN))) {
1206                 $search = 'CFG: ' . $comment;
1207                 $tmp = $FQFN . '.tmp';
1208
1209                 // Open the source file
1210                 $fp = fopen($FQFN, 'r') or reportBug(__FUNCTION__, __LINE__, 'Cannot read. file=' . basename($FQFN));
1211
1212                 // Is the resource valid?
1213                 if (is_resource($fp)) {
1214                         // Open temporary file
1215                         $fp_tmp = fopen($tmp, 'w') or reportBug(__FUNCTION__, __LINE__, 'Cannot write. tmp=' . basename($tmp) . ',file=' . $FQFN);
1216
1217                         // Is the resource again valid?
1218                         if (is_resource($fp_tmp)) {
1219                                 // Mark temporary file as readable
1220                                 $GLOBALS['file_readable'][$tmp] = TRUE;
1221
1222                                 // Start reading
1223                                 while (!feof($fp)) {
1224                                         // Read from source file
1225                                         $line = fgets ($fp, 1024);
1226
1227                                         if (isInString($search, $line)) {
1228                                                 $next = '0';
1229                                                 $found = TRUE;
1230                                         } // END - if
1231
1232                                         if ($next > -1) {
1233                                                 if ($next === $seek) {
1234                                                         $next = -1;
1235                                                         $line = $prefix . $inserted . $suffix . chr(10);
1236                                                 } else {
1237                                                         $next++;
1238                                                 }
1239                                         } // END - if
1240
1241                                         // Write to temp file
1242                                         fwrite($fp_tmp, $line);
1243                                 } // END - while
1244
1245                                 // Close temp file
1246                                 fclose($fp_tmp);
1247
1248                                 // Finished writing tmp file
1249                                 $done = TRUE;
1250                         } // END - if
1251
1252                         // Close source file
1253                         fclose($fp);
1254
1255                         if (($done === TRUE) && ($found === TRUE)) {
1256                                 // Copy back tmp file and delete tmp :-)
1257                                 copyFileVerified($tmp, $FQFN, 0644);
1258                                 return removeFile($tmp);
1259                         } elseif ($found === FALSE) {
1260                                 outputHtml('<strong>CHANGE:</strong> 404!');
1261                         } else {
1262                                 outputHtml('<strong>TMP:</strong> UNDONE!');
1263                         }
1264                 }
1265         } else {
1266                 // File not found, not readable or writeable
1267                 reportBug(__FUNCTION__, __LINE__, 'File not readable/writeable. file=' . basename($FQFN));
1268         }
1269
1270         // An error was detected!
1271         return FALSE;
1272 }
1273
1274 // Debug message logger
1275 function logDebugMessage ($funcFile, $line, $message, $force=true) {
1276         // Is debug mode enabled?
1277         if ((isDebugModeEnabled()) || ($force === TRUE)) {
1278                 // Remove CRLF
1279                 $message = str_replace(array(chr(13), chr(10)), array('', ''), $message);
1280
1281                 // Log this message away
1282                 appendLineToFile(getPath() . getCachePath() . 'debug.log', generateDateTime(time(), '4') . '|' . getModule(FALSE) . '|' . basename($funcFile) . '|' . $line . '|' . $message);
1283         } // END - if
1284 }
1285
1286 // Handle extra values
1287 function handleExtraValues ($filterFunction, $value, $extraValue) {
1288         // Default is the value itself
1289         $ret = $value;
1290
1291         // Is there a special filter function?
1292         if ((empty($filterFunction)) || (!function_exists($filterFunction))) {
1293                 // Call-back function does not exist or is empty
1294                 reportBug(__FUNCTION__, __LINE__, 'Filter function ' . $filterFunction . ' does not exist or is empty: value[' . gettype($value) . ']=' . $value . ',extraValue[' . gettype($extraValue) . ']=' . $extraValue);
1295         } // END - if
1296
1297         // Is there extra parameters here?
1298         if ((!is_null($extraValue)) && (!empty($extraValue))) {
1299                 // Put both parameters in one new array by default
1300                 $args = array($value, $extraValue);
1301
1302                 // If we have an array simply use it and pre-extend it with our value
1303                 if (is_array($extraValue)) {
1304                         // Make the new args array
1305                         $args = merge_array(array($value), $extraValue);
1306                 } // END - if
1307
1308                 // Call the multi-parameter call-back
1309                 $ret = call_user_func_array($filterFunction, $args);
1310
1311                 // Is $ret 'true'?
1312                 if ($ret === TRUE) {
1313                         // Test passed, so write direct value
1314                         $ret = $args;
1315                 } // END - if
1316         } else {
1317                 // One parameter call
1318                 $ret = call_user_func($filterFunction, $value);
1319                 //* BUG */ die('ret['.gettype($ret).']=' . $ret . ',value=' . $value.',filterFunction=' . $filterFunction);
1320
1321                 // Is $ret 'true'?
1322                 if ($ret === TRUE) {
1323                         // Test passed, so write direct value
1324                         $ret = $value;
1325                 } // END - if
1326         }
1327
1328         // Return the value
1329         return $ret;
1330 }
1331
1332 // Tries to determine if call-back functions and/or extra values shall be parsed
1333 function doHandleExtraValues ($filterFunctions, $extraValues, $key, $entries, $userIdColumn, $search) {
1334         // Debug message
1335         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key . ',entries=' . $entries . ',userIdColumn=' . $userIdColumn[0] . ',search=' . $search . ',filterFunctions=' . print_r($filterFunctions, TRUE) . ',extraValues=' . print_r($extraValues, TRUE));
1336
1337         // Send data through the filter function if found
1338         if ($key == $userIdColumn[0]) {
1339                 // Is the userid, we have to process it with convertZeroToNull()
1340                 $entries = convertZeroToNull($entries);
1341         } elseif ((!empty($filterFunctions[$key])) && (isset($extraValues[$key]))) {
1342                 // Debug mode enabled?
1343                 if (isDebugModeEnabled()) {
1344                         // Then log it
1345                         /* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'search=' . $search . ',filterFunctions=' . $filterFunctions[$search] . ',extraValues=' . $extraValues[$key] . ',key=' . $key . ',id=' . $id . ',entries[' . gettype($entries) . ']=' . $entries . ' - BEFORE!');
1346                 } // END - if
1347
1348                 // Filter function + extra value set
1349                 $entries = handleExtraValues($filterFunctions[$key], $entries, $extraValues[$key]);
1350
1351                 // Debug mode enabled?
1352                 if (isDebugModeEnabled()) {
1353                         // Then log it
1354                         /* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'search=' . $search . ',filterFunctions=' . $filterFunctions[$search] . ',extraValues=' . $extraValues[$key] . ',key=' . $key . ',id=' . $id . ',entries[' . gettype($entries) . ']=' . $entries . ' - AFTER!');
1355                 } // END - if
1356         } elseif (!empty($filterFunctions[$search])) {
1357                 // Debug mode enabled?
1358                 if (isDebugModeEnabled()) {
1359                         // Then log it
1360                         /* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'search=' . $search . ',filterFunctions=' . $filterFunctions[$search] . ',key=' . $key . ',search=' . $search . ',entries[' . gettype($entries) . ']=' . $entries . ' - BEFORE!');
1361                 } // END - if
1362
1363                 // Handle extra values
1364                 $entries = handleExtraValues($filterFunctions[$search], $entries, NULL);
1365
1366                 // Debug mode enabled?
1367                 if (isDebugModeEnabled()) {
1368                         // Then log it
1369                         /* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'search=' . $search . ',filterFunctions=' . $filterFunctions[$search] . ',key=' . $key . ',search=' . $search . ',entries[' . gettype($entries) . ']=' . $entries . ' - AFTER!');
1370                 } // END - if
1371
1372                 // Make sure entries is not bool, then something went wrong
1373                 assert(!is_bool($entries));
1374         }
1375
1376         // Return value
1377         return $entries;
1378 }
1379
1380 // Converts timestamp selections into a timestamp
1381 function convertSelectionsToEpocheTime (array &$postData, array &$content, &$id, &$skip) {
1382         // Init test variable
1383         $skip  = FALSE;
1384         $test2 = '';
1385
1386         // Get last three chars
1387         $test = substr($id, -3);
1388
1389         // Improved way of checking! :-)
1390         if (in_array($test, array('_ye', '_mo', '_we', '_da', '_ho', '_mi', '_se'))) {
1391                 // Found a multi-selection for timings?
1392                 $test = substr($id, 0, -3);
1393                 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)) {
1394                         // Generate timestamp
1395                         $postData[$test] = createEpocheTimeFromSelections($test, $postData);
1396                         array_push($content, sprintf("`%s`='%s'", $test, $postData[$test]));
1397                         $GLOBALS['skip_config'][$test] = TRUE;
1398
1399                         // Remove data from array
1400                         foreach (array('ye', 'mo', 'we', 'da', 'ho', 'mi', 'se') as $rem) {
1401                                 unset($postData[$test . '_' . $rem]);
1402                         } // END - foreach
1403
1404                         // Skip adding
1405                         unset($id);
1406                         $skip = TRUE;
1407                         $test2 = $test;
1408                 } // END - if
1409         } // END - if
1410 }
1411
1412 // Reverts the german decimal comma into Computer decimal dot
1413 // OPPOMENT: translateComma()
1414 function convertCommaToDot ($str) {
1415         // Default float is not a float... ;-)
1416         $float = FALSE;
1417
1418         // Which language is selected?
1419         switch (getLanguage()) {
1420                 case 'de': // German language
1421                         // Remove german thousand dots first
1422                         $str = str_replace('.', '', $str);
1423
1424                         // Replace german commata with decimal dot and cast it
1425                         $float = (float) str_replace(',', '.', $str);
1426                         break;
1427
1428                 default: // US and so on
1429                         // Remove thousand commatas first and cast
1430                         $float = (float) str_replace(',', '', $str);
1431                         break;
1432         } // END - switch
1433
1434         // Return float
1435         return $float;
1436 }
1437
1438 // Handle menu-depending failed logins and return the rendered content
1439 function handleLoginFailures ($accessLevel) {
1440         // Default output is empty ;-)
1441         $OUT = '';
1442
1443         // Is the session data set?
1444         if ((isSessionVariableSet('mailer_' . $accessLevel . '_failures')) && (isSessionVariableSet('mailer_' . $accessLevel . '_last_failure'))) {
1445                 // Ignore zero values
1446                 if (getSession('mailer_' . $accessLevel . '_failures') > 0) {
1447                         // Non-guest has login failures found, get both data and prepare it for template
1448                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'accessLevel=' . $accessLevel . '<br />');
1449                         $content = array(
1450                                 'login_failures' => 'mailer_' . $accessLevel . '_failures',
1451                                 'last_failure'   => generateDateTime(getSession('mailer_' . $accessLevel . '_last_failure'), 2)
1452                         );
1453
1454                         // Load template
1455                         $OUT = loadTemplate('login_failures', TRUE, $content);
1456                 } // END - if
1457
1458                 // Reset session data
1459                 setSession('mailer_' . $accessLevel . '_failures', '');
1460                 setSession('mailer_' . $accessLevel . '_last_failure', '');
1461         } // END - if
1462
1463         // Return rendered content
1464         return $OUT;
1465 }
1466
1467 // Rebuild cache
1468 function rebuildCache ($cache, $inc = '', $force = FALSE) {
1469         // Debug message
1470         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("cache=%s, inc=%s, force=%s", $cache, $inc, intval($force)));
1471
1472         // Shall I remove the cache file?
1473         if ((isExtensionInstalled('cache')) && (isCacheInstanceValid()) && (isHtmlOutputMode())) {
1474                 // Rebuild cache only in HTML output-mode
1475                 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) {
1476                         // Destroy it
1477                         $GLOBALS['cache_instance']->removeCacheFile($force);
1478                 } // END - if
1479
1480                 // Include file given?
1481                 if (!empty($inc)) {
1482                         // Construct FQFN
1483                         $inc = sprintf("inc/loader/load-%s.php", $inc);
1484
1485                         // Is the include there?
1486                         if (isIncludeReadable($inc)) {
1487                                 // And rebuild it from scratch
1488                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'inc=' . $inc . ' - LOADED!');
1489                                 loadInclude($inc);
1490                         } else {
1491                                 // Include not found
1492                                 logDebugMessage(__FUNCTION__, __LINE__, 'Include ' . $inc . ' not found. cache=' . $cache);
1493                         }
1494                 } // END - if
1495         } // END - if
1496 }
1497
1498 // Determines the real remote address
1499 function determineRealRemoteAddress ($remoteAddr = FALSE) {
1500         // Default is 127.0.0.1
1501         $address = '127.0.0.1';
1502
1503         // Is a proxy in use?
1504         if ((isset($_SERVER['HTTP_X_FORWARDED_FOR'])) && (!$remoteAddr)) {
1505                 // Proxy was used
1506                 $address = $_SERVER['HTTP_X_FORWARDED_FOR'];
1507         } elseif ((isset($_SERVER['HTTP_CLIENT_IP'])) && (!$remoteAddr)) {
1508                 // Yet, another proxy
1509                 $address = $_SERVER['HTTP_CLIENT_IP'];
1510         } elseif (isset($_SERVER['REMOTE_ADDR'])) {
1511                 // The regular address when no proxy was used
1512                 $address = $_SERVER['REMOTE_ADDR'];
1513         }
1514
1515         // This strips out the real address from proxy output
1516         if (strstr($address, ',')) {
1517                 $addressArray = explode(',', $address);
1518                 $address = $addressArray[0];
1519         } // END - if
1520
1521         // Return the result
1522         return $address;
1523 }
1524
1525 // Adds a bonus mail to the queue
1526 // This is a high-level function!
1527 function addNewBonusMail ($data, $mode = '', $output = TRUE) {
1528         // Use mode from data if not set and availble ;-)
1529         if ((empty($mode)) && (isset($data['mail_mode']))) {
1530                 $mode = $data['mail_mode'];
1531         } // END - if
1532
1533         // Generate receiver list
1534         $receiver = generateReceiverList($data['cat'], $data['receiver'], $mode);
1535
1536         // Receivers added?
1537         if (!empty($receiver)) {
1538                 // Add bonus mail to queue
1539                 addBonusMailToQueue(
1540                         $data['subject'],
1541                         $data['text'],
1542                         $receiver,
1543                         $data['points'],
1544                         $data['seconds'],
1545                         $data['url'],
1546                         $data['cat'],
1547                         $mode,
1548                         $data['receiver']
1549                 );
1550
1551                 // Mail inserted into bonus pool
1552                 if ($output === TRUE) {
1553                         displayMessage('{--ADMIN_BONUS_SEND--}');
1554                 } // END - if
1555         } elseif ($output === TRUE) {
1556                 // More entered than can be reached!
1557                 displayMessage('{--ADMIN_MORE_SELECTED--}');
1558         } else {
1559                 // Debug log
1560                 logDebugMessage(__FUNCTION__, __LINE__, 'cat=' . $data['cat'] . ',receiver=' . $data['receiver'] . ',data=' . base64_encode(serialize($data)) . ' More selected, than available!');
1561         }
1562 }
1563
1564 // Enables the reset mode and runs it
1565 function doReset () {
1566         // Enable the reset mode
1567         $GLOBALS['reset_enabled'] = TRUE;
1568
1569         // Run filters
1570         runFilterChain('reset');
1571 }
1572
1573 // Enables the reset mode (hourly, weekly and monthly) and runs it
1574 function doHourly () {
1575         // Enable the hourly reset mode
1576         $GLOBALS['hourly_enabled'] = TRUE;
1577
1578         // Run filters (one always!)
1579         runFilterChain('hourly');
1580 }
1581
1582 // Shuts down the mailer (e.g. closing database link, flushing output/filters, etc.)
1583 function doShutdown () {
1584         // Call the filter chain 'shutdown'
1585         runFilterChain('shutdown', NULL);
1586
1587         // Check if not in installation phase and the link is up
1588         if ((!isInstallationPhase()) && (SQL_IS_LINK_UP())) {
1589                 // Close link
1590                 SQL_CLOSE(__FUNCTION__, __LINE__);
1591         } elseif (!isInstallationPhase()) {
1592                 // No database link
1593                 reportBug(__FUNCTION__, __LINE__, 'Database link is already down, while shutdown is running.');
1594         }
1595
1596         // Stop executing here
1597         exit;
1598 }
1599
1600 // Init member id
1601 function initMemberId () {
1602         $GLOBALS['member_id'] = '0';
1603 }
1604
1605 // Setter for member id
1606 function setMemberId ($memberid) {
1607         // We should not set member id to zero
1608         if ($memberid == '0') {
1609                 reportBug(__FUNCTION__, __LINE__, 'Userid should not be set zero.');
1610         } // END - if
1611
1612         // Set it secured
1613         $GLOBALS['member_id'] = bigintval($memberid);
1614 }
1615
1616 // Getter for member id or returns zero
1617 function getMemberId () {
1618         // Default member id
1619         $memberid = '0';
1620
1621         // Is the member id set?
1622         if (isMemberIdSet()) {
1623                 // Then use it
1624                 $memberid = $GLOBALS['member_id'];
1625         } // END - if
1626
1627         // Return it
1628         return $memberid;
1629 }
1630
1631 // Checks ether the member id is set
1632 function isMemberIdSet () {
1633         return (isset($GLOBALS['member_id']));
1634 }
1635
1636 // Setter for extra title
1637 function setExtraTitle ($extraTitle) {
1638         $GLOBALS['extra_title'] = $extraTitle;
1639 }
1640
1641 // Getter for extra title
1642 function getExtraTitle () {
1643         // Is the extra title set?
1644         if (!isExtraTitleSet()) {
1645                 // No, then abort here
1646                 reportBug(__FUNCTION__, __LINE__, 'extra_title is not set!');
1647         } // END - if
1648
1649         // Return it
1650         return $GLOBALS['extra_title'];
1651 }
1652
1653 // Checks if the extra title is set
1654 function isExtraTitleSet () {
1655         return ((isset($GLOBALS['extra_title'])) && (!empty($GLOBALS['extra_title'])));
1656 }
1657
1658 /**
1659  * Reads a directory recursively by default and searches for files not matching
1660  * an exclusion pattern. You can now keep the exclusion pattern empty for reading
1661  * a whole directory.
1662  *
1663  * @param       $baseDir                        Relative base directory to PATH to scan from
1664  * @param       $prefix                         Prefix for all positive matches (which files should be found)
1665  * @param       $fileIncludeDirs        whether to include directories in the final output array
1666  * @param       $addBaseDir                     whether to add $baseDir to all array entries
1667  * @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'
1668  * @param       $extension                      File extension for all positive matches
1669  * @param       $excludePattern         Regular expression to exclude more files (preg_match())
1670  * @param       $recursive                      whether to scan recursively
1671  * @param       $suffix                         Suffix for positive matches ($extension will be appended, too)
1672  * @return      $foundMatches           All found positive matches for above criteria
1673  */
1674 function getArrayFromDirectory ($baseDir, $prefix, $fileIncludeDirs = FALSE, $addBaseDir = TRUE, $excludeArray = array(), $extension = '.php', $excludePattern = '@(\.|\.\.)$@', $recursive = TRUE, $suffix = '') {
1675         // Add default entries we should always exclude
1676         array_unshift($excludeArray, '.', '..', '.svn', '.htaccess');
1677
1678         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'baseDir=' . $baseDir . ',prefix=' . $prefix . ' - Entered!');
1679         // Init found includes
1680         $foundMatches = array();
1681
1682         // Open directory
1683         $dirPointer = opendir(getPath() . $baseDir) or reportBug(__FUNCTION__, __LINE__, 'Cannot read directory ' . basename($baseDir) . '.');
1684
1685         // Read all entries
1686         while ($baseFile = readdir($dirPointer)) {
1687                 // Exclude '.', '..' and entries in $excludeArray automatically
1688                 if (in_array($baseFile, $excludeArray, TRUE))  {
1689                         // Exclude them
1690                         //* DEBUG: */ debugOutput('excluded=' . $baseFile);
1691                         continue;
1692                 } // END - if
1693
1694                 // Construct include filename and FQFN
1695                 $fileName = $baseDir . $baseFile;
1696                 $FQFN = getPath() . $fileName;
1697
1698                 // Remove double slashes
1699                 $FQFN = str_replace('//', '/', $FQFN);
1700
1701                 // Check if the base filenname matches an exclusion pattern and if the pattern is not empty
1702                 if ((!empty($excludePattern)) && (preg_match($excludePattern, $baseFile, $match))) {
1703                         // Debug message
1704                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'baseDir=' . $baseDir . ',baseFile=' . $baseFile . ',FQFN=' . $FQFN);
1705
1706                         // Exclude this one
1707                         continue;
1708                 } // END - if
1709
1710                 // Skip also files with non-matching prefix genericly
1711                 if (($recursive === TRUE) && (isDirectory($FQFN))) {
1712                         // Is a redirectory so read it as well
1713                         $foundMatches = merge_array($foundMatches, getArrayFromDirectory($baseDir . $baseFile . '/', $prefix, $fileIncludeDirs, $addBaseDir, $excludeArray, $extension, $excludePattern, $recursive));
1714
1715                         // And skip further processing
1716                         continue;
1717                 } elseif (!isFilePrefixFound($baseFile, $prefix)) {
1718                         // Skip this file
1719                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Invalid prefix in file ' . $baseFile . ', prefix=' . $prefix);
1720                         continue;
1721                 } elseif ((!empty($suffix)) && (substr($baseFile, -(strlen($suffix . $extension)), (strlen($suffix . $extension))) != $suffix . $extension)) {
1722                         // Skip wrong suffix as well
1723                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Invalid suffix in file ' . $baseFile . ', suffix=' . $suffix);
1724                         continue;
1725                 } elseif (!isFileReadable($FQFN)) {
1726                         // Not readable so skip it
1727                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File ' . $FQFN . ' is not readable!');
1728                 } elseif (filesize($FQFN) < 50) {
1729                         // Might be deprecated
1730                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File ' . $FQFN . ' is to small (' . filesize($FQFN) . ')!');
1731                         continue;
1732                 } elseif (($extension == '.php') && (filesize($FQFN) < 50)) {
1733                         // This PHP script is deprecated
1734                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File ' . $FQFN . ' is a deprecated PHP script!');
1735                         continue;
1736                 }
1737
1738                 // Get file' extension (last 4 chars)
1739                 $fileExtension = substr($baseFile, -4, 4);
1740
1741                 // Is the file a PHP script or other?
1742                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'baseDir=' . $baseDir . ',prefix=' . $prefix . ',baseFile=' . $baseFile);
1743                 if (($fileExtension == '.php') || (($fileIncludeDirs === TRUE) && (isDirectory($FQFN)))) {
1744                         // Is this a valid include file?
1745                         if ($extension == '.php') {
1746                                 // Remove both for extension name
1747                                 $extName = substr($baseFile, strlen($prefix), -4);
1748
1749                                 // Add file with or without base path
1750                                 if ($addBaseDir === TRUE) {
1751                                         // With base path
1752                                         array_push($foundMatches, $fileName);
1753                                 } else {
1754                                         // No base path
1755                                         array_push($foundMatches, $baseFile);
1756                                 }
1757                         } else {
1758                                 // We found .php file but should not search for them, why?
1759                                 reportBug(__FUNCTION__, __LINE__, 'We should find files with extension=' . $extension . ', but we found a PHP script. (baseFile=' . $baseFile . ')');
1760                         }
1761                 } elseif ($fileExtension == $extension) {
1762                         // Other, generic file found
1763                         array_push($foundMatches, $fileName);
1764                 }
1765         } // END - while
1766
1767         // Close directory
1768         closedir($dirPointer);
1769
1770         // Sort array
1771         sort($foundMatches);
1772
1773         // Return array with include files
1774         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Left!');
1775         return $foundMatches;
1776 }
1777
1778 // Checks whether $prefix is found in $fileName
1779 function isFilePrefixFound ($fileName, $prefix) {
1780         // @TODO Find a way to cache this
1781         return (substr($fileName, 0, strlen($prefix)) == $prefix);
1782 }
1783
1784 // Maps a module name into a database table name
1785 function mapModuleToTable ($moduleName) {
1786         // Map only these, still lame code...
1787         switch ($moduleName) {
1788                 case 'index': // 'index' is the guest's menu
1789                         $moduleName = 'guest';
1790                         break;
1791
1792                 case 'login': // ... and 'login' the member's menu
1793                         $moduleName = 'member';
1794                         break;
1795
1796                 // Anything else will not be mapped, silently.
1797         } // END - switch
1798
1799         // Return result
1800         return $moduleName;
1801 }
1802
1803 // Add SQL debug data to array for later output
1804 function addSqlToDebug ($result, $sqlString, $timing, $F, $L) {
1805         // Is there cache?
1806         if (!isset($GLOBALS['debug_sql_available'])) {
1807                 // Check it and cache it in $GLOBALS
1808                 $GLOBALS['debug_sql_available'] = ((isConfigurationLoaded()) && (isDisplayDebugSqlEnabled()));
1809         } // END - if
1810
1811         // Don't execute anything here if we don't need or ext-other is missing
1812         if ($GLOBALS['debug_sql_available'] === FALSE) {
1813                 return;
1814         } // END - if
1815
1816         // Already executed?
1817         if (isset($GLOBALS['debug_sqls'][$F][$L][$sqlString])) {
1818                 // Then abort here, we don't need to profile a query twice
1819                 return;
1820         } // END - if
1821
1822         // Remeber this as profiled (or not, but we don't care here)
1823         $GLOBALS['debug_sqls'][$F][$L][$sqlString] = TRUE;
1824
1825         // Generate record
1826         $record = array(
1827                 'num_rows' => SQL_NUMROWS($result),
1828                 'affected' => SQL_AFFECTEDROWS(),
1829                 'sql_str'  => $sqlString,
1830                 'timing'   => $timing,
1831                 'file'     => basename($F),
1832                 'line'     => $L
1833         );
1834
1835         // Add it
1836         array_push($GLOBALS['debug_sqls'], $record);
1837 }
1838
1839 // Initializes the cache instance
1840 function initCacheInstance () {
1841         // Check for double-initialization
1842         if (isset($GLOBALS['cache_instance'])) {
1843                 // This should not happen and must be fixed
1844                 reportBug(__FUNCTION__, __LINE__, 'Double initialization of cache system detected. cache_instance[]=' . gettype($GLOBALS['cache_instance']));
1845         } // END - if
1846
1847         // Load include for CacheSystem class
1848         loadIncludeOnce('inc/classes/cachesystem.class.php');
1849
1850         // Initialize cache system only when it's needed
1851         $GLOBALS['cache_instance'] = new CacheSystem();
1852
1853         // Did it work?
1854         if ($GLOBALS['cache_instance']->getStatusCode() != 'done') {
1855                 // Failed to initialize cache sustem
1856                 reportBug(__FUNCTION__, __LINE__, 'Cache system returned with unexpected error. getStatusCode()=' . $GLOBALS['cache_instance']->getStatusCode());
1857         } // END - if
1858 }
1859
1860 // Getter for message from array or raw message
1861 function getMessageFromIndexedArray ($message, $pos, $array) {
1862         // Check if the requested message was found in array
1863         if (isset($array[$pos])) {
1864                 // ... if yes then use it!
1865                 $ret = $array[$pos];
1866         } else {
1867                 // ... else use default message
1868                 $ret = $message;
1869         }
1870
1871         // Return result
1872         return $ret;
1873 }
1874
1875 // Convert ';' to ', ' for e.g. receiver list
1876 function convertReceivers ($old) {
1877         return str_replace(';', ', ', $old);
1878 }
1879
1880 // Get a module from filename and access level
1881 function getModuleFromFileName ($file, $accessLevel) {
1882         // Default is 'invalid';
1883         $modCheck = 'invalid';
1884
1885         // @TODO This is still very static, rewrite it somehow
1886         switch ($accessLevel) {
1887                 case 'admin':
1888                         $modCheck = 'admin';
1889                         break;
1890
1891                 case 'sponsor':
1892                 case 'guest':
1893                 case 'member':
1894                         $modCheck = getModule();
1895                         break;
1896
1897                 default: // Unsupported file name / access level
1898                         reportBug(__FUNCTION__, __LINE__, 'Unsupported file name=' . basename($file) . '/access level=' . $accessLevel);
1899                         break;
1900         } // END - switch
1901
1902         // Return result
1903         return $modCheck;
1904 }
1905
1906 // Encodes an URL for adding session id, etc.
1907 function encodeUrl ($url, $outputMode = '0') {
1908         // Is there already have a PHPSESSID inside or view.php is called? Then abort here
1909         if ((isInStringIgnoreCase(session_name(), $url)) || (isRawOutputMode())) {
1910                 // Raw output mode detected or session_name() found in URL
1911                 return $url;
1912         } // END - if
1913
1914         // Is there a valid session?
1915         if (((!isset($GLOBALS['valid_session'])) || ($GLOBALS['valid_session'] === FALSE) || (!isset($_COOKIE[session_name()]))) && (isSpider() === FALSE)) {
1916                 // Determine right separator
1917                 $separator = '&amp;';
1918                 if (!isInString('?', $url)) {
1919                         // No question mark
1920                         $separator = '?';
1921                 } // END - if
1922
1923                 // Is the session id set?
1924                 if (session_id() != '') {
1925                         // Then add it to URL
1926                         $url .= $separator . session_name() . '=' . session_id();
1927                 } // END - if
1928         } // END - if
1929
1930         // Add {?URL?} ?
1931         if ((substr($url, 0, strlen(getUrl())) != getUrl()) && (substr($url, 0, 7) != '{?URL?}') && (substr($url, 0, 7) != 'http://') && (substr($url, 0, 8) != 'https://')) {
1932                 // Add it
1933                 $url = '{?URL?}/' . $url;
1934         } // END - if
1935
1936         // Debug message
1937         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ',isHtmlOutputMode()=' . intval(isHtmlOutputMode()) . ',outputMode=' . $outputMode);
1938
1939         // Is there to decode entities?
1940         if ((!isHtmlOutputMode()) || ($outputMode != '0')) {
1941                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ' - BEFORE DECODING');
1942                 // Decode them for e.g. JavaScript parts
1943                 $url = decodeEntities($url);
1944                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ' - AFTER DECODING');
1945         } // END - if
1946
1947         // Debug log
1948         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'url=' . $url . ',outputMode=' . $outputMode);
1949
1950         // Return the encoded URL
1951         return $url;
1952 }
1953
1954 // Simple check for spider
1955 function isSpider () {
1956         // Get the UA and trim it down
1957         $userAgent = trim(detectUserAgent(TRUE));
1958
1959         // It should not be empty, if so it is better a spider/bot
1960         if (empty($userAgent)) {
1961                 // It is a spider/bot
1962                 return TRUE;
1963         } // END - if
1964
1965         // Is it a spider?
1966         return ((isInStringIgnoreCase('spider', $userAgent)) || (isInStringIgnoreCase('slurp', $userAgent)) || (isInStringIgnoreCase('bot', $userAgent)) || (isInStringIgnoreCase('archiver', $userAgent)));
1967 }
1968
1969 // Function to search for the last modified file
1970 function searchDirsRecursive ($dir, &$last_changed, $lookFor = 'Date') {
1971         // Get dir as array
1972         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dir=' . $dir);
1973         // Does it match what we are looking for? (We skip a lot files already!)
1974         // RegexPattern to exclude  ., .., .revision,  .svn, debug.log or .cache in the filenames
1975         $excludePattern = '@(\.revision|\.svn|debug\.log|\.cache|config\.php)$@';
1976
1977         $ds = getArrayFromDirectory($dir, '', FALSE, TRUE, array(), '.php', $excludePattern);
1978         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count(ds)='.count($ds));
1979
1980         // Walk through all entries
1981         foreach ($ds as $d) {
1982                 // Generate proper FQFN
1983                 $FQFN = str_replace('//', '/', getPath() . $dir . '/' . $d);
1984
1985                 // Is it a file and readable?
1986                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dir=' . $dir . ',d=' . $d);
1987                 if (isFileReadable($FQFN)) {
1988                         // $FQFN is a readable file so extract the requested data from it
1989                         $check = extractRevisionInfoFromFile($FQFN, $lookFor);
1990                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File: ' . $d . ' found. check=' . $check);
1991
1992                         // Is the file more recent?
1993                         if ((!isset($last_changed[$lookFor])) || ($last_changed[$lookFor] < $check)) {
1994                                 // This file is newer as the file before
1995                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'NEWER!');
1996                                 $last_changed['path_name'] = $FQFN;
1997                                 $last_changed[$lookFor] = $check;
1998                         } // END - if
1999                 } else {
2000                         // Not readable
2001                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File: ' . $d . ' not readable or directory.');
2002                 }
2003         } // END - foreach
2004 }
2005
2006 // Handles the braces [] of a field (e.g. value of 'name' attribute)
2007 function handleFieldWithBraces ($field) {
2008         // Are there braces [] at the end?
2009         if (substr($field, -2, 2) == '[]') {
2010                 /*
2011                  * Try to find one and replace it. I do it this way to allow easy
2012                  * extending of this code.
2013                  */
2014                 foreach (array('admin_list_builder_id_value') as $key) {
2015                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key);
2016                         // Is the cache entry set?
2017                         if (isset($GLOBALS[$key])) {
2018                                 // Insert it
2019                                 $field = str_replace('[]', '[' . $GLOBALS[$key] . ']', $field);
2020
2021                                 // And abort
2022                                 /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key, 'field=' . $field);
2023                                 break;
2024                         } // END - if
2025                 } // END - foreach
2026         } // END - if
2027
2028         // Return it
2029         return $field;
2030 }
2031
2032 // Converts a zero or NULL to word 'NULL'
2033 function convertZeroToNull ($number) {
2034         // Is it a valid username?
2035         if ((!is_null($number)) && (!empty($number)) && ($number > 0)) {
2036                 // Always secure it
2037                 $number = bigintval($number);
2038         } else {
2039                 // Is not valid or zero
2040                 $number = 'NULL';
2041         }
2042
2043         // Return it
2044         return $number;
2045 }
2046
2047 // Converts a NULL to zero
2048 function convertNullToZero ($number) {
2049         // Is it a valid username?
2050         if ((!is_null($number)) && (!empty($number)) && ($number > 0)) {
2051                 // Always secure it
2052                 $number = bigintval($number);
2053         } else {
2054                 // Is not valid or zero
2055                 $number = '0';
2056         }
2057
2058         // Return it
2059         return $number;
2060 }
2061
2062 // Capitalizes a string with underscores, e.g.: some_foo_string will become SomeFooString
2063 // Note: This function is cached
2064 function capitalizeUnderscoreString ($str) {
2065         // Is there cache?
2066         if (!isset($GLOBALS[__FUNCTION__][$str])) {
2067                 // Init target string
2068                 $capitalized = '';
2069
2070                 // Explode it with the underscore, but rewrite dashes to underscore before
2071                 $strArray = explode('_', str_replace('-', '_', $str));
2072
2073                 // "Walk" through all elements and make them lower-case but first upper-case
2074                 foreach ($strArray as $part) {
2075                         // Capitalize the string part
2076                         $capitalized .= firstCharUpperCase($part);
2077                 } // END - foreach
2078
2079                 // Store the converted string in cache array
2080                 $GLOBALS[__FUNCTION__][$str] = $capitalized;
2081         } // END - if
2082
2083         // Return cache
2084         return $GLOBALS[__FUNCTION__][$str];
2085 }
2086
2087 // Generate admin links for mail order
2088 // mailType can be: 'mid' or 'bid'
2089 function generateAdminMailLinks ($mailType, $mailId) {
2090         // Init variables
2091         $OUT = '';
2092         $table = '';
2093
2094         // Default column for mail status is 'data_type'
2095         // @TODO Rename column data_type to e.g. mail_status
2096         $statusColumn = 'data_type';
2097
2098         // Which mail do we have?
2099         switch ($mailType) {
2100                 case 'bid': // Bonus mail
2101                         $table = 'bonus';
2102                         break;
2103
2104                 case 'mid': // Member mail
2105                         $table = 'pool';
2106                         break;
2107
2108                 default: // Handle unsupported types
2109                         logDebugMessage(__FUNCTION__, __LINE__, 'Unsupported mail type ' . $mailType . ' for mailId=' . $mailId . ' detected.');
2110                         $OUT = '<div align="center">{%message,ADMIN_UNSUPPORTED_MAIL_TYPE_DETECTED=' . $mailType . '%}</div>';
2111                         break;
2112         } // END - switch
2113
2114         // Is the mail type supported?
2115         if (!empty($table)) {
2116                 // Query for the mail
2117                 $result = SQL_QUERY_ESC("SELECT `id`, `%s` AS `mail_status` FROM `{?_MYSQL_PREFIX?}_%s` WHERE `id`=%s LIMIT 1",
2118                         array(
2119                                 $statusColumn,
2120                                 $table,
2121                                 bigintval($mailId)
2122                         ), __FILE__, __LINE__);
2123
2124                 // Is there one entry there?
2125                 if (SQL_NUMROWS($result) == 1) {
2126                         // Load the entry
2127                         $content = SQL_FETCHARRAY($result);
2128
2129                         // Add output and type
2130                         $content['type']     = $mailType;
2131                         $content['__output'] = '';
2132
2133                         // Filter all data
2134                         $content = runFilterChain('generate_admin_mail_links', $content);
2135
2136                         // Get output back
2137                         $OUT = $content['__output'];
2138                 } // END - if
2139
2140                 // Free result
2141                 SQL_FREERESULT($result);
2142         } // END - if
2143
2144         // Return generated HTML code
2145         return $OUT;
2146 }
2147
2148
2149 /**
2150  * Determine if a string can represent a number in hexadecimal
2151  *
2152  * @param       $hex    A string to check if it is hex-encoded
2153  * @return      $foo    True if the string is a hex, otherwise false
2154  * @author      Marques Johansson
2155  * @link        http://php.net/manual/en/function.http-chunked-decode.php#89786
2156  */
2157 function isHexadecimal ($hex) {
2158         // Make it lowercase
2159         $hex = strtolower(trim(ltrim($hex, '0')));
2160
2161         // Fix empty strings to zero
2162         if (empty($hex)) {
2163                 $hex = 0;
2164         } // END - if
2165
2166         // Simply compare decode->encode result with original
2167         return ($hex == dechex(hexdec($hex)));
2168 }
2169
2170 /**
2171  * Replace chr(13) with "[r]" and chr(10) with "[n]" and add a final new-line to make
2172  * them visible to the developer. Use this function to debug e.g. buggy HTTP
2173  * response handler functions.
2174  *
2175  * @param       $str    String to overwork
2176  * @return      $str    Overworked string
2177  */
2178 function replaceReturnNewLine ($str) {
2179         return str_replace(array(chr(13), chr(10)), array('[r]', '[n]'), $str);
2180 }
2181
2182 // Converts a given string by splitting it up with given delimiter similar to
2183 // explode(), but appending the delimiter again
2184 function stringToArray ($delimiter, $string) {
2185         // Init array
2186         $strArray = array();
2187
2188         // "Walk" through all entries
2189         foreach (explode($delimiter, $string) as $split) {
2190                 //  Append the delimiter and add it to the array
2191                 array_push($strArray, $split . $delimiter);
2192         } // END - foreach
2193
2194         // Return array
2195         return $strArray;
2196 }
2197
2198 // Detects the prefix 'mb_' if a multi-byte string is given
2199 function detectMultiBytePrefix ($str) {
2200         // Default is without multi-byte
2201         $mbPrefix = '';
2202
2203         // Detect multi-byte (strictly)
2204         if (mb_detect_encoding($str, 'auto', TRUE) !== FALSE) {
2205                 // With multi-byte encoded string
2206                 $mbPrefix = 'mb_';
2207         } // END - if
2208
2209         // Return the prefix
2210         return $mbPrefix;
2211 }
2212
2213 // Searches given array for a sub-string match and returns all found keys in an array
2214 function getArrayKeysFromSubStrArray ($heystack, $needles, $offset = 0) {
2215         // Init array for all found keys
2216         $keys = array();
2217
2218         // Now check all entries
2219         foreach ($needles as $key => $needle) {
2220                 // Is there found a partial string?
2221                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'heystack='.$heystack.',key='.$key.',needle='.$needle.',offset='.$offset);
2222                 if (strpos($heystack, $needle, $offset) !== FALSE) {
2223                         // Add the found key
2224                         array_push($keys, $key);
2225                 } // END - if
2226         } // END - foreach
2227
2228         // Return the array
2229         return $keys;
2230 }
2231
2232 // Determines database column name from given subject and locked
2233 function determinePointsColumnFromSubjectLocked ($subject, $locked) {
2234         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',locked=' . intval($locked) . ' - ENTERED!');
2235         // Default is 'normal' points
2236         $pointsColumn = 'points';
2237
2238         // Which points, locked or normal?
2239         if ($locked === TRUE) {
2240                 $pointsColumn = 'locked_points';
2241         } // END - if
2242
2243         // Prepare array for filter
2244         $filterData = array(
2245                 'subject' => $subject,
2246                 'locked'  => $locked,
2247                 'column'  => $pointsColumn
2248         );
2249
2250         // Run the filter
2251         $filterData = runFilterChain('determine_points_column_name', $filterData);
2252
2253         // Extract column name from array
2254         $pointsColumn = $filterData['column'];
2255
2256         // Return it
2257         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',locked=' . intval($locked) . ',pointsColumn=' . $pointsColumn . ' - EXIT!');
2258         return $pointsColumn;
2259 }
2260
2261 // Converts a boolean variable into 'Y' for true and 'N' for false
2262 function convertBooleanToYesNo ($boolean) {
2263         // Default is 'N'
2264         $converted = 'N';
2265         if ($boolean === TRUE) {
2266                 // Set 'Y'
2267                 $converted = 'Y';
2268         } // END - if
2269
2270         // Return it
2271         return $converted;
2272 }
2273
2274 // "Translates" 'true' to true and 'false' to false
2275 function convertStringToBoolean ($str) {
2276         // Debug message (to measure how often this function is called)
2277         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'str=' . $str);
2278
2279         // Is there cache?
2280         if (!isset($GLOBALS[__FUNCTION__][$str])) {
2281                 // Trim it lower-case for validation
2282                 $strTrimmed = trim(strtolower($str));
2283
2284                 // Is it valid?
2285                 if (!in_array($strTrimmed, array('true', 'false'))) {
2286                         // Not valid!
2287                         reportBug(__FUNCTION__, __LINE__, 'str=' . $str . '(' . $strTrimmed . ') is not true/false');
2288                 } // END - if
2289
2290                 // Determine it
2291                 $GLOBALS[__FUNCTION__][$str] = (($strTrimmed == 'true') ? true : false);
2292         } // END - if
2293
2294         // Return cache
2295         return $GLOBALS[__FUNCTION__][$str];
2296 }
2297
2298 /**
2299  * "Makes" a variable in given string parseable, this function will throw an
2300  * error if the first character is not a dollar sign.
2301  *
2302  * @param       $varString      String which contains a variable
2303  * @return      $return         String with added single quotes for better parsing
2304  */
2305 function makeParseableVariable ($varString) {
2306         // The first character must be a dollar sign
2307         if (substr($varString, 0, 1) != '$') {
2308                 // Please report this
2309                 reportBug(__FUNCTION__, __LINE__, 'varString=' . $varString . ' - No dollar sign detected, will not parse it.');
2310         } // END - if
2311
2312         // Is there cache?
2313         if (!isset($GLOBALS[__FUNCTION__][$varString])) {
2314                 // Snap them in, if [,] are there
2315                 $GLOBALS[__FUNCTION__][$varString] = str_replace(array('[', ']'), array("['", "']"), $varString);
2316         } // END - if
2317
2318         // Return cache
2319         return $GLOBALS[__FUNCTION__][$varString];
2320 }
2321
2322 // "Getter" for random TAN
2323 function getRandomTan () {
2324         // Generate one
2325         return mt_rand(0, 99999);
2326 }
2327
2328 // Removes any : from subject
2329 function removeDoubleDotFromSubject ($subject) {
2330         // Remove it
2331         $subjectArray = explode(':', $subject);
2332         $subject = $subjectArray[0];
2333         unset($subjectArray);
2334
2335         // Return it
2336         return $subject;
2337 }
2338
2339 // Adds a given entry to the database
2340 function memberAddEntries ($tableName, $columns = array(), $filterFunctions = array(), $extraValues = array(), $timeColumns = array(), $columnIndex = NULL) {
2341         // Is it a member?
2342         if (!isMember()) {
2343                 // Then abort here
2344                 return FALSE;
2345         } // END - if
2346
2347         // Set POST data generic userid
2348         setPostRequestElement('userid', getMemberId());
2349
2350         // Call inner function
2351         doGenericAddEntries($tableName, $columns, $filterFunctions, $extraValues, $timeColumns, $columnIndex);
2352
2353         // Entry has been added?
2354         if ((!SQL_HASZEROAFFECTED()) && ($GLOBALS['__XML_PARSE_RESULT'] === TRUE)) {
2355                 // Display success message
2356                 displayMessage('{--MEMBER_ENTRY_ADDED--}');
2357         } else {
2358                 // Display failed message
2359                 displayMessage('{--MEMBER_ENTRY_NOT_ADDED--}');
2360         }
2361 }
2362
2363 // Edit rows by given id numbers
2364 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()) {
2365         // $tableName must be an array
2366         if ((!is_array($tableName)) || (count($tableName) != 1)) {
2367                 // No tableName specified
2368                 reportBug(__FUNCTION__, __LINE__, 'tableName is not given. Please fix your XML,tableName[]=' . gettype($tableName) . '!=array: userIdColumn=' . $userIdColumn);
2369         } elseif (!is_array($idColumn)) {
2370                 // $idColumn is no array
2371                 reportBug(__FUNCTION__, __LINE__, 'idColumn[]=' . gettype($idColumn) . '!=array: userIdColumn=' . $userIdColumn);
2372         } elseif (!is_array($userIdColumn)) {
2373                 // $userIdColumn is no array
2374                 reportBug(__FUNCTION__, __LINE__, 'userIdColumn[]=' . gettype($userIdColumn) . '!=array: userIdColumn=' . $userIdColumn);
2375         } elseif (!is_array($editNow)) {
2376                 // $editNow is no array
2377                 reportBug(__FUNCTION__, __LINE__, 'editNow[]=' . gettype($editNow) . '!=array: userIdColumn=' . $userIdColumn);
2378         } // END - if
2379
2380         // Shall we change here or list for editing?
2381         if ($editNow[0] === TRUE) {
2382                 // Add generic userid field
2383                 setPostRequestElement('userid', getMemberId());
2384
2385                 // Call generic change method
2386                 $affected = doGenericEditEntriesConfirm($tableName, $columns, $filterFunctions, $extraValues, $timeColumns, $editNow, $idColumn, $userIdColumn, $rawUserId, $cacheFiles, 'mem_edit');
2387
2388                 // Was this fine?
2389                 if ($affected == countPostSelection($idColumn[0])) {
2390                         // All deleted
2391                         displayMessage('{--MEMBER_ALL_ENTRIES_EDITED--}');
2392                 } else {
2393                         // Some are still there :(
2394                         displayMessage(sprintf(getMessage('MEMBER_SOME_ENTRIES_NOT_EDITED'), $affected, countPostSelection($idColumn[0])));
2395                 }
2396         } else {
2397                 // List for editing
2398                 memberListBuilder('edit', $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn);
2399         }
2400 }
2401
2402 // Delete rows by given id numbers
2403 function memberDeleteEntriesConfirm ($tableName, $columns = array(), $filterFunctions = array(), $extraValues = array(), $deleteNow = array(FALSE), $idColumn = array('id'), $userIdColumn = array('userid'), $rawUserId = array('userid'), $cacheFiles = array()) {
2404         // Do this only for members
2405         assert(isMember());
2406
2407         // $tableName must be an array
2408         if ((!is_array($tableName)) || (count($tableName) != 1)) {
2409                 // No tableName specified
2410                 reportBug(__FUNCTION__, __LINE__, 'tableName is not given. Please fix your XML,tableName[]=' . gettype($tableName) . '!=array: userIdColumn=' . $userIdColumn);
2411         } elseif (!is_array($idColumn)) {
2412                 // $idColumn is no array
2413                 reportBug(__FUNCTION__, __LINE__, 'idColumn[]=' . gettype($idColumn) . '!=array: userIdColumn=' . $userIdColumn);
2414         } elseif (!is_array($userIdColumn)) {
2415                 // $userIdColumn is no array
2416                 reportBug(__FUNCTION__, __LINE__, 'userIdColumn[]=' . gettype($userIdColumn) . '!=array: userIdColumn=' . $userIdColumn);
2417         } elseif (!is_array($deleteNow)) {
2418                 // $deleteNow is no array
2419                 reportBug(__FUNCTION__, __LINE__, 'deleteNow[]=' . gettype($deleteNow) . '!=array: userIdColumn=' . $userIdColumn);
2420         } // END - if
2421
2422         // Shall we delete here or list for deletion?
2423         if ($deleteNow[0] === TRUE) {
2424                 // Add generic userid field
2425                 setPostRequestElement('userid', getMemberId());
2426
2427                 // Call generic function
2428                 $affected = doGenericDeleteEntriesConfirm($tableName, $columns, $filterFunctions, $extraValues, $deleteNow, $idColumn, $userIdColumn, $rawUserId, $cacheFiles, 'mem_delete');
2429
2430                 // Was this fine?
2431                 if ($affected == countPostSelection($idColumn[0])) {
2432                         // All deleted
2433                         displayMessage('{--MEMBER_ALL_ENTRIES_REMOVED--}');
2434                 } else {
2435                         // Some are still there :(
2436                         displayMessage(sprintf(getMessage('MEMBER_SOME_ENTRIES_NOT_DELETED'), SQL_AFFECTEDROWS(), countPostSelection($idColumn[0])));
2437                 }
2438         } else {
2439                 // List for deletion confirmation
2440                 memberListBuilder('delete', $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn);
2441         }
2442 }
2443
2444 // Build a special template list
2445 function memberListBuilder ($listType, $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn, $rawUserId = array('userid')) {
2446         // Do this only for logged in member
2447         assert(isMember());
2448
2449         // Call inner (general) function
2450         doGenericListBuilder('member', $listType, $tableName, $columns, $filterFunctions, $extraValues, $idColumn, $userIdColumn, $rawUserId);
2451 }
2452
2453 // Checks whether given address is IPv4
2454 function isIp4AddressValid ($address) {
2455         // Is there cache?
2456         if (!isset($GLOBALS[__FUNCTION__][$address])) {
2457                 // Determine it ...
2458                 $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);
2459         } // END - if
2460
2461         // Return cache
2462         return $GLOBALS[__FUNCTION__][$address];
2463 }
2464
2465 // Returns the string if not empty or FALSE if empty
2466 function validateIsEmpty ($str) {
2467         // Trim it
2468         $trimmed = trim($str);
2469
2470         // Is the string empty?
2471         if (empty($trimmed)) {
2472                 // Then set FALSE
2473                 $str = FALSE;
2474         } // END - if
2475
2476         // Return it
2477         return $str;
2478 }
2479
2480 // ----------------------------------------------------------------------------
2481 //              "Translatation" functions for points_data table
2482 // ----------------------------------------------------------------------------
2483
2484 // Translates generically some data into a target string
2485 function translateGeneric ($messagePrefix, $data) {
2486         // Is the method null or empty?
2487         if (is_null($data)) {
2488                 // Is NULL
2489                 $data = 'NULL';
2490         } elseif (empty($data)) {
2491                 // Is empty (string)
2492                 $data = 'EMPTY';
2493         } // END - if
2494
2495         // Default column name is unknown
2496         $return = '{%message,' . $messagePrefix . '_UNKNOWN=' . strtoupper($data) . '%}';
2497
2498         // Construct message id
2499         $messageId = $messagePrefix . '_' . strtoupper($data);
2500
2501         // Is it there?
2502         if (isMessageIdValid($messageId)) {
2503                 // Then use it as message string
2504                 $return = '{--' . $messageId . '--}';
2505         } // END - if
2506
2507         // Return the column name
2508         return $return;
2509 }
2510
2511 // Translates points subject to human-readable
2512 function translatePointsSubject ($subject) {
2513         // Remove any :x
2514         $subject = removeDoubleDotFromSubject($subject);
2515
2516         // Return it
2517         return translateGeneric('POINTS_SUBJECT', $subject);
2518 }
2519
2520 // "Translates" given points account type
2521 function translatePointsAccountType ($accountType) {
2522         // Return it
2523         return translateGeneric('POINTS_ACCOUNT_TYPE', $accountType);
2524 }
2525
2526 // "Translates" given points "locked mode"
2527 function translatePointsLockedMode ($lockedMode) {
2528         // Return it
2529         return translateGeneric('POINTS_LOCKED_MODE', $lockedMode);
2530 }
2531
2532 // "Translates" given points payment method
2533 function translatePointsPaymentMethod ($paymentMethod) {
2534         // Return it
2535         return translateGeneric('POINTS_PAYMENT_METHOD', $paymentMethod);
2536 }
2537
2538 // "Translates" given points account provider
2539 function translatePointsAccountProvider ($accountProvider) {
2540         // Return it
2541         return translateGeneric('POINTS_ACCOUNT_PROVIDER', $accountProvider);
2542 }
2543
2544 // "Translates" given points notify recipient
2545 function translatePointsNotifyRecipient ($notifyRecipient) {
2546         // Return it
2547         return translateGeneric('POINTS_NOTIFY_RECIPIENT', $notifyRecipient);
2548 }
2549
2550 // "Translates" given mode to a human-readable version
2551 function translatePointsMode ($pointsMode) {
2552         // Return it
2553         return translateGeneric('POINTS_MODE', $pointsMode);
2554 }
2555
2556 // "Translates" task type to a human-readable version
2557 function translateTaskType ($taskType) {
2558         // Return it
2559         return translateGeneric('ADMIN_TASK_TYPE', $taskType);
2560 }
2561
2562 //-----------------------------------------------------------------------------
2563 // Automatically re-created functions, all taken from user comments on www.php.net
2564 //-----------------------------------------------------------------------------
2565 if (!function_exists('html_entity_decode')) {
2566         // Taken from documentation on www.php.net
2567         function html_entity_decode ($string) {
2568                 $trans_tbl = get_html_translation_table(HTML_ENTITIES);
2569                 $trans_tbl = array_flip($trans_tbl);
2570                 return strtr($string, $trans_tbl);
2571         }
2572 } // END - if
2573
2574 // [EOF]
2575 ?>