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