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://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 ((!isInString('@', $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    = decodeEntities($message);
 206                         $mail->WordWrap   = 70;
 207                         $mail->IsHTML(true);
 208                 } else {
 209                         $mail->Body       = decodeEntities(strip_tags($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                         } // END - switch
 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         // Is the output mode -2?
 538         if (getScriptOutputMode() == -2) {
 539                 // This is always (!) an AJAX request and shall not be redirected
 540                 return;
 541         } // END - if
 542
 543         // Remove {%url=
 544         if (substr($url, 0, 6) == '{%url=') {
 545                 $url = substr($url, 6, -2);
 546         } // END - if
 547
 548         // Compile out codes
 549         eval('$url = "' . compileRawCode(encodeUrl($url)) . '";');
 550
 551         // Default 'rel' value is external, nofollow is evil from Google and hurts the Internet
 552         $rel = ' rel="external"';
 553
 554         // Do we have internal or external URL?
 555         if (substr($url, 0, strlen(getUrl())) == getUrl()) {
 556                 // Own (=internal) URL
 557                 $rel = '';
 558         } // END - if
 559
 560         // Three different ways to debug...
 561         //* DEBUG: */ debug_report_bug(__FUNCTION__, __LINE__, 'URL=' . $url);
 562         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'URL=' . $url);
 563         //* DEBUG: */ die($url);
 564
 565         // We should not sent a redirect if headers are already sent
 566         if (!headers_sent()) {
 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         $temporaryArray = $array;
 598         while ($primary_key < count($a_sort)) {
 599                 foreach ($temporaryArray[$a_sort[$primary_key]] as $key => $value) {
 600                         foreach ($temporaryArray[$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($temporaryArray[$a_sort[$primary_key]][$key]), strtolower($temporaryArray[$a_sort[$primary_key]][$key2])) == $order)) $match = true;
 605                                 } elseif ($key != $key2) {
 606                                         // Sort numbers (E.g.: 9 < 10)
 607                                         if (($temporaryArray[$a_sort[$primary_key]][$key] < $temporaryArray[$a_sort[$primary_key]][$key2]) && ($order == -1)) $match = true;
 608                                         if (($temporaryArray[$a_sort[$primary_key]][$key] > $temporaryArray[$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 ($temporaryArray as $sort_key => $sort_val) {
 614                                                 $t                       = $temporaryArray[$sort_key][$key];
 615                                                 $temporaryArray[$sort_key][$key]  = $temporaryArray[$sort_key][$key2];
 616                                                 $temporaryArray[$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 = $temporaryArray;
 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'] . getEncryptSeparator() . detectUserAgent() . getEncryptSeparator() . getenv('SERVER_SOFTWARE') . getEncryptSeparator() . detectRealIpAddress() . getEncryptSeparator() . detectRemoteAddr();
 639
 640         // Build key string
 641         $keys = getSiteKey() . getEncryptSeparator() . getDateKey();
 642         if (isConfigEntrySet('secret_key')) {
 643                 $keys .= getEncryptSeparator() . getSecretKey();
 644         } // END - if
 645         if (isConfigEntrySet('file_hash')) {
 646                 $keys .= getEncryptSeparator() . getFileHash();
 647         } // END - if
 648         $keys .= getEncryptSeparator() . getDateFromRepository();
 649         if (isConfigEntrySet('master_salt')) {
 650                 $keys .= getEncryptSeparator() . getMasterSalt();
 651         } // END - if
 652
 653         // Build string from misc data
 654         $data  = $code . getEncryptSeparator() . $userid . getEncryptSeparator() . $extraData;
 655
 656         // Add more additional data
 657         if (isSessionVariableSet('u_hash')) {
 658                 $data .= getEncryptSeparator() . getSession('u_hash');
 659         } // END - if
 660
 661         // Add referral id, language, theme and userid
 662         $data .= getEncryptSeparator() . determineReferralId();
 663         $data .= getEncryptSeparator() . getLanguage();
 664         $data .= getEncryptSeparator() . getCurrentTheme();
 665         $data .= getEncryptSeparator() . 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()) . getEncryptSeparator() . $server . getEncryptSeparator() . $keys . getEncryptSeparator() . $data . getEncryptSeparator() . getDateKey() . getEncryptSeparator() . $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()) . getEncryptSeparator() . $server . getEncryptSeparator() . $keys . getEncryptSeparator() . $data . getEncryptSeparator() . getDateKey() . getEncryptSeparator() . $a, substr(sha1(getSiteKey()), 0, getSaltLength()));
 676         }
 677
 678         // Create number from hash
 679         $rcode = hexdec(substr($saltedHash, getSaltLength(), 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, but skip first digit (which is mostly a zero)
 693         $return = substr($rcode, (strpos($rcode, '.') + 1), $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         //* DEBUG: */ debugOutput('[' . __FUNCTION__ . ':' . __LINE__ . '] ' . 'num=' . $num . ',castValue=' . intval($castValue) . ',abortOnMismatch=' . intval($abortOnMismatch) . ' - ENTERED!');
 702         // Filter all numbers out
 703         $ret = preg_replace('/[^0123456789]/', '', $num);
 704
 705         // Shall we cast?
 706         if ($castValue === true) {
 707                 // Cast to biggest numeric type
 708                 $ret = (double) $ret;
 709         } // END - if
 710
 711         // Has the whole value changed?
 712         if (('' . $ret . '' != '' . $num . '') && ($abortOnMismatch === true) && (!is_null($num))) {
 713                 // Log the values
 714                 debug_report_bug(__FUNCTION__, __LINE__, 'Problem with number found. ret[' . gettype($ret) . ']=' . $ret . ', num[' . gettype($num) . ']='. $num);
 715         } // END - if
 716
 717         // Return result
 718         //* DEBUG: */ debugOutput('[' . __FUNCTION__ . ':' . __LINE__ . '] ' . 'num=' . $num . ',castValue=' . intval($castValue) . ',abortOnMismatch=' . intval($abortOnMismatch) . ',ret=' . $ret . ' - EXIT!');
 719         return $ret;
 720 }
 721
 722 // Creates a Uni* timestamp from given selection data and prefix
 723 function createEpocheTimeFromSelections ($prefix, $postData) {
 724         // Initial return value
 725         $ret = '0';
 726
 727         // Do we have a leap year?
 728         $SWITCH = '0';
 729         $TEST = getYear() / 4;
 730         $M1   = getMonth();
 731
 732         // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
 733         if ((floor($TEST) == $TEST) && ($M1 == '02') && ($postData[$prefix . '_mo'] > '02'))  {
 734                 $SWITCH = getOneDay();
 735         } // END - if
 736
 737         // First add years...
 738         $ret += $postData[$prefix . '_ye'] * (31536000 + $SWITCH);
 739
 740         // Next months...
 741         $ret += $postData[$prefix . '_mo'] * 2628000;
 742
 743         // Next weeks
 744         $ret += $postData[$prefix . '_we'] * 604800;
 745
 746         // Next days...
 747         $ret += $postData[$prefix . '_da'] * 86400;
 748
 749         // Next hours...
 750         $ret += $postData[$prefix . '_ho'] * 3600;
 751
 752         // Next minutes..
 753         $ret += $postData[$prefix . '_mi'] * 60;
 754
 755         // And at last seconds...
 756         $ret += $postData[$prefix . '_se'];
 757
 758         // Return calculated value
 759         return $ret;
 760 }
 761
 762 // Creates a 'fancy' human-readable timestamp from a Uni* stamp
 763 function createFancyTime ($stamp) {
 764         // Get data array with years/months/weeks/days/...
 765         $data = createTimeSelections($stamp, '', '', '', true);
 766         $ret = '';
 767         foreach ($data as $k => $v) {
 768                 if ($v > 0) {
 769                         // Value is greater than 0 "eval" data to return string
 770                         $ret .= ', ' . $v . ' {%pipe,translateTimeUnit=' . $k . '%}';
 771                         break;
 772                 } // END - if
 773         } // END - foreach
 774
 775         // Do we have something there?
 776         if (strlen($ret) > 0) {
 777                 // Remove leading commata and space
 778                 $ret = substr($ret, 2);
 779         } else {
 780                 // Zero seconds
 781                 $ret = '0 {--TIME_UNIT_SECOND--}';
 782         }
 783
 784         // Return fancy time string
 785         return $ret;
 786 }
 787
 788 // Taken from www.php.net isInStringIgnoreCase() user comments
 789 function isEmailValid ($email) {
 790         // Check first part of email address
 791         $first = '[-a-z0-9!#$%&\'*+/=?^_<{|}~]+(\.[-a-zA-Z0-9!#$%&\'*+/=?^_<{|}~]+)*';
 792
 793         //  Check domain
 794         $domain = '[a-z0-9-]+(\.[a-z0-9-]{2,5})+';
 795
 796         // Generate pattern
 797         $regex = '@^' . $first . '\@' . $domain . '$@iU';
 798
 799         // Return check result
 800         return preg_match($regex, $email);
 801 }
 802
 803 // Function taken from user comments on www.php.net / function isInStringIgnoreCase()
 804 function isUrlValid ($url, $compile = true) {
 805         // Trim URL a little
 806         $url = trim(urldecode($url));
 807         //* DEBUG: */ debugOutput($url);
 808
 809         // Compile some chars out...
 810         if ($compile === true) {
 811                 $url = compileUriCode($url, false, false, false);
 812         } // END - if
 813         //* DEBUG: */ debugOutput($url);
 814
 815         // Check for the extension filter
 816         if (isExtensionActive('filter')) {
 817                 // Use the extension's filter set
 818                 return FILTER_VALIDATE_URL($url, false);
 819         } // END - if
 820
 821         // If not installed, perform a simple test. Just make it sure there is always a http:// or
 822         // https:// in front of the URLs
 823         return isUrlValidSimple($url);
 824 }
 825
 826 // Generate a hash for extra-security for all passwords
 827 function generateHash ($plainText, $salt = '', $hash = true) {
 828         // Debug output
 829         //* DEBUG: */ debugOutput('plainText('.strlen($plainText).')=' . $plainText . ',salt('.strlen($salt).')=' . $salt . ',hash=' . intval($hash));
 830
 831         // Is the required extension 'sql_patches' there and a salt is not given?
 832         // 123                            4                      43    3     4     432    2                  3             32    2                             3                32    2      3     3      21
 833         if (((isExtensionInstalledAndOlder('sql_patches', '0.3.6')) && (empty($salt))) || (!isExtensionActive('sql_patches')) || (!isExtensionInstalledAndNewer('other', '0.2.5')) || (strlen($salt) == 32)) {
 834                 // Extension ext-sql_patches is missing/outdated so we hash the plain text with MD5
 835                 if ($hash === true) {
 836                         // Is plain password
 837                         return md5($plainText);
 838                 } else {
 839                         // Is already a hash
 840                         return $plainText;
 841                 }
 842         } // END - if
 843
 844         // Do we miss an arry element here?
 845         if (!isConfigEntrySet('file_hash')) {
 846                 // Stop here
 847                 debug_report_bug(__FUNCTION__, __LINE__, 'Missing file_hash in ' . __FUNCTION__ . '.');
 848         } // END - if
 849
 850         // When the salt is empty build a new one, else use the first x configured characters as the salt
 851         if (empty($salt)) {
 852                 // Build server string for more entropy
 853                 $server = $_SERVER['PHP_SELF'] . getEncryptSeparator() . detectUserAgent() . getEncryptSeparator() . getenv('SERVER_SOFTWARE') . getEncryptSeparator() . detectRealIpAddress() . getEncryptSeparator() . detectRemoteAddr();
 854
 855                 // Build key string
 856                 $keys   = getSiteKey() . getEncryptSeparator() . getDateKey() . getEncryptSeparator() . getSecretKey() . getEncryptSeparator() . getFileHash() . getEncryptSeparator() . getDateFromRepository() . getEncryptSeparator() . getMasterSalt();
 857
 858                 // Additional data
 859                 $data = $plainText . getEncryptSeparator() . uniqid(mt_rand(), true) . getEncryptSeparator() . time();
 860
 861                 // Calculate number for generating the code
 862                 $a = time() + getConfig('_ADD') - 1;
 863
 864                 // Generate SHA1 sum from modula of number and the prime number
 865                 $sha1 = sha1(($a % getPrime()) . $server . getEncryptSeparator() . $keys . getEncryptSeparator() . $data . getEncryptSeparator() . getDateKey() . getEncryptSeparator() . $a);
 866                 //* DEBUG: */ debugOutput('SHA1=' . $sha1.' ('.strlen($sha1).')<br />');
 867                 $sha1 = scrambleString($sha1);
 868                 //* DEBUG: */ debugOutput('Scrambled=' . $sha1.' ('.strlen($sha1).')<br />');
 869                 //* DEBUG: */ $sha1b = descrambleString($sha1);
 870                 //* DEBUG: */ debugOutput('Descrambled=' . $sha1b.' ('.strlen($sha1b).')<br />');
 871
 872                 // Generate the password salt string
 873                 $salt = substr($sha1, 0, getSaltLength());
 874                 //* DEBUG: */ debugOutput($salt.' ('.strlen($salt).')<br />');
 875         } else {
 876                 // Use given salt
 877                 //* DEBUG: */ debugOutput('salt=' . $salt);
 878                 $salt = substr($salt, 0, getSaltLength());
 879                 //* DEBUG: */ debugOutput('salt=' . $salt . '(' . strlen($salt) . '/' . getSaltLength() . ')<br />');
 880
 881                 // Sanity check on salt
 882                 if (strlen($salt) != getSaltLength()) {
 883                         // Not the same!
 884                         debug_report_bug(__FUNCTION__, __LINE__, 'salt length mismatch! (' . strlen($salt) . '/' . getSaltLength() . ')');
 885                 } // END - if
 886         }
 887
 888         // Generate final hash (for debug output)
 889         $finalHash = $salt . sha1($salt . $plainText);
 890
 891         // Debug output
 892         //* DEBUG: */ debugOutput('finalHash('.strlen($finalHash).')=' . $finalHash);
 893
 894         // Return hash
 895         return $finalHash;
 896 }
 897
 898 // Scramble a string
 899 function scrambleString ($str) {
 900         // Init
 901         $scrambled = '';
 902
 903         // Final check, in case of failure it will return unscrambled string
 904         if (strlen($str) > 40) {
 905                 // The string is to long
 906                 return $str;
 907         } elseif (strlen($str) == 40) {
 908                 // From database
 909                 $scrambleNums = explode(':', getPassScramble());
 910         } else {
 911                 // Generate new numbers
 912                 $scrambleNums = explode(':', genScrambleString(strlen($str)));
 913         }
 914
 915         // Compare both lengths and abort if different
 916         if (strlen($str) != count($scrambleNums)) return $str;
 917
 918         // Scramble string here
 919         //* DEBUG: */ debugOutput('***Original=' . $str.'***<br />');
 920         for ($idx = 0; $idx < strlen($str); $idx++) {
 921                 // Get char on scrambled position
 922                 $char = substr($str, $scrambleNums[$idx], 1);
 923
 924                 // Add it to final output string
 925                 $scrambled .= $char;
 926         } // END - for
 927
 928         // Return scrambled string
 929         //* DEBUG: */ debugOutput('***Scrambled=' . $scrambled.'***<br />');
 930         return $scrambled;
 931 }
 932
 933 // De-scramble a string scrambled by scrambleString()
 934 function descrambleString ($str) {
 935         // Scramble only 40 chars long strings
 936         if (strlen($str) != 40) return $str;
 937
 938         // Load numbers from config
 939         $scrambleNums = explode(':', getPassScramble());
 940
 941         // Validate numbers
 942         if (count($scrambleNums) != 40) return $str;
 943
 944         // Begin descrambling
 945         $orig = str_repeat(' ', 40);
 946         //* DEBUG: */ debugOutput('+++Scrambled=' . $str.'+++<br />');
 947         for ($idx = 0; $idx < 40; $idx++) {
 948                 $char = substr($str, $idx, 1);
 949                 $orig = substr_replace($orig, $char, $scrambleNums[$idx], 1);
 950         } // END - for
 951
 952         // Return scrambled string
 953         //* DEBUG: */ debugOutput('+++Original=' . $orig.'+++<br />');
 954         return $orig;
 955 }
 956
 957 // Generated a "string" for scrambling
 958 function genScrambleString ($len) {
 959         // Prepare array for the numbers
 960         $scrambleNumbers = array();
 961
 962         // First we need to setup randomized numbers from 0 to 31
 963         for ($idx = 0; $idx < $len; $idx++) {
 964                 // Generate number
 965                 $rand = mt_rand(0, ($len - 1));
 966
 967                 // Check for it by creating more numbers
 968                 while (array_key_exists($rand, $scrambleNumbers)) {
 969                         $rand = mt_rand(0, ($len - 1));
 970                 } // END - while
 971
 972                 // Add number
 973                 $scrambleNumbers[$rand] = $rand;
 974         } // END - for
 975
 976         // So let's create the string for storing it in database
 977         $scrambleString = implode(':', $scrambleNumbers);
 978         return $scrambleString;
 979 }
 980
 981 // Generate an PGP-like encrypted hash of given hash for e.g. cookies
 982 function encodeHashForCookie ($passHash) {
 983         // Return vanilla password hash
 984         $ret = $passHash;
 985
 986         // Is a secret key and master salt already initialized?
 987         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, intval(isExtensionInstalled('sql_patches')) . '/' . intval(isConfigEntrySet('_PRIME')) . '/' . intval(isConfigEntrySet('secret_key')) . '/' . intval(isConfigEntrySet('master_salt')));
 988         if ((isExtensionInstalled('sql_patches')) && (isConfigEntrySet('_PRIME')) && (isConfigEntrySet('secret_key')) && (isConfigEntrySet('master_salt'))) {
 989                 // Only calculate when the secret key is generated
 990                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, strlen($passHash) . '/' . strlen(getSecretKey()));
 991                 if ((strlen($passHash) != 49) || (strlen(getSecretKey()) != 40)) {
 992                         // Both keys must have same length so return unencrypted
 993                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, strlen($passHash) . '!=49/' . strlen(getSecretKey()) . '!=40');
 994                         return $ret;
 995                 } // END - if
 996
 997                 $newHash = ''; $start = 9;
 998                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'passHash=' . $passHash . '(' . strlen($passHash) . ')');
 999                 for ($idx = 0; $idx < 20; $idx++) {
1000                         $part1 = hexdec(substr($passHash, ($idx * 2) + (strlen($passHash) - strlen(getSecretKey())), 2));
1001                         $part2 = hexdec(substr(getSecretKey(), $start, 2));
1002                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'part1=' . $part1 . '/part2=' . $part2);
1003                         $mod = dechex($idx);
1004                         if ($part1 > $part2) {
1005                                 $mod = dechex(sqrt(($part1 - $part2) * getPrime() / pi()));
1006                         } elseif ($part2 > $part1) {
1007                                 $mod = dechex(sqrt(($part2 - $part1) * getPrime() / pi()));
1008                         }
1009                         $mod = substr($mod, 0, 2);
1010                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'part1=' . $part1 . '/part2=' . $part2 . '/mod=' . $mod . '(' . strlen($mod) . ')');
1011                         $mod = str_repeat(0, (2 - strlen($mod))) . $mod;
1012                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'mod(' . ($idx * 2) . ')=' . $mod . '*');
1013                         $start += 2;
1014                         $newHash .= $mod;
1015                 } // END - for
1016
1017                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, $passHash . ',' . $newHash . ' (' . strlen($newHash) . ')');
1018                 $ret = generateHash($newHash, getMasterSalt());
1019         } // END - if
1020
1021         // Return result
1022         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'ret=' . $ret . '');
1023         return $ret;
1024 }
1025
1026 // Fix "deleted" cookies
1027 function fixDeletedCookies ($cookies) {
1028         // Is this an array with entries?
1029         if ((is_array($cookies)) && (count($cookies) > 0)) {
1030                 // Then check all cookies if they are marked as deleted!
1031                 foreach ($cookies as $cookieName) {
1032                         // Is the cookie set to "deleted"?
1033                         if (getSession($cookieName) == 'deleted') {
1034                                 setSession($cookieName, '');
1035                         } // END - if
1036                 } // END - foreach
1037         } // END - if
1038 }
1039
1040 // Checks if a given apache module is loaded
1041 function isApacheModuleLoaded ($apacheModule) {
1042         // Check it and return result
1043         return (((function_exists('apache_get_modules')) && (in_array($apacheModule, apache_get_modules()))) || (!function_exists('apache_get_modules')));
1044 }
1045
1046 // Get current theme name
1047 function getCurrentTheme () {
1048         // The default theme is 'default'... ;-)
1049         $ret = 'default';
1050
1051         // Do we have ext-theme installed and active or is 'theme' in URL or POST data?
1052         if ((isPostRequestElementSet('theme')) && (isIncludeReadable(sprintf("theme/%s/theme.php", postRequestElement('theme'))))) {
1053                 // Use value from POST data
1054                 $ret = postRequestElement('theme');
1055         } elseif ((isGetRequestElementSet('theme')) && (isIncludeReadable(sprintf("theme/%s/theme.php", getRequestElement('theme'))))) {
1056                 // Use value from GET data
1057                 $ret = getRequestElement('theme');
1058         } elseif (isExtensionActive('theme')) {
1059                 // Call inner method
1060                 $ret = getActualTheme();
1061         }
1062
1063         // Return theme value
1064         return $ret;
1065 }
1066
1067 // Generates an error code from given account status
1068 function generateErrorCodeFromUserStatus ($status = '') {
1069         // If no status is provided, use the default, cached
1070         if ((empty($status)) && (isMember())) {
1071                 // Get user status
1072                 $status = getUserData('status');
1073         } // END - if
1074
1075         // Default error code if unknown account status
1076         $errorCode = getCode('ACCOUNT_UNKNOWN');
1077
1078         // Generate constant name
1079         $codeName = sprintf("ACCOUNT_%s", strtoupper($status));
1080
1081         // Is the constant there?
1082         if (isCodeSet($codeName)) {
1083                 // Then get it!
1084                 $errorCode = getCode($codeName);
1085         } else {
1086                 // Unknown status
1087                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown error status %s detected.", $status));
1088         }
1089
1090         // Return error code
1091         return $errorCode;
1092 }
1093
1094 // Back-ported from the new ship-simu engine. :-)
1095 function debug_get_printable_backtrace () {
1096         // Init variable
1097         $backtrace = '<ol>';
1098
1099         // Get and prepare backtrace for output
1100         $backtraceArray = debug_backtrace();
1101         foreach ($backtraceArray as $key => $trace) {
1102                 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
1103                 if (!isset($trace['line'])) $trace['line'] = __LINE__;
1104                 if (!isset($trace['args'])) $trace['args'] = array();
1105                 $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>';
1106         } // END - foreach
1107
1108         // Close it
1109         $backtrace .= '</ol>';
1110
1111         // Return the backtrace
1112         return $backtrace;
1113 }
1114
1115 // A mail-able backtrace
1116 function debug_get_mailable_backtrace () {
1117         // Init variable
1118         $backtrace = '';
1119
1120         // Get and prepare backtrace for output
1121         $backtraceArray = debug_backtrace();
1122         foreach ($backtraceArray as $key => $trace) {
1123                 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
1124                 if (!isset($trace['line'])) $trace['line'] = __LINE__;
1125                 if (!isset($trace['args'])) $trace['args'] = array();
1126                 $backtrace .= ($key+1) . '.:' . basename($trace['file']) . ':' . $trace['line'] . ', ' . $trace['function'] . '(' . count($trace['args']) . ")\n";
1127         } // END - foreach
1128
1129         // Return the backtrace
1130         return $backtrace;
1131 }
1132
1133 // Generates a ***weak*** seed
1134 function generateSeed () {
1135         return microtime(true) * 100000;
1136 }
1137
1138 // Converts a message code to a human-readable message
1139 function getMessageFromErrorCode ($code) {
1140         $message = '';
1141         switch ($code) {
1142                 case '': break;
1143                 case getCode('LOGOUT_DONE')        : $message = '{--LOGOUT_DONE--}'; break;
1144                 case getCode('LOGOUT_FAILED')      : $message = '<span class="bad">{--LOGOUT_FAILED--}</span>'; break;
1145                 case getCode('DATA_INVALID')       : $message = '{--MAIL_DATA_INVALID--}'; break;
1146                 case getCode('POSSIBLE_INVALID')   : $message = '{--MAIL_POSSIBLE_INVALID--}'; break;
1147                 case getCode('USER_404')           : $message = '{--USER_404--}'; break;
1148                 case getCode('STATS_404')          : $message = '{--MAIL_STATS_404--}'; break;
1149                 case getCode('ALREADY_CONFIRMED')  : $message = '{--MAIL_ALREADY_CONFIRMED--}'; break;
1150                 case getCode('WRONG_PASS')         : $message = '{--LOGIN_WRONG_PASS--}'; break;
1151                 case getCode('WRONG_ID')           : $message = '{--LOGIN_WRONG_ID--}'; break;
1152                 case getCode('ACCOUNT_LOCKED')     : $message = '{--LOGIN_STATUS_LOCKED--}'; break;
1153                 case getCode('ACCOUNT_UNCONFIRMED'): $message = '{--LOGIN_STATUS_UNCONFIRMED--}'; break;
1154                 case getCode('COOKIES_DISABLED')   : $message = '{--LOGIN_COOKIES_DISABLED--}'; break;
1155                 case getCode('BEG_SAME_AS_OWN')    : $message = '{--BEG_SAME_USERID_AS_OWN--}'; break;
1156                 case getCode('LOGIN_FAILED')       : $message = '{--GUEST_LOGIN_FAILED_GENERAL--}'; break;
1157                 case getCode('MODULE_MEMBER_ONLY') : $message = '{%message,MODULE_MEMBER_ONLY=' . getRequestElement('mod') . '%}'; break;
1158                 case getCode('OVERLENGTH')         : $message = '{--MEMBER_TEXT_OVERLENGTH--}'; break;
1159                 case getCode('URL_FOUND')          : $message = '{--MEMBER_TEXT_CONTAINS_URL--}'; break;
1160                 case getCode('SUBJECT_URL')        : $message = '{--MEMBER_SUBJECT_CONTAINS_URL--}'; break;
1161                 case getCode('BLIST_URL')          : $message = '{--MEMBER_URL_BLACK_LISTED--}<br />{--MEMBER_BLIST_TIME--}: ' . generateDateTime(getRequestElement('blist'), 0); break;
1162                 case getCode('NO_RECS_LEFT')       : $message = '{--MEMBER_SELECTED_MORE_RECS--}'; break;
1163                 case getCode('INVALID_TAGS')       : $message = '{--MEMBER_HTML_INVALID_TAGS--}'; break;
1164                 case getCode('MORE_POINTS')        : $message = '{--MEMBER_MORE_POINTS_NEEDED--}'; break;
1165                 case getCode('MORE_RECEIVERS1')    : $message = '{--MEMBER_ENTER_MORE_RECEIVERS--}'; break;
1166                 case getCode('MORE_RECEIVERS2')    : $message = '{--MEMBER_NO_MORE_RECEIVERS_FOUND--}'; break;
1167                 case getCode('MORE_RECEIVERS3')    : $message = '{--MEMBER_ENTER_MORE_MIN_RECEIVERS--}'; break;
1168                 case getCode('INVALID_URL')        : $message = '{--MEMBER_ENTER_INVALID_URL--}'; break;
1169                 case getCode('NO_MAIL_TYPE')       : $message = '{--MEMBER_NO_MAIL_TYPE_SELECTED--}'; break;
1170                 case getCode('UNKNOWN_ERROR')      : $message = '{--LOGIN_UNKNOWN_ERROR--}'; break;
1171                 case getCode('UNKNOWN_STATUS')     : $message = '{--LOGIN_UNKNOWN_STATUS--}'; break;
1172                 case getCode('PROFILE_UPDATED')    : $message = '{--MEMBER_PROFILE_UPDATED--}'; break;
1173
1174                 case getCode('ERROR_MAILID'):
1175                         if (isExtensionActive('mailid', true)) {
1176                                 $message = '{--ERROR_CONFIRMING_MAIL--}';
1177                         } else {
1178                                 $message = '{%pipe,generateExtensionInactiveNotInstalledMessage=mailid%}';
1179                         }
1180                         break;
1181
1182                 case getCode('EXTENSION_PROBLEM'):
1183                         if (isGetRequestElementSet('ext')) {
1184                                 $message = '{%pipe,generateExtensionInactiveNotInstalledMessage=' . getRequestElement('ext') . '%}';
1185                         } else {
1186                                 $message = '{--EXTENSION_PROBLEM_UNSET_EXT--}';
1187                         }
1188                         break;
1189
1190                 case getCode('URL_TIME_LOCK'):
1191                         // @TODO Move this SQL code into a function, let's say 'getTimestampFromPoolId($id) ?
1192                         $result = SQL_QUERY_ESC("SELECT `timestamp` FROM `{?_MYSQL_PREFIX?}_pool` WHERE `id`=%s LIMIT 1",
1193                                 array(bigintval(getRequestElement('id'))), __FUNCTION__, __LINE__);
1194
1195                         // Load timestamp from last order
1196                         $content = SQL_FETCHARRAY($result);
1197
1198                         // Free memory
1199                         SQL_FREERESULT($result);
1200
1201                         // Translate it for templates
1202                         $content['timestamp'] = generateDateTime($content['timestamp'], 1);
1203
1204                         // Calculate hours...
1205                         $content['hours'] = round(getUrlTlock() / 60 / 60);
1206
1207                         // Minutes...
1208                         $content['minutes'] = round((getUrlTlock() - $content['hours'] * 60 * 60) / 60);
1209
1210                         // And seconds
1211                         $content['seconds'] = round(getUrlTlock() - $content['hours'] * 60 * 60 - $content['minutes'] * 60);
1212
1213                         // Finally contruct the message
1214                         $message = loadTemplate('tlock_message', true, $content);
1215                         break;
1216
1217                 default:
1218                         // Missing/invalid code
1219                         $message = '{%message,UNKNOWN_MAILID_CODE=' . $code . '%}';
1220
1221                         // Log it
1222                         logDebugMessage(__FUNCTION__, __LINE__, $message);
1223                         break;
1224         } // END - switch
1225
1226         // Return the message
1227         return $message;
1228 }
1229
1230 // Function taken from user comments on www.php.net / function isInStringIgnoreCase()
1231 function isUrlValidSimple ($url) {
1232         // Prepare URL
1233         $url = secureString(str_replace("\\", '', compileRawCode(urldecode($url))));
1234
1235         // Allows http and https
1236         $http      = "(http|https)+(:\/\/)";
1237         // Test domain
1238         $domain1   = "([[:alnum:]]([-[:alnum:]])*\.)?([[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})?";
1239         // Test double-domains (e.g. .de.vu)
1240         $domain2   = "([-[:alnum:]])?(\.[[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})(\.[[:alpha:]]{2,5})?";
1241         // Test IP number
1242         $ip        = "([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})";
1243         // ... directory
1244         $dir       = "((/)+([-_\.[:alnum:]])+)*";
1245         // ... page
1246         $page      = "/([-_[:alnum:]][-\._[:alnum:]]*\.[[:alnum:]]{2,5})?";
1247         // ... and the string after and including question character
1248         $getstring1 = "([\?/]([[:alnum:]][-\._%[:alnum:]]*(=)?([-\@\._:%[:alnum:]])+)(&([[:alnum:]]([-_%[:alnum:]])*(=)?([-\@\[\._:%[:alnum:]])+(\])*))*)?";
1249         // Pattern for URLs like http://url/dir/doc.html?var=value
1250         $pattern['d1dpg1']  = $http . $domain1 . $dir . $page . $getstring1;
1251         $pattern['d2dpg1']  = $http . $domain2 . $dir . $page . $getstring1;
1252         $pattern['ipdpg1']  = $http . $ip . $dir . $page . $getstring1;
1253         // Pattern for URLs like http://url/dir/?var=value
1254         $pattern['d1dg1']  = $http . $domain1 . $dir.'/' . $getstring1;
1255         $pattern['d2dg1']  = $http . $domain2 . $dir.'/' . $getstring1;
1256         $pattern['ipdg1']  = $http . $ip . $dir.'/' . $getstring1;
1257         // Pattern for URLs like http://url/dir/page.ext
1258         $pattern['d1dp']  = $http . $domain1 . $dir . $page;
1259         $pattern['d1dp']  = $http . $domain2 . $dir . $page;
1260         $pattern['ipdp']  = $http . $ip . $dir . $page;
1261         // Pattern for URLs like http://url/dir
1262         $pattern['d1d']  = $http . $domain1 . $dir;
1263         $pattern['d2d']  = $http . $domain2 . $dir;
1264         $pattern['ipd']  = $http . $ip . $dir;
1265         // Pattern for URLs like http://url/?var=value
1266         $pattern['d1g1']  = $http . $domain1 . '/' . $getstring1;
1267         $pattern['d2g1']  = $http . $domain2 . '/' . $getstring1;
1268         $pattern['ipg1']  = $http . $ip . '/' . $getstring1;
1269         // Pattern for URLs like http://url?var=value
1270         $pattern['d1g12']  = $http . $domain1 . $getstring1;
1271         $pattern['d2g12']  = $http . $domain2 . $getstring1;
1272         $pattern['ipg12']  = $http . $ip . $getstring1;
1273
1274         // Test all patterns
1275         $reg = false;
1276         foreach ($pattern as $key => $pat) {
1277                 // Debug regex?
1278                 if (isDebugRegularExpressionEnabled()) {
1279                         // @TODO Are these convertions still required?
1280                         $pat = str_replace('.', '&#92;&#46;', $pat);
1281                         $pat = str_replace('@', '&#92;&#64;', $pat);
1282                         //* DEBUG: */ debugOutput($key . '=&nbsp;' . $pat);
1283                 } // END - if
1284
1285                 // Check if expression matches
1286                 $reg = ($reg || preg_match(('^' . $pat . '^'), $url));
1287
1288                 // Does it match?
1289                 if ($reg === true) {
1290                         break;
1291                 } // END - if
1292         } // END - foreach
1293
1294         // Return true/false
1295         return $reg;
1296 }
1297
1298 // Wtites data to a config.php-style file
1299 // @TODO Rewrite this function to use readFromFile() and writeToFile()
1300 function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $inserted, $seek=0) {
1301         // Initialize some variables
1302         $done = false;
1303         $seek++;
1304         $next  = -1;
1305         $found = false;
1306
1307         // Is the file there and read-/write-able?
1308         if ((isFileReadable($FQFN)) && (is_writeable($FQFN))) {
1309                 $search = 'CFG: ' . $comment;
1310                 $tmp = $FQFN . '.tmp';
1311
1312                 // Open the source file
1313                 $fp = fopen($FQFN, 'r') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot read. file=' . basename($FQFN));
1314
1315                 // Is the resource valid?
1316                 if (is_resource($fp)) {
1317                         // Open temporary file
1318                         $fp_tmp = fopen($tmp, 'w') or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot write. tmp=' . basename($tmp) . ',file=' . $FQFN);
1319
1320                         // Is the resource again valid?
1321                         if (is_resource($fp_tmp)) {
1322                                 // Mark temporary file as readable
1323                                 $GLOBALS['file_readable'][$tmp] = true;
1324
1325                                 // Start reading
1326                                 while (!feof($fp)) {
1327                                         // Read from source file
1328                                         $line = fgets ($fp, 1024);
1329
1330                                         if (isInString($search, $line)) {
1331                                                 $next = '0';
1332                                                 $found = true;
1333                                         } // END - if
1334
1335                                         if ($next > -1) {
1336                                                 if ($next === $seek) {
1337                                                         $next = -1;
1338                                                         $line = $prefix . $inserted . $suffix . "\n";
1339                                                 } else {
1340                                                         $next++;
1341                                                 }
1342                                         } // END - if
1343
1344                                         // Write to temp file
1345                                         fwrite($fp_tmp, $line);
1346                                 } // END - while
1347
1348                                 // Close temp file
1349                                 fclose($fp_tmp);
1350
1351                                 // Finished writing tmp file
1352                                 $done = true;
1353                         } // END - if
1354
1355                         // Close source file
1356                         fclose($fp);
1357
1358                         if (($done === true) && ($found === true)) {
1359                                 // Copy back tmp file and delete tmp :-)
1360                                 copyFileVerified($tmp, $FQFN, 0644);
1361                                 return removeFile($tmp);
1362                         } elseif ($found === false) {
1363                                 outputHtml('<strong>CHANGE:</strong> 404!');
1364                         } else {
1365                                 outputHtml('<strong>TMP:</strong> UNDONE!');
1366                         }
1367                 }
1368         } else {
1369                 // File not found, not readable or writeable
1370                 debug_report_bug(__FUNCTION__, __LINE__, 'File not readable/writeable. file=' . basename($FQFN));
1371         }
1372
1373         // An error was detected!
1374         return false;
1375 }
1376
1377 // Send notification to admin
1378 function sendAdminNotification ($subject, $templateName, $content = array(), $userid = NULL) {
1379         if ((isExtensionInstalledAndNewer('admins', '0.4.1')) && (function_exists('sendAdminsEmails'))) {
1380                 // Send new way
1381                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'admins=Y,subject=' . $subject . ',templateName=' . $templateName . ' - OKAY!');
1382                 sendAdminsEmails($subject, $templateName, $content, $userid);
1383         } else {
1384                 // Send out-dated way
1385                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'admins=N,subject=' . $subject . ',templateName=' . $templateName . ' - OUT-DATED!');
1386                 $message = loadEmailTemplate($templateName, $content, $userid);
1387                 sendAdminEmails($subject, $message);
1388         }
1389 }
1390
1391 // Debug message logger
1392 function logDebugMessage ($funcFile, $line, $message, $force=true) {
1393         // Is debug mode enabled?
1394         if ((isDebugModeEnabled()) || ($force === true)) {
1395                 // Remove CRLF
1396                 $message = str_replace("\r", '', str_replace("\n", '', $message));
1397
1398                 // Log this message away
1399                 appendLineToFile(getPath() . getCachePath() . 'debug.log', generateDateTime(time(), '4') . '|' . getModule(false) . '|' . basename($funcFile) . '|' . $line . '|' . $message);
1400         } // END - if
1401 }
1402
1403 // Handle extra values
1404 function handleExtraValues ($filterFunction, $value, $extraValue) {
1405         // Default is the value itself
1406         $ret = $value;
1407
1408         // Do we have a special filter function?
1409         if (!empty($filterFunction)) {
1410                 // Does the filter function exist?
1411                 if (function_exists($filterFunction)) {
1412                         // Do we have extra parameters here?
1413                         if (!empty($extraValue)) {
1414                                 // Put both parameters in one new array by default
1415                                 $args = array($value, $extraValue);
1416
1417                                 // If we have an array simply use it and pre-extend it with our value
1418                                 if (is_array($extraValue)) {
1419                                         // Make the new args array
1420                                         $args = merge_array(array($value), $extraValue);
1421                                 } // END - if
1422
1423                                 // Call the multi-parameter call-back
1424                                 $ret = call_user_func_array($filterFunction, $args);
1425                         } else {
1426                                 // One parameter call
1427                                 $ret = call_user_func($filterFunction, $value);
1428                         }
1429                 } // END - if
1430         } // END - if
1431
1432         // Return the value
1433         return $ret;
1434 }
1435
1436 // Converts timestamp selections into a timestamp
1437 function convertSelectionsToEpocheTime (array &$postData, array &$content, &$id, &$skip) {
1438         // Init test variable
1439         $skip  = false;
1440         $test2 = '';
1441
1442         // Get last three chars
1443         $test = substr($id, -3);
1444
1445         // Improved way of checking! :-)
1446         if (in_array($test, array('_ye', '_mo', '_we', '_da', '_ho', '_mi', '_se'))) {
1447                 // Found a multi-selection for timings?
1448                 $test = substr($id, 0, -3);
1449                 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)) {
1450                         // Generate timestamp
1451                         $postData[$test] = createEpocheTimeFromSelections($test, $postData);
1452                         $content[] = sprintf("`%s`='%s'", $test, $postData[$test]);
1453                         $GLOBALS['skip_config'][$test] = true;
1454
1455                         // Remove data from array
1456                         foreach (array('ye', 'mo', 'we', 'da', 'ho', 'mi', 'se') as $rem) {
1457                                 unset($postData[$test . '_' . $rem]);
1458                         } // END - foreach
1459
1460                         // Skip adding
1461                         unset($id);
1462                         $skip = true;
1463                         $test2 = $test;
1464                 } // END - if
1465         } // END - if
1466 }
1467
1468 // Reverts the german decimal comma into Computer decimal dot
1469 function convertCommaToDot ($str) {
1470         // Default float is not a float... ;-)
1471         $float = false;
1472
1473         // Which language is selected?
1474         switch (getLanguage()) {
1475                 case 'de': // German language
1476                         // Remove german thousand dots first
1477                         $str = str_replace('.', '', $str);
1478
1479                         // Replace german commata with decimal dot and cast it
1480                         $float = (float)str_replace(',', '.', $str);
1481                         break;
1482
1483                 default: // US and so on
1484                         // Remove thousand dots first and cast
1485                         $float = (float)str_replace(',', '', $str);
1486                         break;
1487         }
1488
1489         // Return float
1490         return $float;
1491 }
1492
1493 // Handle menu-depending failed logins and return the rendered content
1494 function handleLoginFailures ($accessLevel) {
1495         // Default output is empty ;-)
1496         $OUT = '';
1497
1498         // Is the session data set?
1499         if ((isSessionVariableSet('mailer_' . $accessLevel . '_failures')) && (isSessionVariableSet('mailer_' . $accessLevel . '_last_failure'))) {
1500                 // Ignore zero values
1501                 if (getSession('mailer_' . $accessLevel . '_failures') > 0) {
1502                         // Non-guest has login failures found, get both data and prepare it for template
1503                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'accessLevel=' . $accessLevel . '<br />');
1504                         $content = array(
1505                                 'login_failures' => 'mailer_' . $accessLevel . '_failures',
1506                                 'last_failure'   => generateDateTime(getSession('mailer_' . $accessLevel . '_last_failure'), 2)
1507                         );
1508
1509                         // Load template
1510                         $OUT = loadTemplate('login_failures', true, $content);
1511                 } // END - if
1512
1513                 // Reset session data
1514                 setSession('mailer_' . $accessLevel . '_failures', '');
1515                 setSession('mailer_' . $accessLevel . '_last_failure', '');
1516         } // END - if
1517
1518         // Return rendered content
1519         return $OUT;
1520 }
1521
1522 // Rebuild cache
1523 function rebuildCache ($cache, $inc = '', $force = false) {
1524         // Debug message
1525         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("cache=%s, inc=%s, force=%s", $cache, $inc, intval($force)));
1526
1527         // Shall I remove the cache file?
1528         if (isCacheInstanceValid()) {
1529                 // Rebuild cache
1530                 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) {
1531                         // Destroy it
1532                         $GLOBALS['cache_instance']->removeCacheFile($force);
1533                 } // END - if
1534
1535                 // Include file given?
1536                 if (!empty($inc)) {
1537                         // Construct FQFN
1538                         $inc = sprintf("inc/loader/load-%s.php", $inc);
1539
1540                         // Is the include there?
1541                         if (isIncludeReadable($inc)) {
1542                                 // And rebuild it from scratch
1543                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'inc=' . $inc . ' - LOADED!');
1544                                 loadInclude($inc);
1545                         } else {
1546                                 // Include not found
1547                                 logDebugMessage(__FUNCTION__, __LINE__, 'Include ' . $inc . ' not found. cache=' . $cache);
1548                         }
1549                 } // END - if
1550         } // END - if
1551 }
1552
1553 // Determines the real remote address
1554 function determineRealRemoteAddress ($remoteAddr = false) {
1555         // Is a proxy in use?
1556         if ((isset($_SERVER['HTTP_X_FORWARDED_FOR'])) && (!$remoteAddr)) {
1557                 // Proxy was used
1558                 $address = $_SERVER['HTTP_X_FORWARDED_FOR'];
1559         } elseif ((isset($_SERVER['HTTP_CLIENT_IP'])) && (!$remoteAddr)) {
1560                 // Yet, another proxy
1561                 $address = $_SERVER['HTTP_CLIENT_IP'];
1562         } else {
1563                 // The regular address when no proxy was used
1564                 $address = $_SERVER['REMOTE_ADDR'];
1565         }
1566
1567         // This strips out the real address from proxy output
1568         if (strstr($address, ',')) {
1569                 $addressArray = explode(',', $address);
1570                 $address = $addressArray[0];
1571         } // END - if
1572
1573         // Return the result
1574         return $address;
1575 }
1576
1577 // Adds a bonus mail to the queue
1578 // This is a high-level function!
1579 function addNewBonusMail ($data, $mode = '', $output = true) {
1580         // Use mode from data if not set and availble ;-)
1581         if ((empty($mode)) && (isset($data['mail_mode']))) {
1582                 $mode = $data['mail_mode'];
1583         } // END - if
1584
1585         // Generate receiver list
1586         $receiver = generateReceiverList($data['cat'], $data['receiver'], $mode);
1587
1588         // Receivers added?
1589         if (!empty($receiver)) {
1590                 // Add bonus mail to queue
1591                 addBonusMailToQueue(
1592                         $data['subject'],
1593                         $data['text'],
1594                         $receiver,
1595                         $data['points'],
1596                         $data['seconds'],
1597                         $data['url'],
1598                         $data['cat'],
1599                         $mode,
1600                         $data['receiver']
1601                 );
1602
1603                 // Mail inserted into bonus pool
1604                 if ($output === true) {
1605                         displayMessage('{--ADMIN_BONUS_SEND--}');
1606                 } // END - if
1607         } elseif ($output === true) {
1608                 // More entered than can be reached!
1609                 displayMessage('{--ADMIN_MORE_SELECTED--}');
1610         } else {
1611                 // Debug log
1612                 logDebugMessage(__FUNCTION__, __LINE__, 'cat=' . $data['cat'] . ',receiver=' . $data['receiver'] . ',data=' . base64_encode(serialize($data)) . ' More selected, than available!');
1613         }
1614 }
1615
1616 // Determines referral id and sets it
1617 function determineReferralId () {
1618         // Skip this in non-html-mode and outside ref.php
1619         if ((!isHtmlOutputMode()) && (basename($_SERVER['PHP_SELF']) != 'ref.php')) {
1620                 return false;
1621         } // END - if
1622
1623         // Check if refid is set
1624         if (isReferralIdValid()) {
1625                 // This is fine...
1626                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from GLOBALS (' . getReferralId() . ')');
1627         } elseif (isPostRequestElementSet('refid')) {
1628                 // Get referral id from POST element refid
1629                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from POST data (' . postRequestElement('refid') . ')');
1630                 setReferralId(secureString(postRequestElement('refid')));
1631         } elseif (isGetRequestElementSet('refid')) {
1632                 // Get referral id from GET parameter refid
1633                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from GET data (' . getRequestElement('refid') . ')');
1634                 setReferralId(secureString(getRequestElement('refid')));
1635         } elseif (isGetRequestElementSet('ref')) {
1636                 // Set refid=ref (the referral link uses such variable)
1637                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using ref from GET data (' . getRequestElement('refid') . ')');
1638                 setReferralId(secureString(getRequestElement('ref')));
1639         } elseif ((isGetRequestElementSet('user')) && (basename($_SERVER['PHP_SELF']) == 'click.php')) {
1640                 // The variable user comes from  click.php
1641                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using user from GET data (' . getRequestElement('user') . ')');
1642                 setReferralId(bigintval(getRequestElement('user')));
1643         } elseif ((isSessionVariableSet('refid')) && (isValidUserId(getSession('refid')))) {
1644                 // Set session refid as global
1645                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from SESSION data (' . getSession('refid') . ')');
1646                 setReferralId(bigintval(getSession('refid')));
1647         } elseif (isRandomReferralIdEnabled()) {
1648                 // Select a random user which has confirmed enougth mails
1649                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Checking random referral id');
1650                 setReferralId(determineRandomReferralId());
1651         } elseif ((isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (isValidUserId(getDefRefid()))) {
1652                 // Set default refid as refid in URL
1653                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using default refid (' . getDefRefid() . ')');
1654                 setReferralId(getDefRefid());
1655         } else {
1656                 // No default id when sql_patches is not installed or none set
1657                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using NULL as refid');
1658                 setReferralId(NULL);
1659         }
1660
1661         // Set cookie when default refid > 0
1662         if ((!isSessionVariableSet('refid')) || (!isValidUserId(getReferralId())) || ((!isValidUserId(getSession('refid'))) && (isExtensionInstalledAndNewer('sql_patches', '0.1.2')) && (isValidUserId(getDefRefid())))) {
1663                 // Default is not found
1664                 $found = false;
1665
1666                 // Do we have nickname or userid set?
1667                 if ((isExtensionActive('nickname')) && (isNicknameUsed(getReferralId()))) {
1668                         // Nickname in URL, so load the id
1669                         $found = fetchUserData(getReferralId(), 'nickname');
1670
1671                         // If we found it, use the userid as referral id
1672                         if ($found === true) {
1673                                 // Set the userid as 'refid'
1674                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using refid from user account by nickname (' . getUserData('userid') . ')');
1675                                 setReferralId(getUserData('userid'));
1676                         } // END - if
1677                 } elseif (isValidUserId(getReferralId())) {
1678                         // Direct userid entered
1679                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using direct userid (' . getReferralId() . ')');
1680                         $found = fetchUserData(getReferralId());
1681                 }
1682
1683                 // Is the record valid?
1684                 if ((($found === false) || (!isUserDataValid())) && (isExtensionInstalledAndNewer('sql_patches', '0.1.2'))) {
1685                         // No, then reset referral id
1686                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Using default refid (' . getDefRefid() . ')');
1687                         setReferralId(getDefRefid());
1688                 } // END - if
1689
1690                 // Set cookie
1691                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Saving refid to session (' . getReferralId() . ') #1');
1692                 setSession('refid', getReferralId());
1693         } elseif ((!isReferralIdValid()) || (!fetchUserData(getReferralId()))) {
1694                 // Not valid!
1695                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Not valid referral id (' . getReferralId() . '), setting NULL in session');
1696                 setReferralId(NULL);
1697                 setSession('refid', NULL);
1698         } else {
1699                 // Set it from GLOBALS array in session
1700                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Saving refid to session (' . getReferralId() . ') #2');
1701                 setSession('refid', getReferralId());
1702         }
1703
1704         // Return determined refid
1705         return getReferralId();
1706 }
1707
1708 // Enables the reset mode and runs it
1709 function doReset () {
1710         // Enable the reset mode
1711         $GLOBALS['reset_enabled'] = true;
1712
1713         // Run filters
1714         runFilterChain('reset');
1715 }
1716
1717 // Enables the reset mode (hourly, weekly and monthly) and runs it
1718 function doHourly () {
1719         // Enable the hourly reset mode
1720         $GLOBALS['hourly_enabled'] = true;
1721
1722         // Run filters (one always!)
1723         runFilterChain('hourly');
1724 }
1725
1726 // Our shutdown-function
1727 function shutdown () {
1728         // Call the filter chain 'shutdown'
1729         runFilterChain('shutdown', null);
1730
1731         // Check if not in installation phase and the link is up
1732         if ((!isInstallationPhase()) && (SQL_IS_LINK_UP())) {
1733                 // Close link
1734                 SQL_CLOSE(__FUNCTION__, __LINE__);
1735         } elseif (!isInstallationPhase()) {
1736                 // No database link
1737                 debug_report_bug(__FUNCTION__, __LINE__, 'Database link is already down, while shutdown is running.');
1738         }
1739
1740         // Stop executing here
1741         exit;
1742 }
1743
1744 // Init member id
1745 function initMemberId () {
1746         $GLOBALS['member_id'] = '0';
1747 }
1748
1749 // Setter for member id
1750 function setMemberId ($memberid) {
1751         // We should not set member id to zero
1752         if ($memberid == '0') {
1753                 debug_report_bug(__FUNCTION__, __LINE__, 'Userid should not be set zero.');
1754         } // END - if
1755
1756         // Set it secured
1757         $GLOBALS['member_id'] = bigintval($memberid);
1758 }
1759
1760 // Getter for member id or returns zero
1761 function getMemberId () {
1762         // Default member id
1763         $memberid = '0';
1764
1765         // Is the member id set?
1766         if (isMemberIdSet()) {
1767                 // Then use it
1768                 $memberid = $GLOBALS['member_id'];
1769         } // END - if
1770
1771         // Return it
1772         return $memberid;
1773 }
1774
1775 // Checks ether the member id is set
1776 function isMemberIdSet () {
1777         return (isset($GLOBALS['member_id']));
1778 }
1779
1780 // Setter for extra title
1781 function setExtraTitle ($extraTitle) {
1782         $GLOBALS['extra_title'] = $extraTitle;
1783 }
1784
1785 // Getter for extra title
1786 function getExtraTitle () {
1787         // Is the extra title set?
1788         if (!isExtraTitleSet()) {
1789                 // No, then abort here
1790                 debug_report_bug(__FUNCTION__, __LINE__, 'extra_title is not set!');
1791         } // END - if
1792
1793         // Return it
1794         return $GLOBALS['extra_title'];
1795 }
1796
1797 // Checks if the extra title is set
1798 function isExtraTitleSet () {
1799         return ((isset($GLOBALS['extra_title'])) && (!empty($GLOBALS['extra_title'])));
1800 }
1801
1802 /**
1803  * Reads a directory recursively by default and searches for files not matching
1804  * an exclusion pattern. You can now keep the exclusion pattern empty for reading
1805  * a whole directory.
1806  *
1807  * @param       $baseDir                        Relative base directory to PATH to scan from
1808  * @param       $prefix                         Prefix for all positive matches (which files should be found)
1809  * @param       $fileIncludeDirs        Wether to include directories in the final output array
1810  * @param       $addBaseDir                     Wether to add $baseDir to all array entries
1811  * @param       $excludeArray           Excluded files and directories, these must be full files names, e.g. 'what-' will exclude all files named 'what-' but won't exclude 'what-foo.php'
1812  * @param       $extension                      File extension for all positive matches
1813  * @param       $excludePattern         Regular expression to exclude more files (preg_match())
1814  * @param       $recursive                      Wether to scan recursively
1815  * @param       $suffix                         Suffix for positive matches ($extension will be appended, too)
1816  * @return      $foundMatches           All found positive matches for above criteria
1817  */
1818 function getArrayFromDirectory ($baseDir, $prefix, $fileIncludeDirs = false, $addBaseDir = true, $excludeArray = array(), $extension = '.php', $excludePattern = '@(\.|\.\.)$@', $recursive = true, $suffix = '') {
1819         // Add default entries we should always exclude
1820         $excludeArray[] = '.';         // Current directory
1821         $excludeArray[] = '..';        // Parent directory
1822         $excludeArray[] = '.svn';      // Directories created by Subversion
1823         $excludeArray[] = '.htaccess'; // Directory protection files (mostly)
1824
1825         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'baseDir=' . $baseDir . ',prefix=' . $prefix . ' - Entered!');
1826         // Init found includes
1827         $foundMatches = array();
1828
1829         // Open directory
1830         $dirPointer = opendir(getPath() . $baseDir) or debug_report_bug(__FUNCTION__, __LINE__, 'Cannot read directory ' . basename($baseDir) . '.');
1831
1832         // Read all entries
1833         while ($baseFile = readdir($dirPointer)) {
1834                 // Exclude '.', '..' and entries in $excludeArray automatically
1835                 if (in_array($baseFile, $excludeArray, true))  {
1836                         // Exclude them
1837                         //* DEBUG: */ debugOutput('excluded=' . $baseFile);
1838                         continue;
1839                 } // END - if
1840
1841                 // Construct include filename and FQFN
1842                 $fileName = $baseDir . $baseFile;
1843                 $FQFN = getPath() . $fileName;
1844
1845                 // Remove double slashes
1846                 $FQFN = str_replace('//', '/', $FQFN);
1847
1848                 // Check if the base filenname matches an exclusion pattern and if the pattern is not empty
1849                 if ((!empty($excludePattern)) && (preg_match($excludePattern, $baseFile, $match))) {
1850                         // Debug message
1851                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'baseDir=' . $baseDir . ',baseFile=' . $baseFile . ',FQFN=' . $FQFN);
1852
1853                         // Exclude this one
1854                         continue;
1855                 } // END - if
1856
1857                 // Skip also files with non-matching prefix genericly
1858                 if (($recursive === true) && (isDirectory($FQFN))) {
1859                         // Is a redirectory so read it as well
1860                         $foundMatches = merge_array($foundMatches, getArrayFromDirectory($baseDir . $baseFile . '/', $prefix, $fileIncludeDirs, $addBaseDir, $excludeArray, $extension, $excludePattern, $recursive));
1861
1862                         // And skip further processing
1863                         continue;
1864                 } elseif (!isFilePrefixFound($baseFile, $prefix)) {
1865                         // Skip this file
1866                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Invalid prefix in file ' . $baseFile . ', prefix=' . $prefix);
1867                         continue;
1868                 } elseif ((!empty($suffix)) && (substr($baseFile, -(strlen($suffix . $extension)), (strlen($suffix . $extension))) != $suffix . $extension)) {
1869                         // Skip wrong suffix as well
1870                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Invalid suffix in file ' . $baseFile . ', suffix=' . $suffix);
1871                         continue;
1872                 } elseif (!isFileReadable($FQFN)) {
1873                         // Not readable so skip it
1874                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File ' . $FQFN . ' is not readable!');
1875                         continue;
1876                 }
1877
1878                 // Get file' extension (last 4 chars)
1879                 $fileExtension = substr($baseFile, -4, 4);
1880
1881                 // Is the file a PHP script or other?
1882                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'baseDir=' . $baseDir . ',prefix=' . $prefix . ',baseFile=' . $baseFile);
1883                 if (($fileExtension == '.php') || (($fileIncludeDirs === true) && (isDirectory($FQFN)))) {
1884                         // Is this a valid include file?
1885                         if ($extension == '.php') {
1886                                 // Remove both for extension name
1887                                 $extName = substr($baseFile, strlen($prefix), -4);
1888
1889                                 // Add file with or without base path
1890                                 if ($addBaseDir === true) {
1891                                         // With base path
1892                                         $foundMatches[] = $fileName;
1893                                 } else {
1894                                         // No base path
1895                                         $foundMatches[] = $baseFile;
1896                                 }
1897                         } else {
1898                                 // We found .php file but should not search for them, why?
1899                                 debug_report_bug(__FUNCTION__, __LINE__, 'We should find files with extension=' . $extension . ', but we found a PHP script. (baseFile=' . $baseFile . ')');
1900                         }
1901                 } elseif ($fileExtension == $extension) {
1902                         // Other, generic file found
1903                         $foundMatches[] = $fileName;
1904                 }
1905         } // END - while
1906
1907         // Close directory
1908         closedir($dirPointer);
1909
1910         // Sort array
1911         sort($foundMatches);
1912
1913         // Return array with include files
1914         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '- Left!');
1915         return $foundMatches;
1916 }
1917
1918 // Checks wether $prefix is found in $fileName
1919 function isFilePrefixFound ($fileName, $prefix) {
1920         // @TODO Find a way to cache this
1921         return (substr($fileName, 0, strlen($prefix)) == $prefix);
1922 }
1923
1924 // Maps a module name into a database table name
1925 function mapModuleToTable ($moduleName) {
1926         // Map only these, still lame code...
1927         switch ($moduleName) {
1928                 // 'index' is the guest's menu
1929                 case 'index': $moduleName = 'guest';  break;
1930                 // ... and 'login' the member's menu
1931                 case 'login': $moduleName = 'member'; break;
1932                 // Anything else will not be mapped, silently.
1933         } // END - switch
1934
1935         // Return result
1936         return $moduleName;
1937 }
1938
1939 // Add SQL debug data to array for later output
1940 function addSqlToDebug ($result, $sqlString, $timing, $F, $L) {
1941         // Do we have cache?
1942         if (!isset($GLOBALS['debug_sql_available'])) {
1943                 // Check it and cache it in $GLOBALS
1944                 $GLOBALS['debug_sql_available'] = ((isConfigurationLoaded()) && (isDisplayDebugSqlEnabled()));
1945         } // END - if
1946
1947         // Don't execute anything here if we don't need or ext-other is missing
1948         if ($GLOBALS['debug_sql_available'] === false) {
1949                 return;
1950         } // END - if
1951
1952         // Already executed?
1953         if (isset($GLOBALS['debug_sqls'][$F][$L][$sqlString])) {
1954                 // Then abort here, we don't need to profile a query twice
1955                 return;
1956         } // END - if
1957
1958         // Remeber this as profiled (or not, but we don't care here)
1959         $GLOBALS['debug_sqls'][$F][$L][$sqlString] = true;
1960
1961         // Generate record
1962         $record = array(
1963                 'num_rows' => SQL_NUMROWS($result),
1964                 'affected' => SQL_AFFECTEDROWS(),
1965                 'sql_str'  => $sqlString,
1966                 'timing'   => $timing,
1967                 'file'     => basename($F),
1968                 'line'     => $L
1969         );
1970
1971         // Add it
1972         $GLOBALS['debug_sqls'][] = $record;
1973 }
1974
1975 // Initializes the cache instance
1976 function initCacheInstance () {
1977         // Check for double-initialization
1978         if (isset($GLOBALS['cache_instance'])) {
1979                 // This should not happen and must be fixed
1980                 debug_report_bug(__FUNCTION__, __LINE__, 'Double initialization of cache system detected. cache_instance[]=' . gettype($GLOBALS['cache_instance']));
1981         } // END - if
1982
1983         // Load include for CacheSystem class
1984         loadIncludeOnce('inc/classes/cachesystem.class.php');
1985
1986         // Initialize cache system only when it's needed
1987         $GLOBALS['cache_instance'] = new CacheSystem();
1988
1989         // Did it work?
1990         if ($GLOBALS['cache_instance']->getStatusCode() != 'done') {
1991                 // Failed to initialize cache sustem
1992                 debug_report_bug(__FUNCTION__, __LINE__, 'Cache system returned with unexpected error. getStatusCode()=' . $GLOBALS['cache_instance']->getStatusCode());
1993         } // END - if
1994 }
1995
1996 // Getter for message from array or raw message
1997 function getMessageFromIndexedArray ($message, $pos, $array) {
1998         // Check if the requested message was found in array
1999         if (isset($array[$pos])) {
2000                 // ... if yes then use it!
2001                 $ret = $array[$pos];
2002         } else {
2003                 // ... else use default message
2004                 $ret = $message;
2005         }
2006
2007         // Return result
2008         return $ret;
2009 }
2010
2011 // Convert ';' to ', ' for e.g. receiver list
2012 function convertReceivers ($old) {
2013         return str_replace(';', ', ', $old);
2014 }
2015
2016 // Get a module from filename and access level
2017 function getModuleFromFileName ($file, $accessLevel) {
2018         // Default is 'invalid';
2019         $modCheck = 'invalid';
2020
2021         // @TODO This is still very static, rewrite it somehow
2022         switch ($accessLevel) {
2023                 case 'admin':
2024                         $modCheck = 'admin';
2025                         break;
2026
2027                 case 'sponsor':
2028                 case 'guest':
2029                 case 'member':
2030                         $modCheck = getModule();
2031                         break;
2032
2033                 default: // Unsupported file name / access level
2034                         debug_report_bug(__FUNCTION__, __LINE__, 'Unsupported file name=' . basename($file) . '/access level=' . $accessLevel);
2035                         break;
2036         }
2037
2038         // Return result
2039         return $modCheck;
2040 }
2041
2042 // Encodes an URL for adding session id, etc.
2043 function encodeUrl ($url, $outputMode = '0') {
2044         // Do we have already have a PHPSESSID inside or view.php is called? Then abort here
2045         if ((isInStringIgnoreCase(session_name(), $url)) || (isRawOutputMode())) {
2046                 // Raw output mode detected or session_name() found in URL
2047                 return $url;
2048         } // END - if
2049
2050         // Do we have a valid session?
2051         if (((!isset($GLOBALS['valid_session'])) || ($GLOBALS['valid_session'] === false) || (!isset($_COOKIE[session_name()]))) && (isSpider() === false)) {
2052                 // Invalid session
2053                 // Determine right separator
2054                 $separator = '&amp;';
2055                 if (!isInString('?', $url)) {
2056                         // No question mark
2057                         $separator = '?';
2058                 } elseif ((!isHtmlOutputMode()) || ($outputMode != '0')) {
2059                         // Non-HTML mode (or forced non-HTML mode
2060                         $separator = '&';
2061                 }
2062
2063                 // Add it to URL
2064                 if (session_id() != '') {
2065                         $url .= $separator . session_name() . '=' . session_id();
2066                 } // END - if
2067         } // END - if
2068
2069         // Add {?URL?} ?
2070         if ((substr($url, 0, strlen(getUrl())) != getUrl()) && (substr($url, 0, 7) != '{?URL?}') && (substr($url, 0, 7) != 'http://') && (substr($url, 0, 8) != 'https://')) {
2071                 // Add it
2072                 $url = '{?URL?}/' . $url;
2073         } // END - if
2074
2075         // Return the URL
2076         return $url;
2077 }
2078
2079 // Simple check for spider
2080 function isSpider () {
2081         // Get the UA and trim it down
2082         $userAgent = trim(detectUserAgent(true));
2083
2084         // It should not be empty, if so it is better a spider/bot
2085         if (empty($userAgent)) {
2086                 // It is a spider/bot
2087                 return true;
2088         } // END - if
2089
2090         // Is it a spider?
2091         return ((isInStringIgnoreCase('spider', $userAgent)) || (isInStringIgnoreCase('slurp', $userAgent)) || (isInStringIgnoreCase('bot', $userAgent)) || (isInStringIgnoreCase('archiver', $userAgent)));
2092 }
2093
2094 // Function to search for the last modified file
2095 function searchDirsRecursive ($dir, &$last_changed, $lookFor = 'Date') {
2096         // Get dir as array
2097         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dir=' . $dir);
2098         // Does it match what we are looking for? (We skip a lot files already!)
2099         // RegexPattern to exclude  ., .., .revision,  .svn, debug.log or .cache in the filenames
2100         $excludePattern = '@(\.revision|\.svn|debug\.log|\.cache|config\.php)$@';
2101
2102         $ds = getArrayFromDirectory($dir, '', false, true, array(), '.php', $excludePattern);
2103         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'count(ds)='.count($ds));
2104
2105         // Walk through all entries
2106         foreach ($ds as $d) {
2107                 // Generate proper FQFN
2108                 $FQFN = str_replace('//', '/', getPath() . $dir . '/' . $d);
2109
2110                 // Is it a file and readable?
2111                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'dir=' . $dir . ',d=' . $d);
2112                 if (isFileReadable($FQFN)) {
2113                         // $FQFN is a readable file so extract the requested data from it
2114                         $check = extractRevisionInfoFromFile($FQFN, $lookFor);
2115                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File: ' . $d . ' found. check=' . $check);
2116
2117                         // Is the file more recent?
2118                         if ((!isset($last_changed[$lookFor])) || ($last_changed[$lookFor] < $check)) {
2119                                 // This file is newer as the file before
2120                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'NEWER!');
2121                                 $last_changed['path_name'] = $FQFN;
2122                                 $last_changed[$lookFor] = $check;
2123                         } // END - if
2124                 } else {
2125                         // Not readable
2126                         /* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'File: ' . $d . ' not readable or directory.');
2127                 }
2128         } // END - foreach
2129 }
2130
2131 // Handles the braces [] of a field (e.g. value of 'name' attribute)
2132 function handleFieldWithBraces ($field) {
2133         // Are there braces [] at the end?
2134         if (substr($field, -2, 2) == '[]') {
2135                 // Try to find one and replace it. I do it this way to allow easy
2136                 // extending of this code.
2137                 foreach (array('admin_list_builder_id_value') as $key) {
2138                         // Is the cache entry set?
2139                         if (isset($GLOBALS[$key])) {
2140                                 // Insert it
2141                                 $field = str_replace('[]', '[' . $GLOBALS[$key] . ']', $field);
2142
2143                                 // And abort
2144                                 break;
2145                         } // END - if
2146                 } // END - foreach
2147         } // END - if
2148
2149         // Return it
2150         return $field;
2151 }
2152
2153 // Converts a zero or NULL to word 'NULL'
2154 function convertZeroToNull ($number) {
2155         // Is it a valid username?
2156         if ((!is_null($number)) && (!empty($number)) && ($number > 0)) {
2157                 // Always secure it
2158                 $number = bigintval($number);
2159         } else {
2160                 // Is not valid or zero
2161                 $number = 'NULL';
2162         }
2163
2164         // Return it
2165         return $number;
2166 }
2167
2168 // Converts a NULL to zero
2169 function convertNullToZero ($number) {
2170         // Is it a valid username?
2171         if ((!is_null($number)) && (!empty($number)) && ($number > 0)) {
2172                 // Always secure it
2173                 $number = bigintval($number);
2174         } else {
2175                 // Is not valid or zero
2176                 $number = '0';
2177         }
2178
2179         // Return it
2180         return $number;
2181 }
2182
2183 // Capitalizes a string with underscores, e.g.: some_foo_string will become SomeFooString
2184 // Note: This function is cached
2185 function capitalizeUnderscoreString ($str) {
2186         // Do we have cache?
2187         if (!isset($GLOBALS[__FUNCTION__][$str])) {
2188                 // Init target string
2189                 $capitalized = '';
2190
2191                 // Explode it with the underscore, but rewrite dashes to underscore before
2192                 $strArray = explode('_', str_replace('-', '_', $str));
2193
2194                 // "Walk" through all elements and make them lower-case but first upper-case
2195                 foreach ($strArray as $part) {
2196                         // Capitalize the string part
2197                         $capitalized .= firstCharUpperCase($part);
2198                 } // END - foreach
2199
2200                 // Store the converted string in cache array
2201                 $GLOBALS[__FUNCTION__][$str] = $capitalized;
2202         } // END - if
2203
2204         // Return cache
2205         return $GLOBALS[__FUNCTION__][$str];
2206 }
2207
2208 // Generate admin links for mail order
2209 // mailType can be: 'mid' or 'bid'
2210 function generateAdminMailLinks ($mailType, $mailId) {
2211         // Init variables
2212         $OUT = '';
2213         $table = '';
2214
2215         // Default column for mail status is 'data_type'
2216         // @TODO Rename column data_type to e.g. mail_status
2217         $statusColumn = 'data_type';
2218
2219         // Which mail do we have?
2220         switch ($mailType) {
2221                 case 'bid': // Bonus mail
2222                         $table = 'bonus';
2223                         break;
2224
2225                 case 'mid': // Member mail
2226                         $table = 'pool';
2227                         break;
2228
2229                 default: // Handle unsupported types
2230                         logDebugMessage(__FUNCTION__, __LINE__, 'Unsupported mail type ' . $mailType . ' for mailId=' . $mailId . ' detected.');
2231                         $OUT = '<div align="center">{%message,ADMIN_UNSUPPORTED_MAIL_TYPE_DETECTED=' . $mailType . '%}</div>';
2232                         break;
2233         } // END - switch
2234
2235         // Is the mail type supported?
2236         if (!empty($table)) {
2237                 // Query for the mail
2238                 $result = SQL_QUERY_ESC("SELECT `id`,`%s` AS `mail_status` FROM `{?_MYSQL_PREFIX?}_%s` WHERE `id`=%s LIMIT 1",
2239                         array(
2240                                 $statusColumn,
2241                                 $table,
2242                                 bigintval($mailId)
2243                         ), __FILE__, __LINE__);
2244
2245                 // Do we have one entry there?
2246                 if (SQL_NUMROWS($result) == 1) {
2247                         // Load the entry
2248                         $content = SQL_FETCHARRAY($result);
2249
2250                         // Add output and type
2251                         $content['type']     = $mailType;
2252                         $content['__output'] = '';
2253
2254                         // Filter all data
2255                         $content = runFilterChain('generate_admin_mail_links', $content);
2256
2257                         // Get output back
2258                         $OUT = $content['__output'];
2259                 } // END - if
2260
2261                 // Free result
2262                 SQL_FREERESULT($result);
2263         } // END - if
2264
2265         // Return generated HTML code
2266         return $OUT;
2267 }
2268
2269
2270 /**
2271  * Determine if a string can represent a number in hexadecimal
2272  *
2273  * @param       $hex    A string to check if it is hex-encoded
2274  * @return      $foo    True if the string is a hex, otherwise false
2275  * @author      Marques Johansson
2276  * @link        http://php.net/manual/en/function.http-chunked-decode.php#89786
2277  */
2278 function isHexadecimal ($hex) {
2279         // Make it lowercase
2280         $hex = strtolower(trim(ltrim($hex, '0')));
2281
2282         // Fix empty strings to zero
2283         if (empty($hex)) {
2284                 $hex = 0;
2285         } // END - if
2286
2287         // Simply compare decode->encode result with original
2288         return ($hex == dechex(hexdec($hex)));
2289 }
2290
2291 /**
2292  * Replace "\r" with "[r]" and "\n" with "[n]" and add a final new-line to make
2293  * them visible to the developer. Use this function to debug e.g. buggy HTTP
2294  * response handler functions.
2295  *
2296  * @param       $str    String to overwork
2297  * @return      $str    Overworked string
2298  */
2299 function replaceReturnNewLine ($str) {
2300         return str_replace("\r", '[r]', str_replace("\n", '[n]
2301 ', $str));
2302 }
2303
2304 // Converts a given string by splitting it up with given delimiter similar to
2305 // explode(), but appending the delimiter again
2306 function stringToArray ($delimiter, $string) {
2307         // Init array
2308         $strArray = array();
2309
2310         // "Walk" through all entries
2311         foreach (explode($delimiter, $string) as $split) {
2312                 //  Append the delimiter and add it to the array
2313                 $strArray[] = $split . $delimiter;
2314         } // END - foreach
2315
2316         // Return array
2317         return $strArray;
2318 }
2319
2320 // Detects the prefix 'mb_' if a multi-byte string is given
2321 function detectMultiBytePrefix ($str) {
2322         // Default is without multi-byte
2323         $mbPrefix = '';
2324
2325         // Detect multi-byte (strictly)
2326         if (mb_detect_encoding($str, 'auto', true) !== false) {
2327                 // With multi-byte encoded string
2328                 $mbPrefix = 'mb_';
2329         } // END - if
2330
2331         // Return the prefix
2332         return $mbPrefix;
2333 }
2334
2335 // Searches the given array for a sub-string match and returns all found keys in an array
2336 function getArrayKeysFromSubStrArray ($heystack, $needles, $offset = 0) {
2337         // Init array for all found keys
2338         $keys = array();
2339
2340         // Now check all entries
2341         foreach ($needles as $key => $needle) {
2342                 // Do we have found a partial string?
2343                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'heystack='.$heystack.',key='.$key.',needle='.$needle.',offset='.$offset);
2344                 if (strpos($heystack, $needle, $offset) !== false) {
2345                         // Add the found key
2346                         $keys[] = $key;
2347                 } // END - if
2348         } // END - foreach
2349
2350         // Return the array
2351         return $keys;
2352 }
2353
2354 // Determines database column name from given subject and locked
2355 function determinePointsColumnFromSubjectLocked ($subject, $locked) {
2356         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',locked=' . intval($locked) . ' - ENTERED!');
2357         // Default is 'normal' points
2358         $pointsColumn = 'points';
2359
2360         // Which points, locked or normal?
2361         if ($locked === true) {
2362                 $pointsColumn = 'locked_points';
2363         } // END - if
2364
2365         // Prepare array for filter
2366         $filterData = array(
2367                 'subject' => $subject,
2368                 'locked'  => $locked,
2369                 'column'  => $pointsColumn
2370         );
2371
2372         // Run the filter
2373         $filterData = runFilterChain('determine_points_column_name', $filterData);
2374
2375         // Extract column name from array
2376         $pointsColumn = $filterData['column'];
2377
2378         // Return it
2379         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'subject=' . $subject . ',locked=' . intval($locked) . ',pointsColumn=' . $pointsColumn . ' - EXIT!');
2380         return $pointsColumn;
2381 }
2382
2383 // Setter for referral id (no bigintval, or nicknames will fail!)
2384 function setReferralId ($refid) {
2385         $GLOBALS['refid'] = $refid;
2386 }
2387
2388 // Checks if 'refid' is valid
2389 function isReferralIdValid () {
2390         return ((isset($GLOBALS['refid'])) && (getReferralId() !== NULL) && (getReferralId() > 0));
2391 }
2392
2393 // Getter for referral id
2394 function getReferralId () {
2395         return $GLOBALS['refid'];
2396 }
2397
2398 // Converts a boolean variable into 'Y' for true and 'N' for false
2399 function convertBooleanToYesNo ($boolean) {
2400         // Default is 'N'
2401         $converted = 'N';
2402         if ($boolean === true) {
2403                 // Set 'Y'
2404                 $converted = 'Y';
2405         } // END - if
2406
2407         // Return it
2408         return $converted;
2409 }
2410
2411 // Translates task type to a human-readable version
2412 function translateTaskType ($taskType) {
2413         // Construct message id
2414         $messageId = 'ADMIN_TASK_TYPE_' . strtoupper($taskType) . '';
2415
2416         // Is the message id there?
2417         if (isMessageIdValid($messageId)) {
2418                 // Then construct message
2419                 $message = '{--' . $messageId . '--}';
2420         } else {
2421                 // Else it is an unknown task type
2422                 $message = '{%message,ADMIN_TASK_TYPE_UNKNOWN=' . $taskType . '%}';
2423         } // END - if
2424
2425         // Return message
2426         return $message;
2427 }
2428
2429 // Translates points subject to human-readable
2430 function translatePointsSubject ($subject) {
2431         // Construct message id
2432         $messageId = 'POINTS_SUBJECT_' . strtoupper($subject) . '';
2433
2434         // Is the message id there?
2435         if (isMessageIdValid($messageId)) {
2436                 // Then construct message
2437                 $message = '{--' . $messageId . '--}';
2438         } else {
2439                 // Else it is an unknown task type
2440                 $message = '{%message,POINTS_SUBJECT_UNKNOWN=' . $subject . '%}';
2441         } // END - if
2442
2443         // Return message
2444         return $message;
2445 }
2446
2447 // "Translates" 'true' to true and 'false' to false
2448 function convertStringToBoolean ($str) {
2449         // Trim it lower-case for validation
2450         $str = trim(strtolower($str));
2451
2452         // Is it valid?
2453         if (!in_array($str, array('true', 'false'))) {
2454                 // Not valid!
2455                 debug_report_bug(__FUNCTION__, __LINE__, 'str=' . $str . ' is not true/false');
2456         } // END - if
2457
2458         // Return it
2459         return (($str == 'true') ? true : false);
2460 }
2461
2462 /**
2463  * "Makes" a variable in given string parseable, this function will throw an
2464  * error if the first character is not a dollar sign.
2465  *
2466  * @param       $varString      String which contains a variable
2467  * @return      $return         String with added single quotes for better parsing
2468  */
2469 function makeParseableVariable ($varString) {
2470         // The first character must be a dollar sign
2471         if (substr($varString, 0, 1) != '$') {
2472                 // Please report this
2473                 debug_report_bug(__FUNCTION__, __LINE__, 'varString=' . $varString . ' - No dollar sign detected, will not parse it.');
2474         } // END - if
2475
2476         // Do we have cache?
2477         if (!isset($GLOBALS[__FUNCTION__][$varString])) {
2478                 // Snap them in, if [,] are there
2479                 $GLOBALS[__FUNCTION__][$varString] = str_replace('[', "['", str_replace(']', "']", $varString));
2480         } // END - if
2481
2482         // Return cache
2483         return $GLOBALS[__FUNCTION__][$varString];
2484 }
2485
2486 //-----------------------------------------------------------------------------
2487 // Automatically re-created functions, all taken from user comments on www.php.net
2488 //-----------------------------------------------------------------------------
2489 if (!function_exists('html_entity_decode')) {
2490         // Taken from documentation on www.php.net
2491         function html_entity_decode ($string) {
2492                 $trans_tbl = get_html_translation_table(HTML_ENTITIES);
2493                 $trans_tbl = array_flip($trans_tbl);
2494                 return strtr($string, $trans_tbl);
2495         }
2496 } // END - if
2497
2498 // [EOF]
2499 ?>