]> git.mxchange.org Git - mailer.git/blob - inc/functions.php
da1848b706f021c733159beee1c36cf3c07fb330
[mailer.git] / inc / functions.php
1 <?php
2 /************************************************************************
3  * MXChange v0.2.1                                    Start: 08/25/2003 *
4  * ===============                              Last change: 11/29/2005 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : functions.php                                    *
8  * -------------------------------------------------------------------- *
9  * Short description : Many non-MySQL functions (also file access)      *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Viele Nicht-MySQL-Funktionen (auch Dateizugriff) *
12  * -------------------------------------------------------------------- *
13  *                                                                      *
14  * -------------------------------------------------------------------- *
15  * Copyright (c) 2003 - 2008 by Roland Haeder                           *
16  * For more information visit: http://www.mxchange.org                  *
17  *                                                                      *
18  * This program is free software; you can redistribute it and/or modify *
19  * it under the terms of the GNU General Public License as published by *
20  * the Free Software Foundation; either version 2 of the License, or    *
21  * (at your option) any later version.                                  *
22  *                                                                      *
23  * This program is distributed in the hope that it will be useful,      *
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
26  * GNU General Public License for more details.                         *
27  *                                                                      *
28  * You should have received a copy of the GNU General Public License    *
29  * along with this program; if not, write to the Free Software          *
30  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
31  * MA  02110-1301  USA                                                  *
32  ************************************************************************/
33
34 // Some security stuff...
35 if (!defined('__SECURITY')) {
36         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4)."/security.php";
37         require($INC);
38 }
39
40 // Check if our config file is writeable or not
41 function IS_INC_WRITEABLE($inc) {
42         // Generate FQFN
43         $fqfn = sprintf("%sinc/%s.php", constant('PATH'), $inc);
44
45         // Abort by simple test
46         if ((FILE_READABLE($fqfn)) && (!is_writeable($fqfn))) {
47                 return false;
48         } // END - if
49
50         // Test if we can append data
51         $fp = fopen($fqfn, 'a');
52         if ($inc == "dummy") {
53                 // Remove dummy file
54                 fclose($fp);
55                 return unlink($fqfn);
56         } else {
57                 // Close all other files
58                 return fclose($fp);
59         }
60 }
61
62 // Output HTML code directly or "render" it. You addionally switch the new-line character off
63 function OUTPUT_HTML ($HTML, $newLine = true) {
64         // Some global variables
65         global $OUTPUT;
66
67         // Do we have HTML-Code here?
68         if (!empty($HTML)) {
69                 // Yes, so we handle it as you have configured
70                 switch (constant('OUTPUT_MODE'))
71                 {
72                 case "render":
73                         // That's why you don't need any \n at the end of your HTML code... :-)
74                         if (constant('_OB_CACHING') == "on") {
75                                 // Output into PHP's internal buffer
76                                 OUTPUT_RAW($HTML);
77
78                                 // That's why you don't need any \n at the end of your HTML code... :-)
79                                 if ($newLine) echo "\n";
80                         } else {
81                                 // Render mode for old or lame servers...
82                                 $OUTPUT .= $HTML;
83
84                                 // That's why you don't need any \n at the end of your HTML code... :-)
85                                 if ($newLine) $OUTPUT .= "\n";
86                         }
87                         break;
88
89                 case "direct":
90                         // If we are switching from render to direct output rendered code
91                         if ((!empty($OUTPUT)) && (constant('_OB_CACHING') != "on")) { OUTPUT_RAW($OUTPUT); $OUTPUT = ""; }
92
93                         // The same as above... ^
94                         OUTPUT_RAW($HTML);
95                         if ($newLine) echo "\n";
96                         break;
97
98                 default:
99                         // Huh, something goes wrong or maybe you have edited config.php ???
100                         DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Invalid renderer %s detected.", constant('OUTPUT_MODE')));
101                         mxchange_die("<strong>{--FATAL_ERROR--}:</strong> {--LANG_NO_RENDER_DIRECT--}");
102                         break;
103                 }
104         } elseif ((constant('_OB_CACHING') == "on") && (isset($GLOBALS['footer_sent'])) && ($GLOBALS['footer_sent'] == 1)) {
105                 // Headers already sent?
106                 if (headers_sent()) {
107                         // Log this error
108                         DEBUG_LOG(__FUNCTION__, __LINE__, "Headers already sent! We need debug backtrace here.");
109
110                         // Trigger an user error
111                         debug_report_bug("Headers are already sent!");
112                 } // END - if
113
114                 // Output cached HTML code
115                 $OUTPUT = ob_get_contents();
116
117                 // Clear output buffer for later output if output is found
118                 if (!empty($OUTPUT)) {
119                         clearOutputBuffer();
120                 } // END - if
121
122                 // Send HTTP header
123                 header("HTTP/1.1 200");
124
125                 // Used later
126                 $now = gmdate('D, d M Y H:i:s') . ' GMT';
127
128                 // General headers for no caching
129                 header("Expired: " . $now); // RFC2616 - Section 14.21
130                 header("Last-Modified: " . $now);
131                 header("Cache-Control: no-store, no-cache, must-revalidate, pre-check=0, post-check=0, max-age=0"); // HTTP/1.1
132                 header("Pragma: no-cache"); // HTTP/1.0
133                 header("Connection: Close");
134
135                 // Extension "rewrite" installed?
136                 if ((EXT_IS_ACTIVE("rewrite")) && ($GLOBALS['output_mode'] != "1") && ($GLOBALS['output_mode'] != "-1")) {
137                         $OUTPUT = REWRITE_LINKS($OUTPUT);
138                 } // END - if
139
140                 // Compile and run finished rendered HTML code
141                 while (strpos($OUTPUT, '{!') > 0) {
142                         // Prepare the content and eval() it...
143                         $newContent = "";
144                         $eval = "\$newContent = \"".COMPILE_CODE(smartAddSlashes($OUTPUT))."\";";
145                         eval($eval);
146
147                         // Was that eval okay?
148                         if (empty($newContent)) {
149                                 // Something went wrong!
150                                 mxchange_die("Evaluation error:<pre>".htmlentities($eval)."</pre>");
151                         } // END - if
152                         $OUTPUT = $newContent;
153                 } // END - while
154
155                 // Output code here, DO NOT REMOVE! ;-)
156                 OUTPUT_RAW($OUTPUT);
157         } elseif ((constant('OUTPUT_MODE') == "render") && (!empty($OUTPUT))) {
158                 // Rewrite links when rewrite extension is active
159                 if ((EXT_IS_ACTIVE("rewrite")) && ($GLOBALS['output_mode'] != "1") && ($GLOBALS['output_mode'] != "-1")) {
160                         $OUTPUT = REWRITE_LINKS($OUTPUT);
161                 } // END - if
162
163                 // Compile and run finished rendered HTML code
164                 while (strpos($OUTPUT, '{!') > 0) {
165                         $eval = "\$OUTPUT = \"".COMPILE_CODE(smartAddSlashes($OUTPUT))."\";";
166                         eval($eval);
167                 } // END - while
168
169                 // Output code here, DO NOT REMOVE! ;-)
170                 OUTPUT_RAW($OUTPUT);
171         }
172 }
173
174 // Output the raw HTML code
175 function OUTPUT_RAW ($HTML) {
176         // Output stripped HTML code to avoid broken JavaScript code, etc.
177         echo stripslashes(stripslashes($HTML));
178
179         // Flush the output if only constant('_OB_CACHING') is not "on"
180         if (constant('_OB_CACHING') != "on") {
181                 // Flush it
182                 flush();
183         } // END - if
184 }
185
186 // Init fatal message array
187 function initFatalMessages () {
188         $GLOBALS['fatal_messages'] = array();
189 }
190
191 // Getter for whole fatal error messages
192 function getFatalArray () {
193         return $GLOBALS['fatal_messages'];
194 }
195
196 // Add a fatal error message to the queue array
197 function addFatalMessage ($F, $L, $message, $extra="") {
198         if (is_array($extra)) {
199                 // Multiple extras for a message with masks
200                 $message = call_user_func_array('sprintf', $extra);
201         } elseif (!empty($extra)) {
202                 // $message is text with a mask plus extras to insert into the text
203                 $message = sprintf($message, $extra);
204         }
205
206         // Add message to $GLOBALS['fatal_messages']
207         $GLOBALS['fatal_messages'][] = $message;
208
209         // Log fatal messages away
210         DEBUG_LOG($F, $L, " message={$message}");
211 }
212
213 // Getter for total fatal message count
214 function getTotalFatalErrors () {
215         // Init coun
216         $count = 0;
217
218         // Do we have at least the first entry?
219         if (!empty($GLOBALS['fatal_messages'][0])) {
220                 // Get total count
221                 $count = count($GLOBALS['fatal_messages']);
222         } // END - if
223
224         // Return value
225         return $count;
226 }
227
228 // Load a template file and return it's content (only it's name; do not use ' or ")
229 function LOAD_TEMPLATE ($template, $return=false, $content=array()) {
230         // Add more variables which you want to use in your template files
231         global $DATA, $_CONFIG, $username;
232
233         // Make all template names lowercase
234         $template = strtolower($template);
235
236         // Count the template load
237         incrementConfigEntry('num_templates');
238
239         // Prepare IP number and User Agent
240         $REMOTE_ADDR     = GET_REMOTE_ADDR();
241         if (!defined('REMOTE_ADDR')) define('REMOTE_ADDR', $REMOTE_ADDR);
242         $HTTP_USER_AGENT = GET_USER_AGENT();
243
244         // Init some data
245         $ret = "";
246         if (empty($GLOBALS['refid'])) $GLOBALS['refid'] = 0;
247
248         // @DEPRECATED Try to rewrite the if() condition
249         if ($template == "member_support_form") {
250                 // Support request of a member
251                 $result = SQL_QUERY_ESC("SELECT userid, gender, surname, family, email FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
252                         array($GLOBALS['userid']), __FUNCTION__, __LINE__);
253
254                 // Is content an array?
255                 if (is_array($content)) {
256                         // Merge data
257                         $content = merge_array($content, SQL_FETCHARRAY($result));
258
259                         // Translate gender
260                         $content['gender'] = TRANSLATE_GENDER($content['gender']);
261                 } else {
262                         // @DEPRECATED
263                         // @TODO Fine all templates which are using these direct variables and rewrite them.
264                         // @TODO After this step is done, this else-block is history
265                         list($gender, $surname, $family, $email) = SQL_FETCHROW($result);
266
267                         // Translate gender
268                         $gender = TRANSLATE_GENDER($gender);
269                         DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("DEPRECATION-WARNING: content is not array (%s).", gettype($content)));
270                 }
271
272                 // Free result
273                 SQL_FREERESULT($result);
274         } // END - if
275
276         // Generate date/time string
277         $date_time = MAKE_DATETIME(time(), "1");
278
279         // Base directory
280         $BASE = sprintf("%stemplates/%s/html/", constant('PATH'), GET_LANGUAGE());
281         $MODE = "";
282
283         // Check for admin/guest/member templates
284         if (strpos($template, "admin_") > -1) {
285                 // Admin template found
286                 $MODE = "admin/";
287         } elseif (strpos($template, "guest_") > -1) {
288                 // Guest template found
289                 $MODE = "guest/";
290         } elseif (strpos($template, "member_") > -1) {
291                 // Member template found
292                 $MODE = "member/";
293         } elseif (strpos($template, "install_") > -1) {
294                 // Installation template found
295                 $MODE = "install/";
296         } elseif (strpos($template, "ext_") > -1) {
297                 // Extension template found
298                 $MODE = "ext/";
299         } elseif (strpos($template, "la_") > -1) {
300                 // "Logical-area" template found
301                 $MODE = "la/";
302         } else {
303                 // Test for extension
304                 $test = substr($template, 0, strpos($template, "_"));
305                 if (EXT_IS_ACTIVE($test)) {
306                         // Set extra path to extension's name
307                         $MODE = $test."/";
308                 }
309         }
310
311         ////////////////////////
312         // Generate file name //
313         ////////////////////////
314         $FQFN = $BASE.$MODE.$template.".tpl";
315
316         if ((!empty($GLOBALS['what'])) && ((strpos($template, "_header") > 0) || (strpos($template, "_footer") > 0)) && (($MODE == "guest/") || ($MODE == "member/") || ($MODE == "admin/"))) {
317                 // Select what depended header/footer template file for admin/guest/member area
318                 $file2 = sprintf("%s%s%s_%s.tpl",
319                         $BASE,
320                         $MODE,
321                         $template,
322                         SQL_ESCAPE($GLOBALS['what'])
323                 );
324
325                 // Probe for it...
326                 if (FILE_READABLE($file2)) $FQFN = $file2;
327
328                 // Remove variable from memory
329                 unset($file2);
330         }
331
332         // Does the special template exists?
333         if (!FILE_READABLE($FQFN)) {
334                 // Reset to default template
335                 $FQFN = $BASE.$template.".tpl";
336         } // END - if
337
338         // Now does the final template exists?
339         if (FILE_READABLE($FQFN)) {
340                 // The local file does exists so we load it. :)
341                 $tmpl_file = READ_FILE($FQFN);
342
343                 // Replace ' to our own chars to preventing them being quoted
344                 while (strpos($tmpl_file, "'") !== false) { $tmpl_file = str_replace("'", '{QUOT}', $tmpl_file); }
345
346                 // Do we have to compile the code?
347                 $ret = "";
348                 if ((strpos($tmpl_file, "\$") !== false) || (strpos($tmpl_file, '{--') !== false) || (strpos($tmpl_file, '--}') > 0)) {
349                         // Okay, compile it!
350                         $tmpl_file = "\$ret=\"".COMPILE_CODE(smartAddSlashes($tmpl_file))."\";";
351                         eval($tmpl_file);
352                 } else {
353                         // Simply return loaded code
354                         $ret = $tmpl_file;
355                 }
356
357                 // Add surrounding HTML comments to help finding bugs faster
358                 $ret = "<!-- Template ".$template." - Start -->\n".$ret."<!-- Template ".$template." - End -->\n";
359         } elseif ((IS_ADMIN()) || ((isInstalling()) && (!isInstalled()))) {
360                 // Only admins shall see this warning or when installation mode is active
361                 $ret = "<br /><span class=\"guest_failed\">".TEMPLATE_404."</span><br />
362 (".basename($FQFN).")<br />
363 <br />
364 ".TEMPLATE_CONTENT."
365 <pre>".print_r($content, true)."</pre>
366 ".TEMPLATE_DATA."
367 <pre>".print_r($DATA, true)."</pre>
368 <br /><br />";
369         }
370
371         // Remove content and data
372         unset($content);
373         unset($DATA);
374
375         // Do we have some content to output or return?
376         if (!empty($ret)) {
377                 // Not empty so let's put it out! ;)
378                 if ($return) {
379                         // Return the HTML code
380                         return $ret;
381                 } else {
382                         // Output direct
383                         OUTPUT_HTML($ret);
384                 }
385         } elseif (isDebugModeEnabled()) {
386                 // Warning, empty output!
387                 return "E:".$template."<br />\n";
388         }
389 }
390
391 // Send mail out to an email address
392 function SEND_EMAIL($TO, $SUBJECT, $MSG, $HTML = "N", $FROM = "") {
393         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):TO={$TO},SUBJECT={$SUBJECT}<br />\n";
394
395         // Compile subject line (for POINTS constant etc.)
396         $eval = "\$SUBJECT = decodeEntities(\"".COMPILE_CODE(smartAddSlashes($SUBJECT))."\");";
397         eval($eval);
398
399         // Set from header
400         if ((!eregi("@", $TO)) && ($TO > 0)) {
401                 // Value detected, is the message extension installed?
402                 if (EXT_IS_ACTIVE("msg")) {
403                         ADD_MESSAGE_TO_BOX($TO, $SUBJECT, $MSG, $HTML);
404                         return;
405                 } else {
406                         // Load email address
407                         $result_email = SQL_QUERY_ESC("SELECT email FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1", array(bigintval($TO)), __FUNCTION__, __LINE__);
408                         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):numRows=".SQL_NUMROWS($result_email)."<br />\n";
409
410                         // Does the user exist?
411                         if (SQL_NUMROWS($result_email)) {
412                                 // Load email address
413                                 list($TO) = SQL_FETCHROW($result_email);
414                         } else {
415                                 // Set webmaster
416                                 $TO = constant('WEBMASTER');
417                         }
418
419                         // Free result
420                         SQL_FREERESULT($result_email);
421                 }
422         } elseif ("$TO" == "0") {
423                 // Is the webmaster!
424                 $TO = constant('WEBMASTER');
425         }
426         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):TO={$TO}<br />\n";
427
428         // Check for PHPMailer or debug-mode
429         if (!CHECK_PHPMAILER_USAGE()) {
430                 // Not in PHPMailer-Mode
431                 if (empty($FROM)) {
432                         // Load email header template
433                         $FROM = LOAD_EMAIL_TEMPLATE("header");
434                 } else {
435                         // Append header
436                         $FROM .= LOAD_EMAIL_TEMPLATE("header");
437                 }
438         } elseif (isDebugModeEnabled()) {
439                 if (empty($FROM)) {
440                         // Load email header template
441                         $FROM = LOAD_EMAIL_TEMPLATE("header");
442                 } else {
443                         // Append header
444                         $FROM .= LOAD_EMAIL_TEMPLATE("header");
445                 }
446         }
447
448         // Compile "TO"
449         $eval = "\$TO = \"".COMPILE_CODE(smartAddSlashes($TO))."\";";
450         eval($eval);
451
452         // Compile "MSG"
453         $eval = "\$MSG = \"".COMPILE_CODE(smartAddSlashes($MSG))."\";";
454         eval($eval);
455
456         // Fix HTML parameter (default is no!)
457         if (empty($HTML)) $HTML = "N";
458         if (isDebugModeEnabled()) {
459                 // In debug mode we want to display the mail instead of sending it away so we can debug this part
460                 print("<pre>
461 ".htmlentities(trim($FROM))."
462 To      : ".$TO."
463 Subject : ".$SUBJECT."
464 Message : ".$MSG."
465 </pre>\n");
466         } elseif (($HTML == "Y") && (EXT_IS_ACTIVE("html_mail"))) {
467                 // Send mail as HTML away
468                 SEND_HTML_EMAIL($TO, $SUBJECT, $MSG, $FROM);
469         } elseif (!empty($TO)) {
470                 // Send Mail away
471                 SEND_RAW_EMAIL($TO, $SUBJECT, $MSG, $FROM);
472         } elseif ($HTML == "N") {
473                 // Problem found!
474                 SEND_RAW_EMAIL(constant('WEBMASTER'), "[PROBLEM:]".$SUBJECT, $MSG, $FROM);
475         }
476 }
477
478 // Check if legacy or PHPMailer command
479 // @TODO Rewrite this to an extension 'smtp'
480 // @private
481 function CHECK_PHPMAILER_USAGE() {
482         return ((defined('SMTP_HOSTNAME')) && (defined('SMTP_USER')) && (defined('SMTP_PASSWORD')) && (constant('SMTP_HOSTNAME') != "") && (constant('SMTP_USER') != ""));
483 }
484
485 /*
486  * Send out a raw email with PHPMailer class or legacy mail() command
487  */
488 function SEND_RAW_EMAIL ($to, $subject, $msg, $from) {
489         // Shall we use PHPMailer class or legacy mode?
490         if (CHECK_PHPMAILER_USAGE()) {
491                 // Use PHPMailer class with SMTP enabled
492                 LOAD_INC_ONCE("inc/phpmailer/class.phpmailer.php");
493                 LOAD_INC_ONCE("inc/phpmailer/class.smtp.php");
494
495                 // get new instance
496                 $mail = new PHPMailer();
497                 $mail->PluginDir  = sprintf("%sinc/phpmailer/", constant('PATH'));
498
499                 $mail->IsSMTP();
500                 $mail->SMTPAuth   = true;
501                 $mail->Host       = constant('SMTP_HOSTNAME');
502                 $mail->Port       = 25;
503                 $mail->Username   = constant('SMTP_USER');
504                 $mail->Password   = constant('SMTP_PASSWORD');
505                 if (empty($from)) {
506                         $mail->From = constant('WEBMASTER');
507                 } else {
508                         $mail->From = $from;
509                 }
510                 $mail->FromName   = constant('MAIN_TITLE');
511                 $mail->Subject    = $subject;
512                 if ((EXT_IS_ACTIVE("html_mail")) && (strip_tags($msg) != $msg)) {
513                         $mail->Body       = $msg;
514                         $mail->AltBody    = "Your mail program required HTML support to read this mail!";
515                         $mail->WordWrap   = 70;
516                         $mail->IsHTML(true);
517                 } else {
518                         $mail->Body       = decodeEntities($msg);
519                 }
520                 $mail->AddAddress($to, "");
521                 $mail->AddReplyTo(constant('WEBMASTER'), constant('MAIN_TITLE'));
522                 $mail->AddCustomHeader("Errors-To:".constant('WEBMASTER'));
523                 $mail->AddCustomHeader("X-Loop:".constant('WEBMASTER'));
524                 $mail->Send();
525         } else {
526                 // Use legacy mail() command
527                 @mail($to, $subject, decodeEntities($msg), $from);
528         }
529 }
530 //
531
532 // Generate a password in a specified length or use default password length
533 function GEN_PASS ($LEN = 0) {
534         // Auto-fix invalid length of zero
535         if ($LEN == 0) $LEN = getConfig('pass_len');
536
537         // Initialize array with all allowed chars
538         $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,-,+,_,/");
539
540         // Start creating password
541         $PASS = "";
542         for ($i = 0; $i < $LEN; $i++) {
543                 $PASS .= $ABC[mt_rand(0, sizeof($ABC) -1)];
544         } // END - for
545
546         // When the size is below 40 we can also add additional security by scrambling it
547         if (strlen($PASS) <= 40) {
548                 // Also scramble the password
549                 $PASS = scrambleString($PASS);
550         } // END - if
551
552         // Return the password
553         return $PASS;
554 }
555 //
556 function MAKE_DATETIME ($time, $mode="0")
557 {
558         if ($time == 0) {
559                 // Never happend
560                 return NEVER_HAPPENED;
561         } else {
562                 // Filter out numbers
563                 $time = bigintval($time);
564         }
565
566         switch (GET_LANGUAGE())
567         {
568         case "de": // German date / time format
569                 switch ($mode) {
570                         case "0": $ret = date("d.m.Y \u\m H:i \U\h\\r", $time); break;
571                         case "1": $ret = strtolower(date("d.m.Y - H:i", $time)); break;
572                         case "2": $ret = date("d.m.Y|H:i", $time); break;
573                         case "3": $ret = date("d.m.Y", $time); break;
574                         default:
575                                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
576                                 break;
577                 }
578                 break;
579
580         default:        // Default is the US date / time format!
581                 switch ($mode) {
582                         case "0": $ret = date("r", $time); break;
583                         case "1": $ret = date("Y-m-d - g:i A", $time); break;
584                         case "2": $ret = date("y-m-d|H:i", $time); break;
585                         case "3": $ret = date("y-m-d", $time); break;
586                         default:
587                                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Invalid date mode %s detected.", $mode));
588                                 break;
589                 }
590         }
591         return $ret;
592 }
593
594 // Translates the american decimal dot into a german comma
595 function TRANSLATE_COMMA ($dotted, $cut=true, $max=0) {
596         // Default is 3 you can change this in admin area "Misc -> Misc Options"
597         if (!isConfigEntrySet('max_comma')) setConfigEntry('max_comma', "3");
598
599         // Use from config is default
600         $maxComma = getConfig('max_comma');
601
602         // Use from parameter?
603         if ($max > 0) $maxComma = $max;
604
605         // Cut zeros off?
606         if (($cut) && ($max == 0)) {
607                 // Test for commata if in cut-mode
608                 $com = explode(".", $dotted);
609                 if (count($com) < 2) {
610                         // Don't display commatas even if there are none... ;-)
611                         $maxComma = 0;
612                 }
613         } // END - if
614
615         // Debug log
616         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, "dotted={$dotted},maxComma={$maxComma}");
617
618         // Translate it now
619         switch (GET_LANGUAGE()) {
620         case "de":
621                 $dotted = number_format($dotted, $maxComma, ",", ".");
622                 break;
623
624         default:
625                 $dotted = number_format($dotted, $maxComma, ".", ",");
626                 break;
627         }
628
629         // Return translated value
630         return $dotted;
631 }
632
633 //
634 function DEREFERER ($URL) {
635         // Don't de-refer our own links!
636         if (substr($URL, 0, strlen(URL)) != URL) {
637                 // De-refer this link
638                 $URL = "modules.php?module=loader&amp;url=".encodeString(compileUriCode($URL));
639         } // END - if
640
641         // Return link
642         return $URL;
643 }
644
645 // Translate Uni*-like gender to human-readable
646 function TRANSLATE_GENDER ($gender) {
647         // Default
648         $ret = "!{$gender}!";
649
650         // Male/female or company?
651         switch ($gender) {
652                 case "M": $ret = getMessage('GENDER_M'); break;
653                 case "F": $ret = getMessage('GENDER_F'); break;
654                 case "C": $ret = getMessage('GENDER_C'); break;
655                 default:
656                         // Log unknown gender
657                         DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Unknown gender %s detected.", $gender));
658                         break;
659         }
660
661         // Return translated gender
662         return $ret;
663 }
664
665 //
666 function FRAMETESTER ($URL) {
667         // Prepare frametester URL
668         $frametesterUrl = sprintf("%s/modules.php?module=frametester&amp;url=%s",
669                 URL,
670                 encodeString(compileUriCode($URL))
671         );
672         return $frametesterUrl;
673 }
674
675 //
676 function SELECTION_COUNT ($array) {
677         $ret = 0;
678         if (is_array($array)) {
679                 foreach ($array as $key => $selected) {
680                         if (!empty($selected)) $ret++;
681                 }
682         }
683         return $ret;
684 }
685 //
686 function IMG_CODE ($code, $type, $DATA, $uid) {
687         return "<IMG border=\"0\" alt=\"Code\" src=\"{!URL!}/mailid_top.php?uid=".$uid."&amp;".$type."=".$DATA."&amp;mode=img&amp;code=".$code."\">";
688 }
689 //
690 function TRANSLATE_STATUS ($status) {
691         switch ($status)
692         {
693         case "UNCONFIRMED":
694         case "CONFIRMED":
695         case "LOCKED":
696                 $ret = getMessage(sprintf("ACCOUNT_%s", $status));
697                 break;
698
699         case "":
700         case null:
701                 $ret = getMessage('ACCOUNT_DELETED');
702                 break;
703
704         default:
705                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Unknown status %s detected.", $status));
706                 $ret = sprintf(getMessage('UNKNOWN_STATUS"'), $status);
707                 break;
708         }
709
710         // Return it
711         return $ret;
712 }
713 //
714 function GET_LANGUAGE() {
715         // Set default return value to default language from config
716         $ret = constant('DEFAULT_LANG');
717
718         // Init variable
719         $lang = "";
720
721         // Is the variable set
722         if (REQUEST_ISSET_GET(('mx_lang'))) {
723                 // Accept only first 2 chars
724                 $lang = substr(REQUEST_GET('mx_lang'), 0, 2);
725         } elseif (isset($GLOBALS['cache_array']['language'])) {
726                 // Use cached
727                 $ret = $GLOBALS['cache_array']['language'];
728         } elseif (!empty($lang)) {
729                 // Check if main language file does exist
730                 if (FILE_READABLE(constant('PATH')."inc/language/".$lang.".php")) {
731                         // Okay found, so let's update cookies
732                         SET_LANGUAGE($lang);
733                 }
734         } elseif (!isSessionVariableSet('mx_lang')) {
735                 // Return stored value from cookie
736                 $ret = get_session('mx_lang');
737
738                 // Fixes a warning before the session has the mx_lang constant
739                 if (empty($ret)) $ret = constant('DEFAULT_LANG');
740         }
741
742         // Cache entry
743         $GLOBALS['cache_array']['language'] = $ret;
744
745         // Return value
746         return $ret;
747 }
748 //
749 function SET_LANGUAGE ($lang) {
750         // Accept only first 2 chars!
751         $lang = substr(SQL_ESCAPE(strip_tags($lang)), 0, 2);
752
753         // Set cookie
754         set_session('mx_lang', $lang);
755 }
756 //
757 function LOAD_EMAIL_TEMPLATE($template, $content=array(), $UID="0") {
758         global $DATA, $_CONFIG;
759
760         // Make sure all template names are lowercase!
761         $template = strtolower($template);
762
763         // Default "nickname" if extension is not installed
764         $nick = "---";
765
766         // Prepare IP number and User Agent
767         $REMOTE_ADDR     = GET_REMOTE_ADDR();
768         $HTTP_USER_AGENT = GET_USER_AGENT();
769
770         // Default admin
771         $ADMIN = constant('MAIN_TITLE');
772
773         // Is the admin logged in?
774         if (IS_ADMIN()) {
775                 // Get admin id
776                 $aid = GET_CURRENT_ADMIN_ID();
777
778                 // Load Admin data
779                 $ADMIN = GET_ADMIN_EMAIL($aid);
780         } // END - if
781
782         // Neutral email address is default
783         $email = constant('WEBMASTER');
784
785         // Expiration in a nice output format
786         if (getConfig('auto_purge') == 0) {
787                 // Will never expire!
788                 $EXPIRATION = getMessage('MAIL_WILL_NEVER_EXPIRE');
789         } else {
790                 // Create nice date string
791                 $EXPIRATION = CREATE_FANCY_TIME(getConfig('auto_purge'));
792         }
793
794         // Is content an array?
795         if (is_array($content)) {
796                 // Add expiration to array, $EXPIRATION is now deprecated!
797                 $content['expiration'] = $EXPIRATION;
798         } // END - if
799
800         // Load user's data
801         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):UID={$UID},template={$template},content[]=".gettype($content)."<br />\n";
802         if (($UID > 0) && (is_array($content))) {
803                 // If nickname extension is installed, fetch nickname as well
804                 if (EXT_IS_ACTIVE("nickname")) {
805                         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):NICKNAME!<br />\n";
806                         // Load nickname
807                         $result = SQL_QUERY_ESC("SELECT surname, family, gender, email, nickname FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
808                                 array(bigintval($UID)), __FUNCTION__, __LINE__);
809                 } else {
810                         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):NO-NICK!<br />\n";
811                         /// Load normal data
812                         $result = SQL_QUERY_ESC("SELECT surname, family, gender, email FROM `{!_MYSQL_PREFIX!}_user_data` WHERE userid=%s LIMIT 1",
813                                 array(bigintval($UID)), __FUNCTION__, __LINE__);
814                 }
815
816                 // Fetch and merge data
817                 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):content()=".count($content)." - PRE<br />\n";
818                 $content = merge_array($content, SQL_FETCHARRAY($result));
819                 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):content()=".count($content)." - AFTER<br />\n";
820
821                 // Free result
822                 SQL_FREERESULT($result);
823         } // END - if
824
825         // Translate M to male or F to female if present
826         if (isset($content['gender'])) $content['gender'] = TRANSLATE_GENDER($content['gender']);
827
828         // Overwrite email from data if present
829         if (isset($content['email'])) $email = $content['email'];
830
831         // Store email for some functions in global data array
832         $DATA['email'] = $email;
833
834         // Base directory
835         $BASE = sprintf("%stemplates/%s/emails/", constant('PATH'), GET_LANGUAGE());
836
837         // Check for admin/guest/member templates
838         if (strpos($template, "admin_") > -1) {
839                 // Admin template found
840                 $FQFN = $BASE."admin/".$template.".tpl";
841         } elseif (strpos($template, "guest_") > -1) {
842                 // Guest template found
843                 $FQFN = $BASE."guest/".$template.".tpl";
844         } elseif (strpos($template, "member_") > -1) {
845                 // Member template found
846                 $FQFN = $BASE."member/".$template.".tpl";
847         } else {
848                 // Test for extension
849                 $test = substr($template, 0, strpos($template, "_"));
850                 if (EXT_IS_ACTIVE($test)) {
851                         // Set extra path to extension's name
852                         $FQFN = $BASE.$test."/".$template.".tpl";
853                 } else {
854                         // No special filename
855                         $FQFN = $BASE.$template.".tpl";
856                 }
857         }
858
859         // Does the special template exists?
860         if (!FILE_READABLE($FQFN)) {
861                 // Reset to default template
862                 $FQFN = $BASE.$template.".tpl";
863         } // END - if
864
865         // Now does the final template exists?
866         $newContent = "";
867         if (FILE_READABLE($FQFN)) {
868                 // The local file does exists so we load it. :)
869                 $tmpl_file = READ_FILE($FQFN);
870                 $tmpl_file = SQL_ESCAPE($tmpl_file);
871
872                 // Run code
873                 $tmpl_file = "\$newContent = decodeEntities(\"".COMPILE_CODE($tmpl_file)."\");";
874                 eval($tmpl_file);
875         } elseif (!empty($template)) {
876                 // Template file not found!
877                 $newContent = "{--TEMPLATE_404--}: ".$template."<br />
878 {--TEMPLATE_CONTENT--}
879 <pre>".print_r($content, true)."</pre>
880 {--TEMPLATE_DATA--}
881 <pre>".print_r($DATA, true)."</pre>
882 <br /><br />";
883
884                 // Debug mode not active? Then remove the HTML tags
885                 if (!isDebugModeEnabled()) $newContent = strip_tags($newContent);
886         } else {
887                 // No template name supplied!
888                 $newContent = getMessage('NO_TEMPLATE_SUPPLIED');
889         }
890
891         // Is there some content?
892         if (empty($newContent)) {
893                 // Compiling failed
894                 $newContent = "Compiler error for template {$template}!\nUncompiled content:\n".$tmpl_file;
895                 // Add last error if the required function exists
896                 if (function_exists('error_get_last')) $newContent .= "\n--------------------------------------\nDebug:\n".print_r(error_get_last(), true)."--------------------------------------\nPlease don't alter these informations!\nThanx.";
897         } // END - if
898
899         // Remove content and data
900         unset($content);
901         unset($DATA);
902
903         // Return compiled content
904         return COMPILE_CODE($newContent);
905 }
906 //
907 function MAKE_TIME ($H, $M, $S, $stamp) {
908         // Extract day, month and year from given timestamp
909         $DAY   = date("d", $stamp);
910         $MONTH = date("m", $stamp);
911         $YEAR  = date('Y', $stamp);
912
913         // Create timestamp for wished time which depends on extracted date
914         return mktime($H, $M, $S, $MONTH, $DAY, $YEAR);
915 }
916 //
917 function LOAD_URL ($URL, $addUrlData=true) {
918         // Compile out URI codes
919         $URL = compileUriCode($URL);
920
921         // Check if http(s):// is there
922         if ((substr($URL, 0, 7) != "http://") && (substr($URL, 0, 8) != "https://")) {
923                 // Make all URLs full-qualified
924                 $URL = "".$URL;
925         }
926
927         // Get output buffer
928         //* DEBUG: */ debug_report_bug(sprintf("%s[%s:] URL=%s", __FUNCTION__, __LINE__, $URL));
929         //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, $URL);
930         $OUTPUT = ob_get_contents();
931
932         // Clear it only if there is content
933         if (!empty($OUTPUT)) {
934                 clearOutputBuffer();
935         } // END - if
936
937         // Add some data to URL if cookies are not accepted
938         if (((!defined('__COOKIES')) || (!constant('__COOKIES'))) && ($addUrlData)) $URL = ADD_URL_DATA($URL);
939
940         // Probe for bot from search engine
941         if ((eregi("spider", GET_USER_AGENT())) || (eregi("bot", GET_USER_AGENT()))) {
942                 // Search engine bot detected so let's rewrite many chars for the link
943                 $URL = htmlentities(strip_tags($URL), ENT_QUOTES);
944
945                 // Output new location link as anchor
946                 OUTPUT_HTML("<a href=\"".$URL."\">".$URL."</a>");
947         } elseif (!headers_sent()) {
948                 // Load URL when headers are not sent
949                 //* DEBUG: */ debug_report_bug("URL={$URL}");
950                 header ("Location: ".str_replace("&amp;", "&", $URL));
951         } else {
952                 // Output error message
953                 LOAD_INC("inc/header.php");
954                 LOAD_TEMPLATE("redirect_url", false, str_replace("&amp;", "&", $URL));
955                 LOAD_INC("inc/footer.php");
956         }
957         exit();
958 }
959
960 // Wrapper for LOAD_URL but URL comes from a configuration entry
961 function LOAD_CONFIGURED_URL ($configEntry) {
962         // Get the URL
963         $URL = getConfig($configEntry);
964
965         // Is this URL set?
966         if (is_null($URL)) {
967                 // Then abort here
968                 trigger_error(sprintf("Configuration entry %s is not set!", $configEntry));
969         } // END - if
970
971         // Load the URL
972         LOAD_URL($URL);
973 }
974
975 //
976 function COMPILE_CODE ($code, $simple = false, $constants = true, $full = true) {
977         // Is the code a string?
978         if (!is_string($code)) {
979                 // Silently return it
980                 return $code;
981         } // END - if
982
983         $ARRAY = $GLOBALS['security_chars'];
984
985         // Select smaller set of chars to replace when we e.g. want to compile URLs
986         if (!$full) $ARRAY = $GLOBALS['url_chars'];
987
988         // Compile constants
989         if ($constants) {
990                 // BEFORE 0.2.1 : Language and data constants
991                 // WITH 0.2.1+  : Only language constants
992                 $code = str_replace('{--','".', str_replace('--}','."', $code));
993
994                 // BEFORE 0.2.1 : Not used
995                 // WITH 0.2.1+  : Data constants
996                 $code = str_replace('{!','".', str_replace("!}", '."', $code));
997         } // END - if
998
999         // Compile QUOT and other non-HTML codes
1000         foreach ($ARRAY['to'] as $k => $to) {
1001                 // Do the reversed thing as in inc/libs/security_functions.php
1002                 $code = str_replace($to, $ARRAY['from'][$k], $code);
1003         } // END - foreach
1004
1005         // But shall I keep simple quotes for later use?
1006         if ($simple) $code = str_replace("'", '{QUOT}', $code);
1007
1008         // Find $content[bla][blub] entries
1009         @preg_match_all('/\$(content|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
1010
1011         // Are some matches found?
1012         if ((count($matches) > 0) && (count($matches[0]) > 0)) {
1013                 // Replace all matches
1014                 $matchesFound = array();
1015                 foreach ($matches[0] as $key => $match) {
1016                         // Fuzzy look has failed by default
1017                         $fuzzyFound = false;
1018
1019                         // Fuzzy look on match if already found
1020                         foreach ($matchesFound as $found => $set) {
1021                                 // Get test part
1022                                 $test = substr($found, 0, strlen($match));
1023
1024                                 // Does this entry exist?
1025                                 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):found={$found},match={$match},set={$set}<br />\n";
1026                                 if ($test == $match) {
1027                                         // Match found!
1028                                         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):fuzzyFound!<br />\n";
1029                                         $fuzzyFound = true;
1030                                         break;
1031                                 } // END - if
1032                         } // END - foreach
1033
1034                         // Skip this entry?
1035                         if ($fuzzyFound) continue;
1036
1037                         // Take all string elements
1038                         if ((is_string($matches[4][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key."_".$matches[4][$key]]))) {
1039                                 // Replace it in the code
1040                                 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):key={$key},match={$match}<br />\n";
1041                                 $newMatch = str_replace("[".$matches[4][$key]."]", "['".$matches[4][$key]."']", $match);
1042                                 $code = str_replace($match, "\".".$newMatch.".\"", $code);
1043                                 $matchesFound[$key."_".$matches[4][$key]] = 1;
1044                                 $matchesFound[$match] = 1;
1045                         } elseif (!isset($matchesFound[$match])) {
1046                                 // Not yet replaced!
1047                                 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):match={$match}<br />\n";
1048                                 $code = str_replace($match, "\".".$match.".\"", $code);
1049                                 $matchesFound[$match] = 1;
1050                         }
1051                 } // END - foreach
1052         } // END - if
1053
1054         // Return compiled code
1055         return $code;
1056 }
1057 //
1058 /************************************************************************
1059  *                                                                      *
1060  * Gaenderter Sortier-Algorythmus, $array wird nach dem Array (!)       *
1061  * $a_sort sortiert:                                                    *
1062  *                                                                      *
1063  * $array - Das 3-dimensionale Array, das paralell sortiert werden soll *
1064  * $a_sort - Array, das die Sortiereihenfolge der ersten Elementeben    *
1065  * $primary_key - Prim.rschl.ssel aus $a_sort, nach dem sortiert wird   *
1066  * $order - Sortiereihenfolge: -1 = a-Z, 0 = keine, 1 = Z-a             *
1067  * $nums - true = Als Zahlen sortieren, false = Als Zeichen sortieren   *
1068  *                                                                      *
1069  * $a_sort muss Elemente enthalten, deren Wert Schluessel von $array    *
1070  * sind... Klingt kompliziert, suchen Sie mal mein Beispiel, dann sehen *
1071  * Sie, dass es doch nicht so schwer ist! :-)                           *
1072  *                                                                      *
1073  ************************************************************************/
1074 function array_pk_sort (&$array, $a_sort, $primary_key = 0, $order = -1, $nums = false) {
1075         $dummy = $array;
1076         while ($primary_key < count($a_sort)) {
1077                 foreach ($dummy[$a_sort[$primary_key]] as $key => $value) {
1078                         foreach ($dummy[$a_sort[$primary_key]] as $key2 => $value2) {
1079                                 $match = false;
1080                                 if (!$nums) {
1081                                         // Sort byte-by-byte (also numbers will be interpreted as chars! E.g.: "9" > "10")
1082                                         if (($key != $key2) && (strcmp(strtolower($dummy[$a_sort[$primary_key]][$key]), strtolower($dummy[$a_sort[$primary_key]][$key2])) == $order)) $match = true;
1083                                 } elseif ($key != $key2) {
1084                                         // Sort numbers (E.g.: 9 < 10)
1085                                         if (($dummy[$a_sort[$primary_key]][$key] < $dummy[$a_sort[$primary_key]][$key2]) && ($order == -1)) $match = true;
1086                                         if (($dummy[$a_sort[$primary_key]][$key] > $dummy[$a_sort[$primary_key]][$key2]) && ($order == 1))  $match = true;
1087                                 }
1088
1089                                 if ($match) {
1090                                         // We have found two different values, so let's sort whole array
1091                                         foreach ($dummy as $sort_key => $sort_val) {
1092                                                 $t                       = $dummy[$sort_key][$key];
1093                                                 $dummy[$sort_key][$key]  = $dummy[$sort_key][$key2];
1094                                                 $dummy[$sort_key][$key2] = $t;
1095                                                 unset($t);
1096                                         } // END - foreach
1097                                 } // END - if
1098                         } // END - foreach
1099                 } // END - foreach
1100
1101                 // Count one up
1102                 $primary_key++;
1103         } // END - while
1104
1105         // Write back sorted array
1106         $array = $dummy;
1107 }
1108
1109 //
1110 function ADD_SELECTION ($type, $DEFAULT, $prefix="", $id="0") {
1111         global $MONTH_DESCR;
1112         $OUT = "";
1113
1114         if ($type == "yn") {
1115                 // This is a yes/no selection only!
1116                 if ($id > 0) $prefix .= "[".$id."]";
1117                 $OUT .= "    <select name=\"".$prefix."\" class=\"register_select\" size=\"1\">\n";
1118         } else {
1119                 // Begin with regular selection box here
1120                 if (!empty($prefix)) $prefix .= "_";
1121                 $type2 = $type;
1122                 if ($id > 0) $type2 .= "[".$id."]";
1123                 $OUT .= "    <select name=\"".strtolower($prefix.$type2)."\" class=\"register_select\" size=\"1\">\n";
1124         }
1125
1126         switch ($type) {
1127         case "day": // Day
1128                 for ($idx = 1; $idx < 32; $idx++) {
1129                         $OUT .= "<option value=\"".$idx."\"";
1130                         if ($DEFAULT == $idx) $OUT .= " selected=\"selected\"";
1131                         $OUT .= ">".$idx."</option>\n";
1132                 } // END - for
1133                 break;
1134
1135         case "month": // Month
1136                 foreach ($MONTH_DESCR as $month => $descr) {
1137                         $OUT .= "<option value=\"".$month."\"";
1138                         if ($DEFAULT == $month) $OUT .= " selected=\"selected\"";
1139                         $OUT .= ">".$descr."</option>\n";
1140                 } // END - for
1141                 break;
1142
1143         case "year": // Year
1144                 // Get current year
1145                 $YEAR = date('Y', time());
1146
1147                 // Use configured min age or fixed?
1148                 if (GET_EXT_VERSION("other") >= "0.2.1") {
1149                         // Configured
1150                         $startYear = $YEAR - getConfig('min_age');
1151                 } else {
1152                         // Fixed 16 years
1153                         $startYear = $YEAR - 16;
1154                 }
1155
1156                 // Calculate earliest year (100 years old people can still enter Internet???)
1157                 $minYear = $YEAR - 100;
1158
1159                 // Check if the default value is larger than minimum and bigger than actual year
1160                 if (($DEFAULT > $minYear) && ($DEFAULT >= $YEAR)) {
1161                         for ($idx = $YEAR; $idx < ($YEAR + 11); $idx++) {
1162                                 $OUT .= "<option value=\"".$idx."\"";
1163                                 if ($DEFAULT == $idx) $OUT .= " selected=\"selected\"";
1164                                 $OUT .= ">".$idx."</option>\n";
1165                         } // END - for
1166                 } elseif ($DEFAULT == -1) {
1167                         // Current year minus 1
1168                         for ($idx = $startYear; $idx <= ($YEAR + 1); $idx++)
1169                         {
1170                                 $OUT .= "<option value=\"".$idx."\">".$idx."</option>\n";
1171                         }
1172                 } else {
1173                         // Get current year and subtract the configured minimum age
1174                         $OUT .= "<option value=\"".($minYear - 1)."\">&lt;".$minYear."</option>\n";
1175                         // Calculate earliest year depending on extension version
1176                         if (GET_EXT_VERSION("other") >= "0.2.1") {
1177                                 // Use configured minimum age
1178                                 $YEAR = date('Y', time()) - getConfig('min_age');
1179                         } else {
1180                                 // Use fixed 16 years age
1181                                 $YEAR = date('Y', time()) - 16;
1182                         }
1183
1184                         // Construct year selection list
1185                         for ($idx = $minYear; $idx <= $YEAR; $idx++) {
1186                                 $OUT .= "<option value=\"".$idx."\"";
1187                                 if ($DEFAULT == $idx) $OUT .= " selected=\"selected\"";
1188                                 $OUT .= ">".$idx."</option>\n";
1189                         } // END - for
1190                 }
1191                 break;
1192
1193         case "sec":
1194         case "min":
1195                 for ($idx = 0; $idx < 60; $idx+=5) {
1196                         if (strlen($idx) == 1) $idx = "0".$idx;
1197                         $OUT .= "<option value=\"".$idx."\"";
1198                         if ($DEFAULT == $idx) $OUT .= " selected=\"selected\"";
1199                         $OUT .= ">".$idx."</option>\n";
1200                 } // END - for
1201                 break;
1202
1203         case "hour":
1204                 for ($idx = 0; $idx < 24; $idx++) {
1205                         if (strlen($idx) == 1) $idx = "0".$idx;
1206                         $OUT .= "<option value=\"".$idx."\"";
1207                         if ($DEFAULT == $idx) $OUT .= " selected=\"selected\"";
1208                         $OUT .= ">".$idx."</option>\n";
1209                 } // END - for
1210                 break;
1211
1212         case "yn":
1213                 $OUT .= "<option value=\"Y\"";
1214                 if ($DEFAULT == "Y") $OUT .= " selected=\"selected\"";
1215                 $OUT .= ">{--YES--}</option>\n<option value=\"N\"";
1216                 if ($DEFAULT == "N") $OUT .= " selected=\"selected\"";
1217                 $OUT .= ">{--NO--}</option>\n";
1218                 break;
1219         }
1220         $OUT .= "    </select>\n";
1221         return $OUT;
1222 }
1223
1224 //
1225 function TRANSLATE_YESNO ($yn) {
1226         // Default
1227         $translated = "??? (".$yn.")";
1228         switch ($yn) {
1229                 case "Y": $translated = getMessage('YES'); break;
1230                 case "N": $translated = getMessage('NO'); break;
1231                 default:
1232                         // Log unknown value
1233                         DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Unknown value %s. Expected Y/N!", $yn));
1234                         break;
1235         }
1236
1237         // Return it
1238         return $translated;
1239 }
1240
1241 //
1242 // Deprecated : $length
1243 // Optional   : $DATA
1244 //
1245 function generateRandomCodde ($length, $code, $uid, $DATA="") {
1246         // Fix missing _MAX constant
1247         // @TODO Rewrite this unnice code
1248         if (!defined('_MAX')) define('_MAX', 15235);
1249
1250         // Build server string
1251         $server = $_SERVER['PHP_SELF'].":".GET_USER_AGENT().":".getenv('SERVER_SOFTWARE').":".GET_REMOTE_ADDR().":".":".filemtime(constant('PATH')."inc/databases.php");
1252
1253         // Build key string
1254         $keys   = constant('SITE_KEY').":".constant('DATE_KEY');
1255         if (isConfigEntrySet('secret_key'))  $keys .= ":".getConfig('secret_key');
1256         if (isConfigEntrySet('file_hash'))   $keys .= ":".getConfig('file_hash');
1257         $keys .= ":".date("d-m-Y (l-F-T)", getConfig(('patch_ctime')));
1258         if (isConfigEntrySet('master_salt')) $keys .= ":".getConfig('master_salt');
1259
1260         // Build string from misc data
1261         $data   = $code.":".$uid.":".$DATA;
1262
1263         // Add more additional data
1264         if (isSessionVariableSet('u_hash'))                     $data .= ":".get_session('u_hash');
1265         if (isset($GLOBALS['userid']))                          $data .= ":".$GLOBALS['userid'];
1266         if (isSessionVariableSet('mxchange_theme'))             $data .= ":".get_session('mxchange_theme');
1267         if (isSessionVariableSet('mx_lang'))                    $data .= ":".GET_LANGUAGE();
1268         if (isset($GLOBALS['refid']))                                   $data .= ":".$GLOBALS['refid'];
1269
1270         // Calculate number for generating the code
1271         $a = $code + constant('_ADD') - 1;
1272
1273         if (isConfigEntrySet('master_hash')) {
1274                 // Generate hash with master salt from modula of number with the prime number and other data
1275                 $saltedHash = generateHash(($a % constant('_PRIME')).":".$server.":".$keys.":".$data.":".date("d-m-Y (l-F-T)", time()).":".$a, getConfig('master_salt'));
1276
1277                 // Create number from hash
1278                 $rcode = hexdec(substr($saltedHash, strlen(getConfig('master_salt')), 9)) / abs(constant('_MAX') - $a + sqrt(constant('_ADD'))) / pi();
1279         } else {
1280                 // Generate hash with "hash of site key" from modula of number with the prime number and other data
1281                 $saltedHash = generateHash(($a % constant('_PRIME')).":".$server.":".$keys.":".$data.":".date("d-m-Y (l-F-T)", time()).":".$a, substr(sha1(constant('SITE_KEY')), 0, 8));
1282
1283                 // Create number from hash
1284                 $rcode = hexdec(substr($saltedHash, 8, 9)) / abs(constant('_MAX') - $a + sqrt(constant('_ADD'))) / pi();
1285         }
1286
1287         // At least 10 numbers shall be secure enought!
1288         $len = getConfig('code_length');
1289         if ($len == 0) $len = $length;
1290         if ($len == 0) $len = 10;
1291
1292         // Cut off requested counts of number
1293         $return = substr(str_replace('.', "", $rcode), 0, $len);
1294
1295         // Done building code
1296         return $return;
1297 }
1298
1299 // Does only allow numbers
1300 function bigintval ($num, $castValue = true) {
1301         // Filter all numbers out
1302         $ret = preg_replace("/[^0123456789]/", "", $num);
1303
1304         // Shall we cast?
1305         if ($castValue) $ret = (double)$ret;
1306
1307         // Has the whole value changed?
1308         // @TODO Remove this if() block if all is working fine
1309         if ("".$ret."" != "".$num."") {
1310                 // Log the values
1311                 debug_report_bug("{$ret}<>{$num}");
1312         } // END - if
1313
1314         // Return result
1315         return $ret;
1316 }
1317
1318 // Insert the code in $img_code into jpeg or PNG image
1319 function GENERATE_IMAGE ($img_code, $headerSent=true) {
1320         if ((strlen($img_code) > 6) || (empty($img_code)) || (getConfig('code_length') == 0)) {
1321                 // Stop execution of function here because of over-sized code length
1322                 return;
1323         } elseif (!$headerSent) {
1324                 // Return in an HTML code code
1325                 return "<img src=\"{!URL!}/img.php?code=".$img_code."\" alt=\"Image\" />\n";
1326         }
1327
1328         // Load image
1329         $img = sprintf("%s/theme/%s/images/code_bg.%s", constant('PATH'), GET_CURR_THEME(), getConfig('img_type'));
1330         if (FILE_READABLE($img)) {
1331                 // Switch image type
1332                 switch (getConfig('img_type'))
1333                 {
1334                 case "jpg":
1335                         // Okay, load image and hide all errors
1336                         $image = @imagecreatefromjpeg($img);
1337                         break;
1338
1339                 case "png":
1340                         // Okay, load image and hide all errors
1341                         $image = @imagecreatefrompng($img);
1342                         break;
1343                 }
1344         } else {
1345                 // Exit function here
1346                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("File for image type %s not found.", getConfig('img_type')));
1347                 return;
1348         }
1349
1350         // Generate text color (red/green/blue; 0 = dark, 255 = bright)
1351         $text_color = imagecolorallocate($image, 0, 0, 0);
1352
1353         // Insert code into image
1354         imagestring($image, 5, 14, 2, $img_code, $text_color);
1355
1356         // Return to browser
1357         header ("Content-Type: image/".getConfig('img_type'));
1358
1359         // Output image with matching image factory
1360         switch (getConfig('img_type')) {
1361                 case "jpg": imagejpeg($image); break;
1362                 case "png": imagepng($image);  break;
1363         }
1364
1365         // Remove image from memory
1366         imagedestroy($image);
1367 }
1368 // Create selection box or array of splitted timestamp
1369 function CREATE_TIME_SELECTIONS ($timestamp, $prefix="", $display="", $align="center", $return_array=false) {
1370         // Calculate 2-seconds timestamp
1371         $stamp = round($timestamp);
1372         //* DEBUG: */ print("*".$stamp."/".$timestamp."*<br />");
1373
1374         // Do we have a leap year?
1375         $SWITCH = 0;
1376         $TEST = date('Y', time()) / 4;
1377         $M1 = date("m", time());
1378         $M2 = date("m", (time() + $timestamp));
1379
1380         // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
1381         if ((floor($TEST) == $TEST) && ($M1 == "02") && ($M2 > "02"))  $SWITCH = getConfig('one_day');
1382
1383         // First of all years...
1384         $Y = abs(floor($timestamp / (31536000 + $SWITCH)));
1385         //* DEBUG: */ print("Y={$Y}<br />\n");
1386         // Next months...
1387         $M = abs(floor($timestamp / 2628000 - $Y * 12));
1388         //* DEBUG: */ print("M={$M}<br />\n");
1389         // Next weeks
1390         $W = abs(floor($timestamp / 604800 - $Y * ((365 + $SWITCH / getConfig('one_day')) / 7) - ($M / 12 * (365 + $SWITCH / getConfig('one_day')) / 7)));
1391         //* DEBUG: */ print("W={$W}<br />\n");
1392         // Next days...
1393         $D = abs(floor($timestamp / 86400 - $Y * (365 + $SWITCH / getConfig('one_day')) - ($M / 12 * (365 + $SWITCH / getConfig('one_day'))) - $W * 7));
1394         //* DEBUG: */ print("D={$D}<br />\n");
1395         // Next hours...
1396         $h = abs(floor($timestamp / 3600 - $Y * (365 + $SWITCH / getConfig('one_day')) * 24 - ($M / 12 * (365 + $SWITCH / getConfig('one_day')) * 24) - $W * 7 * 24 - $D * 24));
1397         //* DEBUG: */ print("h={$h}<br />\n");
1398         // Next minutes..
1399         $m = abs(floor($timestamp / 60 - $Y * (365 + $SWITCH / getConfig('one_day')) * 24 * 60 - ($M / 12 * (365 + $SWITCH / getConfig('one_day')) * 24 * 60) - $W * 7 * 24 * 60 - $D * 24 * 60 - $h * 60));
1400         //* DEBUG: */ print("m={$m}<br />\n");
1401         // And at last seconds...
1402         $s = abs(floor($timestamp - $Y * (365 + $SWITCH / getConfig('one_day')) * 24 * 3600 - ($M / 12 * (365 + $SWITCH / getConfig('one_day')) * 24 * 3600) - $W * 7 * 24 * 3600 - $D * 24 * 3600 - $h * 3600 - $m * 60));
1403         //* DEBUG: */ print("s={$s}<br />\n");
1404
1405         // Is seconds zero and time is < 60 seconds?
1406         if (($s == 0) && ($timestamp < 60)) {
1407                 // Fix seconds
1408                 $s = round($timestamp);
1409         } // END - if
1410
1411         //
1412         // Now we convert them in seconds...
1413         //
1414         if ($return_array) {
1415                 // Just put all data in an array for later use
1416                 $OUT = array(
1417                         'YEARS'   => $Y,
1418                         'MONTHS'  => $M,
1419                         'WEEKS'   => $W,
1420                         'DAYS'    => $D,
1421                         'HOURS'   => $h,
1422                         'MINUTES' => $m,
1423                         'SECONDS' => $s
1424                 );
1425         } else {
1426                 // Generate table
1427                 $OUT  = "<div align=\"".$align."\">\n";
1428                 $OUT .= "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\" class=\"admin_table dashed\">\n";
1429                 $OUT .= "<tr>\n";
1430
1431                 if (ereg('Y', $display) || (empty($display))) {
1432                         $OUT .= "  <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_YEARS--}</strong></td>\n";
1433                 }
1434
1435                 if (ereg("M", $display) || (empty($display))) {
1436                         $OUT .= "  <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_MONTHS--}</strong></td>\n";
1437                 }
1438
1439                 if (ereg("W", $display) || (empty($display))) {
1440                         $OUT .= "  <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_WEEKS--}</strong></td>\n";
1441                 }
1442
1443                 if (ereg("D", $display) || (empty($display))) {
1444                         $OUT .= "  <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_DAYS--}</strong></td>\n";
1445                 }
1446
1447                 if (ereg("h", $display) || (empty($display))) {
1448                         $OUT .= "  <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_HOURS--}</strong></td>\n";
1449                 }
1450
1451                 if (ereg("m", $display) || (empty($display))) {
1452                         $OUT .= "  <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_MINUTES--}</strong></td>\n";
1453                 }
1454
1455                 if (ereg("s", $display) || (empty($display))) {
1456                         $OUT .= "  <td align=\"center\" class=\"admin_title bottom\"><div class=\"tiny\">{--_SECONDS--}</strong></td>\n";
1457                 }
1458
1459                 $OUT .= "</tr>\n";
1460                 $OUT .= "<tr>\n";
1461
1462                 if (ereg('Y', $display) || (empty($display))) {
1463                         // Generate year selection
1464                         $OUT .= "  <td align=\"center\"><select class=\"mini_select\" name=\"".$prefix."_ye\" size=\"1\">\n";
1465                         for ($idx = 0; $idx <= 10; $idx++) {
1466                                 $OUT .= "    <option class=\"mini_select\" value=\"".$idx."\"";
1467                                 if ($idx == $Y) $OUT .= " selected=\"selected\"";
1468                                 $OUT .= ">".$idx."</option>\n";
1469                         }
1470                         $OUT .= "  </select></td>\n";
1471                 } else {
1472                         $OUT .= "<INPUT type=\"hidden\" name=\"".$prefix."_ye\" value=\"0\" />\n";
1473                 }
1474
1475                 if (ereg("M", $display) || (empty($display))) {
1476                         // Generate month selection
1477                         $OUT .= "  <td align=\"center\"><select class=\"mini_select\" name=\"".$prefix."_mo\" size=\"1\">\n";
1478                         for ($idx = 0; $idx <= 11; $idx++)
1479                         {
1480                                         $OUT .= "  <option class=\"mini_select\" value=\"".$idx."\"";
1481                                 if ($idx == $M) $OUT .= " selected=\"selected\"";
1482                                 $OUT .= ">".$idx."</option>\n";
1483                         }
1484                         $OUT .= "  </select></td>\n";
1485                 } else {
1486                         $OUT .= "<INPUT type=\"hidden\" name=\"".$prefix."_mo\" value=\"0\" />\n";
1487                 }
1488
1489                 if (ereg("W", $display) || (empty($display))) {
1490                         // Generate week selection
1491                         $OUT .= "  <td align=\"center\"><select class=\"mini_select\" name=\"".$prefix."_we\" size=\"1\">\n";
1492                         for ($idx = 0; $idx <= 4; $idx++) {
1493                                 $OUT .= "  <option class=\"mini_select\" value=\"".$idx."\"";
1494                                 if ($idx == $W) $OUT .= " selected=\"selected\"";
1495                                 $OUT .= ">".$idx."</option>\n";
1496                         }
1497                         $OUT .= "  </select></td>\n";
1498                 } else {
1499                         $OUT .= "<INPUT type=\"hidden\" name=\"".$prefix."_we\" value=\"0\" />\n";
1500                 }
1501
1502                 if (ereg("D", $display) || (empty($display))) {
1503                         // Generate day selection
1504                         $OUT .= "  <td align=\"center\"><select class=\"mini_select\" name=\"".$prefix."_da\" size=\"1\">\n";
1505                         for ($idx = 0; $idx <= 31; $idx++) {
1506                                 $OUT .= "  <option class=\"mini_select\" value=\"".$idx."\"";
1507                                 if ($idx == $D) $OUT .= " selected=\"selected\"";
1508                                 $OUT .= ">".$idx."</option>\n";
1509                         }
1510                         $OUT .= "  </select></td>\n";
1511                 } else {
1512                         $OUT .= "<INPUT type=\"hidden\" name=\"".$prefix."_da\" value=\"0\">\n";
1513                 }
1514
1515                 if (ereg("h", $display) || (empty($display))) {
1516                         // Generate hour selection
1517                         $OUT .= "  <td align=\"center\"><select class=\"mini_select\" name=\"".$prefix."_ho\" size=\"1\">\n";
1518                         for ($idx = 0; $idx <= 23; $idx++)      {
1519                                 $OUT .= "  <option class=\"mini_select\" value=\"".$idx."\"";
1520                                 if ($idx == $h) $OUT .= " selected=\"selected\"";
1521                                 $OUT .= ">".$idx."</option>\n";
1522                         }
1523                         $OUT .= "  </select></td>\n";
1524                 } else {
1525                         $OUT .= "<INPUT type=\"hidden\" name=\"".$prefix."_ho\" value=\"0\">\n";
1526                 }
1527
1528                 if (ereg("m", $display) || (empty($display))) {
1529                         // Generate minute selection
1530                         $OUT .= "  <td align=\"center\"><select class=\"mini_select\" name=\"".$prefix."_mi\" size=\"1\">\n";
1531                         for ($idx = 0; $idx <= 59; $idx++) {
1532                                 $OUT .= "  <option class=\"mini_select\" value=\"".$idx."\"";
1533                                 if ($idx == $m) $OUT .= " selected=\"selected\"";
1534                                 $OUT .= ">".$idx."</option>\n";
1535                         }
1536                         $OUT .= "  </select></td>\n";
1537                 } else {
1538                         $OUT .= "<INPUT type=\"hidden\" name=\"".$prefix."_mi\" value=\"0\">\n";
1539                 }
1540
1541                 if (ereg("s", $display) || (empty($display))) {
1542                         // Generate second selection
1543                         $OUT .= "  <td align=\"center\"><select class=\"mini_select\" name=\"".$prefix."_se\" size=\"1\">\n";
1544                         for ($idx = 0; $idx <= 59; $idx++) {
1545                                 $OUT .= "  <option class=\"mini_select\" value=\"".$idx."\"";
1546                                 if ($idx == $s) $OUT .= " selected=\"selected\"";
1547                                 $OUT .= ">".$idx."</option>\n";
1548                         }
1549                         $OUT .= "  </select></td>\n";
1550                 } else {
1551                         $OUT .= "<INPUT type=\"hidden\" name=\"".$prefix."_se\" value=\"0\">\n";
1552                 }
1553                 $OUT .= "</tr>\n";
1554                 $OUT .= "</table>\n";
1555                 $OUT .= "</div>\n";
1556                 // Return generated HTML code
1557         }
1558         return $OUT;
1559 }
1560
1561 //
1562 function CREATE_TIMESTAMP_FROM_SELECTIONS ($prefix, $POST) {
1563         // Initial return value
1564         $ret = 0;
1565
1566         // Do we have a leap year?
1567         $SWITCH = 0;
1568         $TEST = date('Y', time()) / 4;
1569         $M1   = date("m", time());
1570         // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
1571         if ((floor($TEST) == $TEST) && ($M1 == "02") && ($POST[$prefix."_mo"] > "02"))  $SWITCH = getConfig('one_day');
1572         // First add years...
1573         $ret += $POST[$prefix."_ye"] * (31536000 + $SWITCH);
1574         // Next months...
1575         $ret += $POST[$prefix."_mo"] * 2628000;
1576         // Next weeks
1577         $ret += $POST[$prefix."_we"] * 604800;
1578         // Next days...
1579         $ret += $POST[$prefix."_da"] * 86400;
1580         // Next hours...
1581         $ret += $POST[$prefix."_ho"] * 3600;
1582         // Next minutes..
1583         $ret += $POST[$prefix."_mi"] * 60;
1584         // And at last seconds...
1585         $ret += $POST[$prefix."_se"];
1586         // Return calculated value
1587         return $ret;
1588 }
1589
1590 // Sends out mail to all administrators
1591 // IMPORTANT: Please use SEND_ADMIN_NOTIFCATION() for now!
1592 function SEND_ADMIN_EMAILS_PRO ($subj, $template, $content, $UID) {
1593         // Trim template name
1594         $template = trim($template);
1595
1596         // Load email template
1597         $msg = LOAD_EMAIL_TEMPLATE($template, $content, $UID);
1598
1599         if (EXT_VERSION_IS_OLDER("admins", "0.4.0")) {
1600                 // Older version detected!
1601                 return SEND_ADMIN_EMAILS($subj, $msg);
1602         } // END - if
1603
1604         // Check which admin shall receive this mail
1605         $result = SQL_QUERY_ESC("SELECT DISTINCT admin_id FROM `{!_MYSQL_PREFIX!}_admins_mails` WHERE mail_template='%s' ORDER BY admin_id",
1606                 array($template), __FUNCTION__, __LINE__);
1607         if (SQL_NUMROWS($result) == 0) {
1608                 // Create new entry (to all admins)
1609                 SQL_QUERY_ESC("INSERT INTO `{!_MYSQL_PREFIX!}_admins_mails` (admin_id, mail_template) VALUES (0, '%s')",
1610                         array($template), __FUNCTION__, __LINE__);
1611         } else {
1612                 // Load admin IDs...
1613                 $aids = array();
1614                 while (list($aid) = SQL_FETCHROW($result)) {
1615                         $aids[] = $aid;
1616                 } // END - while
1617
1618                 // Free memory
1619                 SQL_FREERESULT($result);
1620
1621                 // Init result
1622                 $result = false;
1623
1624                 // "implode" IDs and query string
1625                 $aid = implode(",", $aids);
1626                 if ($aid == "-1") {
1627                         if (EXT_IS_ACTIVE("events")) {
1628                                 // Add line to user events
1629                                 EVENTS_ADD_LINE($subj, $msg, $UID);
1630                         } else {
1631                                 // Log error for debug
1632                                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Extension 'events' missing: tpl=%s,subj=%s,UID=%s",
1633                                         $template,
1634                                         $subj,
1635                                         $UID
1636                                 ));
1637                         }
1638                 } elseif ($aid == "0") {
1639                         // Select all email adresses
1640                         $result = SQL_QUERY("SELECT email FROM `{!_MYSQL_PREFIX!}_admins` ORDER BY `id`", __FUNCTION__, __LINE__);
1641                 } else {
1642                         // If Admin-ID is not "to-all" select
1643                         $result = SQL_QUERY_ESC("SELECT email FROM `{!_MYSQL_PREFIX!}_admins` WHERE id IN (%s) ORDER BY `id`", array($aid), __FUNCTION__, __LINE__);
1644                 }
1645         }
1646
1647         // Load email addresses and send away
1648         while (list($email) = SQL_FETCHROW($result)) {
1649                 SEND_EMAIL($email, $subj, $msg);
1650         } // END - while
1651
1652         // Free memory
1653         SQL_FREERESULT($result);
1654 }
1655
1656 //
1657 function CREATE_FANCY_TIME ($stamp) {
1658         // Get data array with years/months/weeks/days/...
1659         $data = CREATE_TIME_SELECTIONS($stamp, "", "", "", true);
1660         $ret = "";
1661         foreach($data as $k => $v) {
1662                 if ($v > 0) {
1663                         // Value is greater than 0 "eval" data to return string
1664                         $eval = "\$ret .= \", \".\$v.\" {--_".strtoupper($k)."--}\";";
1665                         eval($eval);
1666                         break;
1667                 } // END - if
1668         } // END - foreach
1669
1670         // Do we have something there?
1671         if (strlen($ret) > 0) {
1672                 // Remove leading commata and space
1673                 $ret = substr($ret, 2);
1674         } else {
1675                 // Zero seconds
1676                 $ret = "0 {--_SECONDS--}";
1677         }
1678
1679         // Return fancy time string
1680         return $ret;
1681 }
1682
1683 //
1684 function ADD_EMAIL_NAV ($PAGES, $offset, $show_form, $colspan, $return=false) {
1685         $SEP = ""; $TOP = "";
1686         if (!$show_form) {
1687                 $TOP = " top2";
1688                 $SEP = "<tr><td colspan=\"".$colspan."\" class=\"seperator\">&nbsp;</td></tr>";
1689         }
1690
1691         $NAV = "";
1692         for ($page = 1; $page <= $PAGES; $page++) {
1693                 // Is the page currently selected or shall we generate a link to it?
1694                 if (($page == REQUEST_GET('page')) || ((!REQUEST_ISSET_GET(('page'))) && ($page == "1"))) {
1695                         // Is currently selected, so only highlight it
1696                         $NAV .= "<strong>-";
1697                 } else {
1698                         // Open anchor tag and add base URL
1699                         $NAV .= "<a href=\"{!URL!}/modules.php?module=admin&amp;what=".$GLOBALS['what']."&amp;page=".$page."&amp;offset=".$offset;
1700
1701                         // Add userid when we shall show all mails from a single member
1702                         if ((REQUEST_ISSET_GET(('uid'))) && (bigintval(REQUEST_GET('uid')) > 0)) $NAV .= "&amp;uid=".bigintval(REQUEST_GET('uid'));
1703
1704                         // Close open anchor tag
1705                         $NAV .= "\">";
1706                 }
1707                 $NAV .= $page;
1708                 if (($page == REQUEST_GET('page')) || ((!REQUEST_ISSET_GET(('page'))) && ($page == "1"))) {
1709                         // Is currently selected, so only highlight it
1710                         $NAV .= "-</strong>";
1711                 } else {
1712                         // Close anchor tag
1713                         $NAV .= "</a>";
1714                 }
1715
1716                 // Add seperator if we have not yet reached total pages
1717                 if ($page < $PAGES) $NAV .= "&nbsp;|&nbsp;";
1718         }
1719
1720         // Define constants only once
1721         if (!defined('__NAV_OUTPUT')) {
1722                 define('__NAV_OUTPUT' , $NAV);
1723                 define('__NAV_COLSPAN', $colspan);
1724                 define('__NAV_TOP'    , $TOP);
1725                 define('__NAV_SEP'    , $SEP);
1726         }
1727
1728         // Load navigation template
1729         $OUT = LOAD_TEMPLATE("admin_email_nav_row", true);
1730
1731         if ($return) {
1732                 // Return generated HTML-Code
1733                 return $OUT;
1734         } else {
1735                 // Output HTML-Code
1736                 OUTPUT_HTML($OUT);
1737         }
1738 }
1739
1740 // Extract host from script name
1741 function EXTRACT_HOST (&$script) {
1742         // Use default SERVER_URL by default... ;) So?
1743         $url = constant('SERVER_URL');
1744
1745         // Is this URL valid?
1746         if (substr($script, 0, 7) == "http://") {
1747                 // Use the hostname from script URL as new hostname
1748                 $url = substr($script, 7);
1749                 $extract = explode("/", $url);
1750                 $url = $extract[0];
1751                 // Done extracting the URL :)
1752         } // END - if
1753
1754         // Extract host name
1755         $host = str_replace("http://", "", $url);
1756         if (ereg("/", $host)) $host = substr($host, 0, strpos($host, "/"));
1757
1758         // Generate relative URL
1759         //* DEBUG: */ print("SCRIPT=".$script."<br />\n");
1760         if (substr(strtolower($script), 0, 7) == "http://") {
1761                 // But only if http:// is in front!
1762                 $script = substr($script, (strlen($url) + 7));
1763         } elseif (substr(strtolower($script), 0, 8) == "https://") {
1764                 // Does this work?!
1765                 $script = substr($script, (strlen($url) + 8));
1766         }
1767
1768         //* DEBUG: */ print("SCRIPT=".$script."<br />\n");
1769         if (substr($script, 0, 1) == "/") $script = substr($script, 1);
1770
1771         // Return host name
1772         return $host;
1773 }
1774
1775 // Send a GET request
1776 function GET_URL ($script) {
1777         // Compile the script name
1778         $script = COMPILE_CODE($script);
1779
1780         // Extract host name from script
1781         $host = EXTRACT_HOST($script);
1782
1783         // Generate GET request header
1784         $request  = "GET /" . trim($script) . " HTTP/1.1\r\n";
1785         $request .= "Host: " . $host . "\r\n";
1786         $request .= "Referer: " . constant('URL') . "/admin.php\r\n";
1787         $request .= "User-Agent: " . constant('TITLE') . "/" . constant('FULL_VERSION') . "\r\n";
1788         $request .= "Content-Type: text/plain\r\n";
1789         $request .= "Cache-Control: no-cache\r\n";
1790         $request .= "Connection: Close\r\n\r\n";
1791
1792         // Send the raw request
1793         $response = SEND_RAW_REQUEST($host, $request);
1794
1795         // Return the result to the caller function
1796         return $response;
1797 }
1798
1799 // Send a POST request
1800 function POST_URL ($script, $postData) {
1801         // Is postData an array?
1802         if (!is_array($postData)) {
1803                 // Abort here
1804                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("postData is not an array. Type: %s", gettype($postData)));
1805                 return array("", "", "");
1806         } // END - if
1807
1808         // Compile the script name
1809         $script = COMPILE_CODE($script);
1810
1811         // Extract host name from script
1812         $host = EXTRACT_HOST($script);
1813
1814         // Construct request
1815         $data = http_build_query($postData, '','&');
1816
1817         // Generate POST request header
1818         $request  = "POST /" . trim($script) . " HTTP/1.1\r\n";
1819         $request .= "Host: " . $host . "\r\n";
1820         $request .= "Referer: " . constant('URL') . "/admin.php\r\n";
1821         $request .= "User-Agent: " . constant('TITLE') . "/" . constant('FULL_VERSION') . "\r\n";
1822         $request .= "Content-type: application/x-www-form-urlencoded\r\n";
1823         $request .= "Content-length: " . strlen($data) . "\r\n";
1824         $request .= "Cache-Control: no-cache\r\n";
1825         $request .= "Connection: Close\r\n\r\n";
1826         $request .= $data;
1827
1828         // Send the raw request
1829         $response = SEND_RAW_REQUEST($host, $request);
1830
1831         // Return the result to the caller function
1832         return $response;
1833 }
1834
1835 // Sends a raw request to another host
1836 function SEND_RAW_REQUEST ($host, $request) {
1837         // Initialize array
1838         $response = array("", "", "");
1839
1840         // Default is not to use proxy
1841         $useProxy = false;
1842
1843         // Are proxy settins set?
1844         if ((getConfig('proxy_host') != "") && (getConfig('proxy_port') > 0)) {
1845                 // Then use it
1846                 $useProxy = true;
1847         } // END - if
1848
1849         // Open connection
1850         //* DEBUG: */ die("SCRIPT=".$script."<br />\n");
1851         if ($useProxy) {
1852                 $fp = @fsockopen(COMPILE_CODE(getConfig('proxy_host')), getConfig('proxy_port'), $errno, $errdesc, 30);
1853         } else {
1854                 $fp = @fsockopen($host, 80, $errno, $errdesc, 30);
1855         }
1856
1857         // Is there a link?
1858         if (!is_resource($fp)) {
1859                 // Failed!
1860                 return $response;
1861         } // END - if
1862
1863         // Do we use proxy?
1864         if ($useProxy) {
1865                 // Generate CONNECT request header
1866                 $proxyTunnel  = "CONNECT ".$host.":80 HTTP/1.1\r\n";
1867                 $proxyTunnel .= "Host: ".$host."\r\n";
1868
1869                 // Use login data to proxy? (username at least!)
1870                 if (getConfig('proxy_username') != "") {
1871                         // Add it as well
1872                         $encodedAuth = base64_encode(COMPILE_CODE(getConfig('proxy_username')).":".COMPILE_CODE(getConfig('proxy_password')));
1873                         $proxyTunnel .= "Proxy-Authorization: Basic ".$encodedAuth."\r\n";
1874                 } // END - if
1875
1876                 // Add last new-line
1877                 $proxyTunnel .= "\r\n";
1878                 //* DEBUG: */ print("<strong>proxyTunnel=</strong><pre>".$proxyTunnel."</pre>");
1879
1880                 // Write request
1881                 fputs($fp, $proxyTunnel);
1882
1883                 // Got response?
1884                 if (feof($fp)) {
1885                         // No response received
1886                         return $response;
1887                 } // END - if
1888
1889                 // Read the first line
1890                 $resp = trim(fgets($fp, 10240));
1891                 $respArray = explode(" ", $resp);
1892                 if ((strtolower($respArray[0]) !== "http/1.0") || ($respArray[1] != "200")) {
1893                         // Invalid response!
1894                         return $response;
1895                 } // END - if
1896         } // END - if
1897
1898         // Write request
1899         fputs($fp, $request);
1900
1901         // Read response
1902         while(!feof($fp)) {
1903                 $response[] = trim(fgets($fp, 1024));
1904         } // END - while
1905
1906         // Close socket
1907         fclose($fp);
1908
1909         // Skip first empty lines
1910         $resp = $response;
1911         foreach ($resp as $idx => $line) {
1912                 // Trim space away
1913                 $line = trim($line);
1914
1915                 // Is this line empty?
1916                 if (empty($line)) {
1917                         // Then remove it
1918                         array_shift($response);
1919                 } else {
1920                         // Abort on first non-empty line
1921                         break;
1922                 }
1923         } // END - foreach
1924
1925         //* DEBUG: */ print("<strong>Response:</strong><pre>".print_r($response, true)."</pre>");
1926
1927         // Proxy agent found?
1928         if ((substr(strtolower($response[0]), 0, 11) == "proxy-agent") && ($useProxy)) {
1929                 // Proxy header detected, so remove two lines
1930                 array_shift($response);
1931                 array_shift($response);
1932         } // END - if
1933
1934         // Was the request successfull?
1935         if ((!eregi("200 OK", $response[0])) || (empty($response[0]))) {
1936                 // Not found / access forbidden
1937                 $response = array("", "", "");
1938         } // END - if
1939
1940         // Return response
1941         return $response;
1942 }
1943
1944 // Taken from www.php.net eregi() user comments
1945 function VALIDATE_EMAIL($email) {
1946         // Compile email
1947         $email = COMPILE_CODE($email);
1948
1949         // Check first part of email address
1950         $first = "[-a-z0-9!#$%&\'*+/=?^_<{|}~]+(\.[-a-zA-Z0-9!#$%&\'*+/=?^_<{|}~]+)*";
1951
1952         //  Check domain
1953         $domain = "[a-z0-9-]+(\.[a-z0-9-]{2,5})+";
1954
1955         // Generate pattern
1956         $regex = "^".$first."@".$domain."$";
1957
1958         // Return check result
1959         return eregi($regex, $email);
1960 }
1961
1962 // Function taken from user comments on www.php.net / function eregi()
1963 function VALIDATE_URL ($URL, $compile=true) {
1964         // Trim URL a little
1965         $URL = trim(urldecode($URL));
1966         //* DEBUG: */ echo $URL."<br />";
1967
1968         // Compile some chars out...
1969         if ($compile) $URL = compileUriCode($URL, false, false, false);
1970         //* DEBUG: */ echo $URL."<br />";
1971
1972         // Check for the extension filter
1973         if (EXT_IS_ACTIVE("filter")) {
1974                 // Use the extension's filter set
1975                 return FILTER_VALIDATE_URL($URL, false);
1976         }
1977
1978         // If not installed, perform a simple test. Just make it sure there is always a http:// or
1979         // https:// in front of the URLs
1980         return isUrlValid($URL);
1981 }
1982
1983 // Generate a list of administrative links to a given userid
1984 function MEMBER_ACTION_LINKS ($uid, $status = "") {
1985         // Define all main targets
1986         $TARGETS = array("del_user", "edit_user", "lock_user", "add_points", "sub_points");
1987
1988         // Begin of navigation links
1989         $eval = "\$OUT = \"[&nbsp;";
1990
1991         foreach ($TARGETS as $tar) {
1992                 $eval .= "<span class=\\\"admin_user_link\\\"><a href=\\\"{!URL!}/modules.php?module=admin&amp;what=".$tar."&amp;uid=".$uid."\\\" title=\\\"{--ADMIN_LINK_";
1993                 //* DEBUG: */ echo "*".$tar."/".$status."*<br />\n";
1994                 if (($tar == "lock_user") && ($status == "LOCKED")) {
1995                         // Locked accounts shall be unlocked
1996                         $eval .= "UNLOCK_USER";
1997                 } else {
1998                         // All other status is fine
1999                         $eval .= strtoupper($tar);
2000                 }
2001                 $eval .= "_TITLE--}\\\">{--ADMIN_";
2002                 if (($tar == "lock_user") && ($status == "LOCKED")) {
2003                         // Locked accounts shall be unlocked
2004                         $eval .= "UNLOCK_USER";
2005                 } else {
2006                         // All other status is fine
2007                         $eval .= strtoupper($tar);
2008                 }
2009                 $eval .= "--}</a></span>&nbsp;|&nbsp;";
2010         }
2011
2012         // Finish navigation link
2013         $eval = substr($eval, 0, -7)."]\";";
2014         eval($eval);
2015
2016         // Return string
2017         return $OUT;
2018 }
2019
2020 // Generate an email link
2021 function CREATE_EMAIL_LINK ($email, $table = "admins") {
2022         // Default email link (INSECURE! Spammer can read this by harvester programs)
2023         $EMAIL = "mailto:".$email;
2024
2025         // Check for several extensions
2026         if ((EXT_IS_ACTIVE("admins")) && ($table == "admins")) {
2027                 // Create email link for contacting admin in guest area
2028                 $EMAIL = ADMINS_CREATE_EMAIL_LINK($email);
2029         } elseif ((EXT_IS_ACTIVE("user")) && (GET_EXT_VERSION("user") >= "0.3.3") && ($table == "user_data")) {
2030                 // Create email link for contacting a member within admin area (or later in other areas, too?)
2031                 $EMAIL = USER_CREATE_EMAIL_LINK($email);
2032         } elseif ((EXT_IS_ACTIVE("sponsor")) && ($table == "sponsor_data")) {
2033                 // Create email link to contact sponsor within admin area (or like the link above?)
2034                 $EMAIL = SPONSOR_CREATE_EMAIL_LINK($email);
2035         }
2036
2037         // Shall I close the link when there is no admin?
2038         if ((!IS_ADMIN()) && ($EMAIL == $email)) $EMAIL = "#"; // Closed!
2039
2040         // Return email link
2041         return $EMAIL;
2042 }
2043
2044 // Generate a hash for extra-security for all passwords
2045 function generateHash ($plainText, $salt = "") {
2046         global $_SERVER;
2047
2048         // Is the required extension "sql_patches" there and a salt is not given?
2049         if (((EXT_VERSION_IS_OLDER("sql_patches", "0.3.6")) || (!EXT_IS_ACTIVE("sql_patches"))) && (empty($salt))) {
2050                 // Extension sql_patches is missing/outdated so we hash the plain text with MD5
2051                 return md5($plainText);
2052         } // END - if
2053
2054         // Do we miss an arry element here?
2055         if (!isConfigEntrySet('file_hash')) {
2056                 // Stop here
2057                 debug_report_bug("Missing file_hash in ".__FUNCTION__.".");
2058         } // END - if
2059
2060         // When the salt is empty build a new one, else use the first x configured characters as the salt
2061         if (empty($salt)) {
2062                 // Build server string
2063                 $server = $_SERVER['PHP_SELF'].":".GET_USER_AGENT().":".getenv('SERVER_SOFTWARE').":".GET_REMOTE_ADDR().":".":".filemtime(constant('PATH')."inc/databases.php");
2064
2065                 // Build key string
2066                 $keys   = constant('SITE_KEY').":".constant('DATE_KEY').":".getConfig('secret_key').":".getConfig('file_hash').":".date("d-m-Y (l-F-T)", getConfig(('patch_ctime'))).":".getConfig('master_salt');
2067
2068                 // Additional data
2069                 $data = $plainText.":".uniqid(mt_rand(), true).":".time();
2070
2071                 // Calculate number for generating the code
2072                 $a = time() + constant('_ADD') - 1;
2073
2074                 // Generate SHA1 sum from modula of number and the prime number
2075                 $sha1 = sha1(($a % constant('_PRIME')).$server.":".$keys.":".$data.":".date("d-m-Y (l-F-T)", time()).":".$a);
2076                 //* DEBUG: */ echo "SHA1=".$sha1." (".strlen($sha1).")<br />";
2077                 $sha1 = scrambleString($sha1);
2078                 //* DEBUG: */ echo "Scrambled=".$sha1." (".strlen($sha1).")<br />";
2079                 //* DEBUG: */ $sha1b = descrambleString($sha1);
2080                 //* DEBUG: */ echo "Descrambled=".$sha1b." (".strlen($sha1b).")<br />";
2081
2082                 // Generate the password salt string
2083                 $salt = substr($sha1, 0, getConfig('salt_length'));
2084                 //* DEBUG: */ echo $salt." (".strlen($salt).")<br />";
2085         } else {
2086                 // Use given salt
2087                 $salt = substr($salt, 0, getConfig('salt_length'));
2088                 //* DEBUG: */ echo "GIVEN={$salt}<br />\n";
2089         }
2090
2091         // Return hash
2092         return $salt.sha1($salt.$plainText);
2093 }
2094
2095 // Scramble a string
2096 function scrambleString($str) {
2097         // Init
2098         $scrambled = "";
2099
2100         // Final check, in case of failture it will return unscrambled string
2101         if (strlen($str) > 40) {
2102                 // The string is to long
2103                 return $str;
2104         } elseif (strlen($str) == 40) {
2105                 // From database
2106                 $scrambleNums = explode(":", getConfig('pass_scramble'));
2107         } else {
2108                 // Generate new numbers
2109                 $scrambleNums = explode(":", genScrambleString(strlen($str)));
2110         }
2111
2112         // Scramble string here
2113         //* DEBUG: */ echo "***Original=".$str."***<br />";
2114         for ($idx = 0; $idx < strlen($str); $idx++) {
2115                 // Get char on scrambled position
2116                 $char = substr($str, $scrambleNums[$idx], 1);
2117
2118                 // Add it to final output string
2119                 $scrambled .= $char;
2120         } // END - for
2121
2122         // Return scrambled string
2123         //* DEBUG: */ echo "***Scrambled=".$scrambled."***<br />";
2124         return $scrambled;
2125 }
2126
2127 // De-scramble a string scrambled by scrambleString()
2128 function descrambleString($str) {
2129         // Scramble only 40 chars long strings
2130         if (strlen($str) != 40) return $str;
2131
2132         // Load numbers from config
2133         $scrambleNums = explode(":", getConfig('pass_scramble'));
2134
2135         // Validate numbers
2136         if (count($scrambleNums) != 40) return $str;
2137
2138         // Begin descrambling
2139         $orig = str_repeat(" ", 40);
2140         //* DEBUG: */ echo "+++Scrambled=".$str."+++<br />";
2141         for ($idx = 0; $idx < 40; $idx++) {
2142                 $char = substr($str, $idx, 1);
2143                 $orig = substr_replace($orig, $char, $scrambleNums[$idx], 1);
2144         } // END - for
2145
2146         // Return scrambled string
2147         //* DEBUG: */ echo "+++Original=".$orig."+++<br />";
2148         return $orig;
2149 }
2150
2151 // Generated a "string" for scrambling
2152 function genScrambleString ($len) {
2153         // Prepare array for the numbers
2154         $scrambleNumbers = array();
2155
2156         // First we need to setup randomized numbers from 0 to 31
2157         for ($idx = 0; $idx < $len; $idx++) {
2158                 // Generate number
2159                 $rand = mt_rand(0, ($len -1));
2160
2161                 // Check for it by creating more numbers
2162                 while (array_key_exists($rand, $scrambleNumbers)) {
2163                         $rand = mt_rand(0, ($len -1));
2164                 } // END - while
2165
2166                 // Add number
2167                 $scrambleNumbers[$rand] = $rand;
2168         } // END - for
2169
2170         // So let's create the string for storing it in database
2171         $scrambleString = implode(":", $scrambleNumbers);
2172         return $scrambleString;
2173 }
2174
2175 // Append data like session ID or referal ID to the given URL which would
2176 // normally be stored in cookies
2177 function ADD_URL_DATA ($URL) {
2178         // Init add
2179         $ADD = "";
2180
2181         // Determine URL binder
2182         $BIND = "?";
2183         if (strpos($URL, "?") !== false) $BIND = "&amp;";
2184
2185         if ((!defined('__COOKIES')) || ((!__COOKIES))) {
2186                 // Cookies are not accepted
2187                 if ((REQUEST_ISSET_GET(('refid'))) && (strpos($URL, "refid=") == 0)) {
2188                         // Cookie found in URL
2189                         $ADD .= $BIND."refid=".bigintval(REQUEST_GET('refid'));
2190                 } elseif ((GET_EXT_VERSION("sql_patches") != '') && (getConfig('def_refid') > 0)) {
2191                         // Not found! So let's set default here
2192                         $ADD .= $BIND."refid=".getConfig('def_refid');
2193                 }
2194         } // END - if
2195
2196         // Add all together and return it
2197         return $URL . $ADD;
2198 }
2199
2200 // Generate an PGP-like encrypted hash of given hash for e.g. cookies
2201 function generatePassString ($passHash) {
2202         // Return vanilla password hash
2203         $ret = $passHash;
2204
2205         // Is a secret key and master salt already initialized?
2206         if ((getConfig('secret_key') != "") && (getConfig('master_salt') != "")) {
2207                 // Only calculate when the secret key is generated
2208                 $newHash = ""; $start = 9;
2209                 for ($idx = 0; $idx < 10; $idx++) {
2210                         $part1 = hexdec(substr($passHash, $start, 4));
2211                         $part2 = hexdec(substr(getConfig('secret_key'), $start, 4));
2212                         $mod = dechex($idx);
2213                         if ($part1 > $part2) {
2214                                 $mod = dechex(sqrt(($part1 - $part2) * constant('_PRIME') / pi()));
2215                         } elseif ($part2 > $part1) {
2216                                 $mod = dechex(sqrt(($part2 - $part1) * constant('_PRIME') / pi()));
2217                         }
2218                         $mod = substr(round($mod), 0, 4);
2219                         $mod = str_repeat('0', 4-strlen($mod)).$mod;
2220                         //* DEBUG: */ echo "*".$start."=".$mod."*<br />";
2221                         $start += 4;
2222                         $newHash .= $mod;
2223                 } // END - for
2224
2225                 //* DEBUG: */ print($passHash."<br />".$newHash." (".strlen($newHash).")");
2226                 $ret = generateHash($newHash, getConfig('master_salt'));
2227                 //* DEBUG: */ print($ret."<br />\n");
2228         } else {
2229                 // Hash it simple
2230                 //* DEBUG: */ echo "--".$passHash."--<br />\n";
2231                 $ret = md5($passHash);
2232                 //* DEBUG: */ echo "++".$ret."++<br />\n";
2233         }
2234
2235         // Return result
2236         return $ret;
2237 }
2238
2239 // Fix "deleted" cookies
2240 function FIX_DELETED_COOKIES ($cookies) {
2241         // Is this an array with entries?
2242         if ((is_array($cookies)) && (count($cookies) > 0)) {
2243                 // Then check all cookies if they are marked as deleted!
2244                 foreach ($cookies as $cookieName) {
2245                         // Is the cookie set to "deleted"?
2246                         if (get_session($cookieName) == "deleted") {
2247                                 set_session($cookieName, "");
2248                         }
2249                 } // END - foreach
2250         } // END - if
2251 }
2252
2253 // Output error messages in a fasioned way and die...
2254 function mxchange_die ($msg) {
2255         // Load header
2256         LOAD_INC_ONCE("inc/header.php");
2257
2258         // Load the message template
2259         LOAD_TEMPLATE("admin_settings_saved", false, $msg);
2260
2261         // Load footer
2262         LOAD_INC_ONCE("inc/footer.php");
2263
2264         // Exit explicitly
2265         exit;
2266 }
2267
2268 // Display parsing time and number of SQL queries in footer
2269 function DISPLAY_PARSING_TIME_FOOTER() {
2270         // Is the timer started?
2271         if (!isset($GLOBALS['startTime'])) {
2272                 // Abort here
2273                 return false;
2274         } // END - if
2275
2276         // Get end time
2277         $endTime = microtime(true);
2278
2279         // "Explode" both times
2280         $start = explode(" ", $GLOBALS['startTime']);
2281         $end = explode(" ", $endTime);
2282         $runTime = $end[0] - $start[0];
2283         if ($runTime < 0) $runTime = 0;
2284         $runTime = TRANSLATE_COMMA($runTime);
2285
2286         // Prepare output
2287         $content = array(
2288                 'runtime'               => $runTime,
2289                 'numSQLs'               => (getConfig('sql_count') + 1),
2290                 'numTemplates'  => (getConfig('num_templates') + 1)
2291         );
2292
2293         // Load the template
2294         LOAD_TEMPLATE("show_timings", false, $content);
2295 }
2296
2297 // Check wether a boolean constant is set
2298 // Taken from user comments in PHP documentation for function constant()
2299 function isBooleanConstantAndTrue ($constName) { // : Boolean
2300         // Failed by default
2301         $res = false;
2302
2303         // In cache?
2304         if (isset($GLOBALS['cache_array']['const'][$constName])) {
2305                 // Use cache
2306                 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ".$constName."-CACHE!<br />\n";
2307                 $res = ($GLOBALS['cache_array']['const'][$constName] === true);
2308         } else {
2309                 // Check constant
2310                 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ".$constName."-RESOLVE!<br />\n";
2311                 if (defined($constName)) {
2312                         // Found!
2313                         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): ".$constName."-FOUND!<br />\n";
2314                         $res = (constant($constName) === true);
2315                 } // END - if
2316
2317                 // Set cache
2318                 $GLOBALS['cache_array']['const'][$constName] = $res;
2319         }
2320         //* DEBUG: */ var_dump($res);
2321
2322         // Return value
2323         return $res;
2324 }
2325
2326 // Checks if a given apache module is loaded
2327 function IF_APACHE_MODULE_LOADED ($apacheModule) {
2328         // Check it and return result
2329         return (((function_exists('apache_get_modules')) && (in_array($apacheModule, apache_get_modules()))) || (!function_exists('apache_get_modules')));
2330 }
2331
2332 // "Getter" for language strings
2333 // @TODO Rewrite all language constants to this function.
2334 function getMessage ($messageId) {
2335         // Default is not found!
2336         $return = "!".$messageId."!";
2337
2338         // Is the language string found?
2339         if (isset($GLOBALS['msg'][strtolower($messageId)])) {
2340                 // Language array element found in small_letters
2341                 $return = $GLOBALS['msg'][$messageId];
2342         } elseif (isset($GLOBALS['msg'][strtoupper($messageId)])) {
2343                 // @DEPRECATED Language array element found in BIG_LETTERS
2344                 $return = $GLOBALS['msg'][$messageId];
2345         } elseif (defined($messageId)) {
2346                 // @DEPRECATED Deprecated constant found
2347                 $return = constant($messageId);
2348         } else {
2349                 // Missing language constant
2350                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Missing message string %s detected.", $messageId));
2351         }
2352
2353         // Return the string
2354         return $return;
2355 }
2356
2357 // Get current theme name
2358 function GET_CURR_THEME() {
2359         global $INC_POOL;
2360
2361         // The default theme is 'default'... ;-)
2362         $ret = "default";
2363
2364         // Load default theme if not empty from configuration
2365         if (getConfig('default_theme') != "") $ret = getConfig('default_theme');
2366
2367         if (!isSessionVariableSet('mxchange_theme')) {
2368                 // Set default theme
2369                 set_session('mxchange_theme', $ret);
2370         } elseif ((isSessionVariableSet('mxchange_theme')) && (GET_EXT_VERSION("sql_patches") >= "0.1.4")) {
2371                 //die("<pre>".print_r($GLOBALS['cache_array']['themes'], true)."</pre>");
2372                 // Get theme from cookie
2373                 $ret = get_session('mxchange_theme');
2374
2375                 // Is it valid?
2376                 if (THEME_GET_ID($ret) == 0) {
2377                         // Fix it to default
2378                         $ret = "default";
2379                 } // END - if
2380         } elseif ((!isInstalled()) && ((isInstalling()) || ($GLOBALS['output_mode'] == true)) && ((REQUEST_ISSET_GET(('theme'))) || (REQUEST_ISSET_POST(('theme'))))) {
2381                 // Prepare FQFN for checking
2382                 $theme = sprintf("%stheme/%s/theme.php", constant('PATH'), REQUEST_GET(('theme')));
2383
2384                 // Installation mode active
2385                 if ((REQUEST_ISSET_GET(('theme'))) && (FILE_READABLE($theme))) {
2386                         // Set cookie from URL data
2387                         set_session('mxchange_theme', REQUEST_GET(('theme')));
2388                 } elseif (FILE_READABLE(sprintf("%stheme/%s/theme.php", constant('PATH'), SQL_ESCAPE(REQUEST_POST('theme'))))) {
2389                         // Set cookie from posted data
2390                         set_session('mxchange_theme', SQL_ESCAPE(REQUEST_POST('theme')));
2391                 }
2392
2393                 // Set return value
2394                 $ret = get_session('mxchange_theme');
2395         } else {
2396                 // Invalid design, reset cookie
2397                 set_session('mxchange_theme', $ret);
2398         }
2399
2400         // Add (maybe) found theme.php file to inclusion list
2401         $theme = sprintf("%stheme/%s/theme.php", constant('PATH'), SQL_ESCAPE($ret));
2402
2403         // Try to load the requested include file
2404         if (FILE_READABLE($theme)) $INC_POOL[] = $theme;
2405
2406         // Return theme value
2407         return $ret;
2408 }
2409
2410 // Get id from theme
2411 function THEME_GET_ID ($name) {
2412         // Is the extension "theme" installed?
2413         if (!EXT_IS_ACTIVE("theme")) {
2414                 // Then abort here
2415                 return 0;
2416         } // END - if
2417
2418         // Default id
2419         $id = 0;
2420
2421         // Is the cache entry there?
2422         if (isset($GLOBALS['cache_array']['themes']['id'][$name])) {
2423                 // Get the version from cache
2424                 $id = $GLOBALS['cache_array']['themes']['id'][$name];
2425
2426                 // Count up
2427                 incrementConfigEntry('cache_hits');
2428         } elseif (GET_EXT_VERSION("cache") != "0.1.8") {
2429                 // Check if current theme is already imported or not
2430                 $result = SQL_QUERY_ESC("SELECT id FROM `{!_MYSQL_PREFIX!}_themes` WHERE theme_path='%s' LIMIT 1",
2431                         array($name), __FUNCTION__, __LINE__);
2432
2433                 // Entry found?
2434                 if (SQL_NUMROWS($result) == 1) {
2435                         // Fetch data
2436                         list($id) = SQL_FETCHROW($result);
2437                 } // END - if
2438
2439                 // Free result
2440                 SQL_FREERESULT($result);
2441         }
2442
2443         // Return id
2444         return $id;
2445 }
2446
2447 // Read a given file
2448 function READ_FILE ($FQFN, $sqlPrepare = false) {
2449         // Load the file
2450         if (function_exists('file_get_contents')) {
2451                 // Use new function
2452                 $content = file_get_contents($FQFN);
2453         } else {
2454                 // Fall-back to implode-file chain
2455                 $content = implode("", file($FQFN));
2456         }
2457
2458         // Prepare SQL queries?
2459         if ($sqlPrepare === true) {
2460                 // Remove some unwanted chars
2461                 $content = str_replace("\r", "", $content);
2462                 $content = str_replace("\n\n", "\n", $content);
2463         } // END - if
2464
2465         // Return the content
2466         return $content;
2467 }
2468
2469 // Writes content to a file
2470 function WRITE_FILE ($FQFN, $content) {
2471         // Is the file writeable?
2472         if ((FILE_READABLE($FQFN)) && (!is_writeable($FQFN)) && (!chmod($FQFN, 0644))) {
2473                 // Not writeable!
2474                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("File %s not writeable.", basename($FQFN)));
2475
2476                 // Failed! :(
2477                 return false;
2478         } // END - if
2479
2480         // By default all is failed...
2481         $return = false;
2482
2483         // Is the function there?
2484         if (function_exists('file_put_contents')) {
2485                 // Write it directly
2486                 $return = file_put_contents($FQFN, $content);
2487         } else {
2488                 // Write it with fopen
2489                 $fp = fopen($FQFN, 'w') or mxchange_die("Cannot write file ".basename($FQFN)."!");
2490                 fwrite($fp, $content);
2491                 fclose($fp);
2492
2493                 // Set CHMOD rights
2494                 $return = chmod($FQFN, 0644);
2495         }
2496
2497         // Return status
2498         return $return;
2499 }
2500
2501 // Generates an error code from given account status
2502 function GEN_ERROR_CODE_FROM_ACCOUNT_STATUS ($status) {
2503         // Default error code if unknown account status
2504         $ERROR = constant('CODE_UNKNOWN_STATUS');
2505
2506         // Generate constant name
2507         $constantName = sprintf("CODE_ID_%s", $status);
2508
2509         // Is the constant there?
2510         if (defined($constantName)) {
2511                 // Then get it!
2512                 $ERROR = constant($constantName);
2513         } else {
2514                 // Unknown status
2515                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Unknown error status %s detected.", $status));
2516         }
2517
2518         // Return error code
2519         return $ERROR;
2520 }
2521
2522 // Clears the output buffer. This function does *NOT* backup sent content.
2523 function clearOutputBuffer () {
2524         // Trigger an error on failure
2525         if (!ob_end_clean()) {
2526                 // Failed!
2527                 debug_report_bug(__FUNCTION__.": Failed to clean output buffer.");
2528         } // END - if
2529 }
2530
2531 // "Getter" for revision/version data
2532 function getActualVersion ($type = 0) {
2533         // By default nothing is new... ;-)
2534         $new = false;
2535
2536         // FQFN of revision file
2537         $FQFN = sprintf("%sinc/cache/.revision", constant('PATH'));
2538
2539         // Check for revision file
2540         if (!FILE_READABLE($FQFN)) {
2541                 // Not found, so we need to create it
2542                 $new = true;
2543         } else {
2544                 // Revision file found
2545                 $ins_vers = explode("\n", READ_FILE($FQFN));
2546
2547                 // Is the content valid?
2548                 if ((!is_array($ins_vers)) || (count($ins_vers) <= 0) || (!isset($ins_vers[$type])) || ($ins_vers[0]) == "new") {
2549                         // File needs update!
2550                         $new = true;
2551                 } else {
2552                         // Revision-File has valid Data and isn't 'new' so return the Rev-Number
2553                         return trim($ins_vers[$type]);
2554                 }
2555         }
2556
2557         // Has it been updated?
2558         if ($new === true)  {
2559                 // No Revision-File or has no valid Data so read the Revision from the Server.
2560                 $version = GET_URL("check-updates3.php");
2561
2562                 // Prepare content
2563                 $akt_vers[] = trim($version[10]);
2564                 $akt_vers[] = trim($version[9]);
2565                 $akt_vers[] = trim($version[8]);
2566
2567                 // Write file
2568                 WRITE_FILE($FQFN, implode("\n", $akt_vers));
2569
2570                 // Return requested content
2571                 return trim($akt_vers[$type]);
2572         }
2573 }
2574
2575 // Loads an include file and logs any missing files for debug purposes
2576 function LOAD_INC ($INC) {
2577         // Add the path. This is why we need a trailing slash in config.php
2578         $FQFN = constant('PATH') . $INC;
2579
2580         // Is the include file there?
2581         if (!FILE_READABLE($FQFN)) {
2582                 // Not there so log it
2583                 debug_report_bug(sprintf("Include file %s not found.", $INC));
2584                 return false;
2585         } // END - if
2586
2587         // Try to load it
2588         require($FQFN);
2589 }
2590
2591 // Loads an include file once
2592 function LOAD_INC_ONCE ($INC) {
2593         // Is it not loaded?
2594         if (!isset($GLOBALS['load_once'][$INC])) {
2595                 // Then try to load it
2596                 LOAD_INC($INC);
2597
2598                 // And mark it as loaded
2599                 $GLOBALS['load_once'][$INC] = "loaded";
2600         } // END - if
2601 }
2602
2603 // Back-ported from the new ship-simu engine. :-)
2604 function debug_get_printable_backtrace () {
2605         // Init variable
2606         $backtrace = "<ol>\n";
2607
2608         // Get and prepare backtrace for output
2609         $backtraceArray = debug_backtrace();
2610         foreach ($backtraceArray as $key => $trace) {
2611                 if (!isset($trace['file'])) $trace['file'] = __FUNCTION__;
2612                 if (!isset($trace['line'])) $trace['line'] = __LINE__;
2613                 if (!isset($trace['args'])) $trace['args'] = array();
2614                 $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>\n";
2615         } // END - foreach
2616
2617         // Close it
2618         $backtrace .= "</ol>\n";
2619
2620         // Return the backtrace
2621         return $backtrace;
2622 }
2623
2624 // Output a debug backtrace to the user
2625 function debug_report_bug ($message = "") {
2626         // Init message
2627         $debug = "";
2628         // Is the optional message set?
2629         if (!empty($message)) {
2630                 // Use and log it
2631                 $debug = sprintf("Note: %s<br />\n",
2632                         $message
2633                 );
2634
2635                 // @TODO Add a little more infos here
2636                 DEBUG_LOG(__FUNCTION__, __LINE__, $message);
2637         } // END - if
2638
2639         // Add output
2640         $debug .= ("Please report this error at <a href=\"http://bugs.mxchange.org\" rel=\"external\" target=\"_blank\">bugs.mxchange.org</a>:<pre>");
2641         $debug .= (debug_get_printable_backtrace());
2642         $debug .= ("</pre>Thank you for your help finding bugs.");
2643
2644         // And abort here
2645         die($debug);
2646 }
2647
2648 // Generates a ***weak*** seed (taken from de.php.net/mt_srand)
2649 function generateSeed () {
2650         list($usec, $sec) = explode(" ", microtime());
2651         return ((float)$sec + (float)$usec);
2652 }
2653
2654 // Converts a message code to a human-readable message
2655 function convertCodeToMessage ($code) {
2656         $msg = "";
2657         switch ($code) {
2658                 case constant('CODE_LOGOUT_DONE')      : $msg = getMessage('LOGOUT_DONE'); break;
2659                 case constant('CODE_LOGOUT_FAILED')    : $msg = "<span class=\"guest_failed\">{--LOGOUT_FAILED--}</span>"; break;
2660                 case constant('CODE_DATA_INVALID')     : $msg = getMessage('MAIL_DATA_INVALID'); break;
2661                 case constant('CODE_POSSIBLE_INVALID') : $msg = getMessage('MAIL_POSSIBLE_INVALID'); break;
2662                 case constant('CODE_ACCOUNT_LOCKED')   : $msg = getMessage('MEMBER_ACCOUNT_LOCKED_UNC'); break;
2663                 case constant('CODE_USER_404')         : $msg = getMessage('USER_NOT_FOUND'); break;
2664                 case constant('CODE_STATS_404')        : $msg = getMessage('MAIL_STATS_404'); break;
2665                 case constant('CODE_ALREADY_CONFIRMED'): $msg = getMessage('MAIL_ALREADY_CONFIRMED'); break;
2666
2667                 case constant('CODE_ERROR_MAILID'):
2668                         if (EXT_IS_ACTIVE($ext, true)) {
2669                                 $msg = getMessage('ERROR_CONFIRMING_MAIL');
2670                         } else {
2671                                 $msg = sprintf(getMessage('EXTENSION_PROBLEM_NOT_INSTALLED'), "mailid");
2672                         }
2673                         break;
2674
2675                 case constant('CODE_EXTENSION_PROBLEM'):
2676                         if (REQUEST_ISSET_GET(('ext'))) {
2677                                 $msg = sprintf(getMessage('EXTENSION_PROBLEM_EXT_INACTIVE'), REQUEST_GET(('ext')));
2678                         } else {
2679                                 $msg = getMessage('EXTENSION_PROBLEM_UNSET_EXT');
2680                         }
2681                         break;
2682
2683                 case constant('CODE_COOKIES_DISABLED') : $msg = getMessage('LOGIN_NO_COOKIES'); break;
2684                 case constant('CODE_BEG_SAME_AS_OWN')  : $msg = getMessage('BEG_SAME_UID_AS_OWN'); break;
2685                 case constant('CODE_LOGIN_FAILED')     : $msg = getMessage('LOGIN_FAILED_GENERAL'); break;
2686                 default                                : $msg = sprintf(getMessage('UNKNOWN_MAILID_CODE'), $code); break;
2687         } // END - switch
2688
2689         // Return the message
2690         return $msg;
2691 }
2692
2693 // Checks wether the given extension is currently not installed
2694 // and redirects if so.
2695 function REDIRCT_ON_UNINSTALLED_EXTENSION ($ext_name) {
2696         // Is the extension uninstalled/inactive?
2697         if (!EXT_IS_ACTIVE($ext_name)) {
2698                 // Redirect to index
2699                 LOAD_URL("modules.php?module=index&amp;msg=".constant('CODE_EXTENSION_PROBLEM')."&amp;ext=".$ext_name);
2700         } // END - if
2701 }
2702
2703 // Generate a "link" for the given admin id (aid)
2704 function GENERATE_AID_LINK ($aid) {
2705         // No assigned admin is default
2706         $admin = "<span class=\"admin_note\">{--ADMIN_NO_ADMIN_ASSIGNED--}</span>";
2707
2708         // Zero? = Not assigned
2709         if ($aid == "0") {
2710                 // Load admin's login
2711                 $login = GET_ADMIN_LOGIN($aid);
2712                 if ($login != "***") {
2713                         // Is the extension there?
2714                         if (EXT_IS_ACTIVE("admins")) {
2715                                 // Admin found
2716                                 $admin = "<a href=\"".ADMINS_CREATE_EMAIL_LINK(GET_ADMIN_EMAIL($aid))."\">".$login."</a>";
2717                         } else {
2718                                 // Extension not found
2719                                 $admin = sprintf(getMessage('EXTENSION_PROBLEM_NOT_INSTALLED'), "admins");
2720                         }
2721                 } else {
2722                         // Maybe deleted?
2723                         $admin = "<div class=\"admin_note\">".sprintf(getMessage('ADMIN_ID_404'), $aid)."</div>";
2724                 }
2725         } // END - if
2726
2727         // Return result
2728         return $admin;
2729 }
2730
2731 // Checks wether an include file (non-FQFN better) is readable
2732 function INCLUDE_READABLE ($INC) {
2733         // Construct FQFN
2734         $FQFN = constant('PATH') . $INC;
2735
2736         // Is it readable?
2737         return FILE_READABLE($FQFN);
2738 }
2739
2740 // Encode strings
2741 // @TODO Implement $compress
2742 function encodeString ($str, $compress=true) {
2743         $str = urlencode(base64_encode(compileUriCode($str)));
2744         return $str;
2745 }
2746
2747 // Decode strings encoded with encodeString()
2748 // @TODO Implement $decompress
2749 function decodeString ($str, $decompress=true) {
2750         $str = compileUriCode(base64_decode(urldecode(compileUriCode($str))));
2751         return $str;
2752 }
2753
2754 // Compile characters which are allowed in URLs
2755 function compileUriCode ($code, $simple=true) {
2756         // Compile constants
2757         if (!$simple) $code = str_replace("{--", '".', str_replace("--}", '."', $code));
2758
2759         // Compile QUOT and other non-HTML codes
2760         $code = str_replace("{DOT}", ".",
2761                 str_replace("{SLASH}", "/",
2762                 str_replace("{QUOT}", "'",
2763                 str_replace("{DOLLAR}", "$",
2764                 str_replace("{OPEN_ANCHOR}", "(",
2765                 str_replace("{CLOSE_ANCHOR}", ")",
2766                 str_replace("{OPEN_SQR}", "[",
2767                 str_replace("{CLOSE_SQR}", "]",
2768                 str_replace("{PER}", "%",
2769                 $code
2770         )))))))));
2771
2772         // Return compiled code
2773         return $code;
2774 }
2775
2776 // Function taken from user comments on www.php.net / function eregi()
2777 function isUrlValid ($url) {
2778         // Prepare URL
2779         $url = strip_tags(str_replace("\\", "", compileUriCode(urldecode($url))));
2780
2781         // Allows http and https
2782         $http      = "(http|https)+(:\/\/)";
2783         // Test domain
2784         $domain1   = "([[:alnum:]]([-[:alnum:]])*\.)?([[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})?";
2785         // Test double-domains (e.g. .de.vu)
2786         $domain2   = "([-[:alnum:]])?(\.[[:alnum:]][-[:alnum:]\.]*[[:alnum:]])(\.[[:alpha:]]{2,5})(\.[[:alpha:]]{2,5})?";
2787         // Test IP number
2788         $ip        = "([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})\.([[:digit:]]{1,3})";
2789         // ... directory
2790         $dir       = "((/)+([-_\.[:alnum:]])+)*";
2791         // ... page
2792         $page      = "/([-_[:alnum:]][-\._[:alnum:]]*\.[[:alnum:]]{2,5})?";
2793         // ... and the string after and including question character
2794         $getstring1 = "([\?/]([[:alnum:]][-\._%[:alnum:]]*(=)?([-\@\._:%[:alnum:]])+)(&([[:alnum:]]([-_%[:alnum:]])*(=)?([-\@\[\._:%[:alnum:]])+(\])*))*)?";
2795         // Pattern for URLs like http://url/dir/doc.html?var=value
2796         $pattern['d1dpg1']  = $http.$domain1.$dir.$page.$getstring1;
2797         $pattern['d2dpg1']  = $http.$domain2.$dir.$page.$getstring1;
2798         $pattern['ipdpg1']  = $http.$ip.$dir.$page.$getstring1;
2799         // Pattern for URLs like http://url/dir/?var=value
2800         $pattern['d1dg1']  = $http.$domain1.$dir."/".$getstring1;
2801         $pattern['d2dg1']  = $http.$domain2.$dir."/".$getstring1;
2802         $pattern['ipdg1']  = $http.$ip.$dir."/".$getstring1;
2803         // Pattern for URLs like http://url/dir/page.ext
2804         $pattern['d1dp']  = $http.$domain1.$dir.$page;
2805         $pattern['d1dp']  = $http.$domain2.$dir.$page;
2806         $pattern['ipdp']  = $http.$ip.$dir.$page;
2807         // Pattern for URLs like http://url/dir
2808         $pattern['d1d']  = $http.$domain1.$dir;
2809         $pattern['d2d']  = $http.$domain2.$dir;
2810         $pattern['ipd']  = $http.$ip.$dir;
2811         // Pattern for URLs like http://url/?var=value
2812         $pattern['d1g1']  = $http.$domain1."/".$getstring1;
2813         $pattern['d2g1']  = $http.$domain2."/".$getstring1;
2814         $pattern['ipg1']  = $http.$ip."/".$getstring1;
2815         // Pattern for URLs like http://url?var=value
2816         $pattern['d1g12']  = $http.$domain1.$getstring1;
2817         $pattern['d2g12']  = $http.$domain2.$getstring1;
2818         $pattern['ipg12']  = $http.$ip.$getstring1;
2819         // Test all patterns
2820         $reg = false;
2821         foreach ($pattern as $key=>$pat) {
2822                 // Debug regex?
2823                 if (defined('DEBUG_REGEX')) {
2824                         $pat = str_replace("[:alnum:]", "0-9a-zA-Z", $pat);
2825                         $pat = str_replace("[:alpha:]", "a-zA-Z", $pat);
2826                         $pat = str_replace("[:digit:]", "0-9", $pat);
2827                         $pat = str_replace(".", "\.", $pat);
2828                         $pat = str_replace("@", "\@", $pat);
2829                         echo $key."=&nbsp;".$pat."<br />";
2830                 }
2831
2832                 // Check if expression matches
2833                 $reg = ($reg || preg_match(("^".$pat."^"), $url));
2834
2835                 // Does it match?
2836                 if ($reg === true) break;
2837         }
2838
2839         // Return true/false
2840         return $reg;
2841 }
2842
2843 // Smartly adds slashes
2844 function smartAddSlashes ($unquoted) {
2845         $unquoted = str_replace("\\", "", $unquoted);
2846         return addslashes($unquoted);
2847 }
2848
2849 // Decode entities in a nicer way
2850 function decodeEntities ($str) {
2851         // @TODO We may want to switch over to UTF-8 here!
2852         $decodedString = html_entity_decode($str, ENT_NOQUOTES, "ISO-8859-15");
2853
2854         // Return decoded string
2855         return $decodedString;
2856 }
2857
2858 // Wtites data to a config.php-style file
2859 // @TODO Rewrite this function to use READ_FILE() and WRITE_FILE()
2860 function changeDataInFile ($FQFN, $comment, $prefix, $suffix, $DATA, $seek=0) {
2861         // Initialize some variables
2862         $done = false;
2863         $seek++;
2864         $next  = -1;
2865         $found = false;
2866
2867         // Is the file there and read-/write-able?
2868         if ((FILE_READABLE($FQFN)) && (is_writeable($FQFN))) {
2869                 $search = "CFG: ".$comment;
2870                 $tmp = $FQFN.".tmp";
2871
2872                 // Open the source file
2873                 $fp = fopen($FQFN, 'r') or OUTPUT_HTML("<strong>READ:</strong> ".$FQFN."<br />");
2874
2875                 // Is the resource valid?
2876                 if (is_resource($fp)) {
2877                         // Open temporary file
2878                         $fp_tmp = fopen($tmp, 'w') or OUTPUT_HTML("<strong>WRITE:</strong> ".$tmp."<br />");
2879
2880                         // Is the resource again valid?
2881                         if (is_resource($fp_tmp)) {
2882                                 while (!feof($fp)) {
2883                                         // Read from source file
2884                                         $line = fgets ($fp, 1024);
2885
2886                                         if (strpos($line, $search) > -1) { $next = 0; $found = true; }
2887
2888                                         if ($next > -1) {
2889                                                 if ($next === $seek) {
2890                                                         $next = -1;
2891                                                         $line = $prefix . $DATA . $suffix."\n";
2892                                                 } else {
2893                                                         $next++;
2894                                                 }
2895                                         }
2896
2897                                         // Write to temp file
2898                                         fputs($fp_tmp, $line);
2899                                 }
2900
2901                                 // Close temp file
2902                                 fclose($fp_tmp);
2903
2904                                 // Finished writing tmp file
2905                                 $done = true;
2906                         }
2907
2908                         // Close source file
2909                         fclose($fp);
2910
2911                         if (($done) && ($found)) {
2912                                 // Copy back tmp file and delete tmp :-)
2913                                 copy($tmp, $FQFN);
2914                                 return unlink($tmp);
2915                         } elseif (!$found) {
2916                                 OUTPUT_HTML("<strong>CHANGE:</strong> 404!");
2917                         } else {
2918                                 OUTPUT_HTML("<strong>TMP:</strong> UNDONE!");
2919                         }
2920                 }
2921         } else {
2922                 // File not found, not readable or writeable
2923                 OUTPUT_HTML("<strong>404:</strong> ".$FQFN."<br />");
2924         }
2925
2926         // An error was detected!
2927         return false;
2928 }
2929 // Send notification to admin
2930 function SEND_ADMIN_NOTIFICATION($subject, $templateName, $content=array(), $uid="0") {
2931         if (GET_EXT_VERSION("admins") >= "0.4.1") {
2932                 // Send new way
2933                 SEND_ADMIN_EMAILS_PRO($subject, $templateName, $content, $uid);
2934         } else {
2935                 // Send outdated way
2936                 $msg = LOAD_EMAIL_TEMPLATE($templateName, $content, $uid);
2937                 SEND_ADMIN_EMAILS($subject, $msg);
2938         }
2939 }
2940
2941 // Merges an array together but only if both are arrays
2942 function merge_array ($array1, $array2) {
2943         // Are both an array?
2944         if ((is_array($array1)) && (is_array($array2))) {
2945                 // Merge all together
2946                 return array_merge($array1, $array2);
2947         } elseif (is_array($array1)) {
2948                 // Return left array
2949                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("array2 is not an array. array != %s", gettype($array2)));
2950                 return $array1;
2951         } elseif (is_array($array2)) {
2952                 // Return right array
2953                 DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("array1 is not an array. array != %s", gettype($array1)));
2954                 return $array2;
2955         }
2956
2957         // Both are not arrays
2958         debug_report_bug(__FUNCTION__.": No arrays provided!");
2959 }
2960
2961 // Debug message logger
2962 function DEBUG_LOG ($funcFile, $line, $message, $force=true) {
2963         // Is debug mode enabled?
2964         if ((isDebugModeEnabled()) || ($force === true)) {
2965                 // Log this message away
2966                 $fp = fopen(constant('PATH')."inc/cache/debug.log", 'a') or mxchange_die("Cannot write logfile debug.log!");
2967                 fwrite($fp, date("d.m.Y|H:i:s", time())."|".basename($funcFile)."|".$line."|".strip_tags($message)."\n");
2968                 fclose($fp);
2969         } // END - if
2970 }
2971
2972 // Reads a directory with PHP files in and gets only files back
2973 function GET_DIR_AS_ARRAY ($baseDir, $prefix) {
2974         $INCs = array();
2975
2976         // Open directory
2977         $dirPointer = opendir(constant('PATH') . $baseDir) or mxchange_die("Cannot read ".basename($baseDir)." path!");
2978
2979         // Read all entries
2980         while ($baseFile = readdir($dirPointer)) {
2981                 // Load file only if extension is active
2982                 $INC = $baseDir.$baseFile;
2983                 $FQFN = constant('PATH') . $INC;
2984
2985                 // Is this a valid reset file?
2986                 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):baseDir={$baseDir},prefix={$prefix},baseFile={$baseFile}<br />\n";
2987                 if ((FILE_READABLE($FQFN)) && (substr($baseFile, 0, strlen($prefix)) == $prefix) && (substr($baseFile, -4, 4) == ".php")) {
2988                         // Remove both for extension name
2989                         $extName = substr($baseFile, strlen($prefix), -4);
2990
2991                         // Try to find it
2992                         $extId = GET_EXT_ID($extName);
2993
2994                         // Is the extension valid and active?
2995                         if (($extId > 0) && (EXT_IS_ACTIVE($extName))) {
2996                                 // Then add this file
2997                                 $INCs[] = $INC;
2998                         } elseif ($extId == 0) {
2999                                 // Add non-extension files as well
3000                                 $INCs[] = $INC;
3001                         }
3002                 } // END - if
3003         } // END - while
3004
3005         // Close directory
3006         closedir($dirPointer);
3007
3008         // Sort array
3009         asort($INCs);
3010
3011         // Return array with include files
3012         return $INCs;
3013 }
3014
3015 // Load more reset scripts
3016 function runResetIncludes () {
3017         // Is the reset set or old sql_patches?
3018         if ((!isResetModeEnabled()) || (EXT_VERSION_IS_OLDER("sql_patches", "0.4.5"))) {
3019                 // Then abort here
3020                 DEBUG_LOG(__FUNCTION__, __LINE__, "Cannot run reset! Please report this bug. Thanks");
3021         } // END - if
3022
3023         // Get more daily reset scripts
3024         $INC_POOL = GET_DIR_AS_ARRAY("inc/reset/", "reset_");
3025
3026         // Update database
3027         if (!defined('DEBUG_RESET')) UPDATE_CONFIG("last_update", time());
3028
3029         // Create current week mark
3030         $currWeek = date("W", time());
3031
3032         // Has it changed?
3033         if (getConfig('last_week') != $currWeek) {
3034                 // Include weekly reset scripts
3035                 $INC_POOL = merge_array($INC_POOL, GET_DIR_AS_ARRAY("inc/weekly/", "weekly_"));
3036
3037                 // Update config
3038                 if (!defined('DEBUG_WEEKLY')) UPDATE_CONFIG("last_week", $currWeek);
3039         } // END - if
3040
3041         // Create current month mark
3042         $currMonth = date("m", time());
3043
3044         // Has it changed?
3045         if (getConfig('last_month') != $currMonth) {
3046                 // Include monthly reset scripts
3047                 $INC_POOL = merge_array($INC_POOL, GET_DIR_AS_ARRAY("inc/monthly/", "monthly_"));
3048
3049                 // Update config
3050                 if (!defined('DEBUG_MONTHLY')) UPDATE_CONFIG("last_month", $currMonth);
3051         } // END - if
3052
3053         // Run the filter
3054         runFilterChain('load_includes', $INC_POOL);
3055 }
3056
3057 // Handle extra values
3058 function HANDLE_EXTRA_VALUES ($filterFunction, $value, $extraValue) {
3059         // Default is the value itself
3060         $ret = $value;
3061
3062         // Do we have a special filter function?
3063         if (!empty($filterFunction)) {
3064                 // Does the filter function exist?
3065                 if (function_exists($filterFunction)) {
3066                         // Do we have extra parameters here?
3067                         if (!empty($extraValue)) {
3068                                 // Put both parameters in one new array by default
3069                                 $args = array($value, $extraValue);
3070
3071                                 // If we have an array simply use it and pre-extend it with our value
3072                                 if (is_array($extraValue)) {
3073                                         // Make the new args array
3074                                         $args = merge_array(array($value), $extraValue);
3075                                 } // END - if
3076
3077                                 // Call the multi-parameter call-back
3078                                 $ret = call_user_func_array($filterFunction, $args);
3079                         } else {
3080                                 // One parameter call
3081                                 $ret = call_user_func($filterFunction, $value);
3082                         }
3083                 } // END - if
3084         } // END - if
3085
3086         // Return the value
3087         return $ret;
3088 }
3089
3090 // Check if given FQFN is a readable file
3091 function FILE_READABLE($fqfn) {
3092         // Check all...
3093         return ((file_exists($fqfn)) && (is_file($fqfn)) && (is_readable($fqfn)));
3094 }
3095
3096 // Converts timestamp selections into a timestamp
3097 function CONVERT_SELECTIONS_TO_TIMESTAMP(&$POST, &$DATA, &$id, &$skip) {
3098         // Init test variable
3099         $test2 = "";
3100
3101         // Get last three chars
3102         $test = substr($id, -3);
3103
3104         // Improved way of checking! :-)
3105         if (in_array($test, array("_ye", "_mo", "_we", "_da", "_ho", "_mi", "_se"))) {
3106                 // Found a multi-selection for timings?
3107                 $test = substr($id, 0, -3);
3108                 if ((isset($POST[$test."_ye"])) && (isset($POST[$test."_mo"])) && (isset($POST[$test."_we"])) && (isset($POST[$test."_da"])) && (isset($POST[$test."_ho"])) && (isset($POST[$test."_mi"])) && (isset($POST[$test."_se"])) && ($test != $test2)) {
3109                         // Generate timestamp
3110                         $POST[$test] = CREATE_TIMESTAMP_FROM_SELECTIONS($test, $POST);
3111                         $DATA[] = sprintf("%s='%s'", $test, $POST[$test]);
3112
3113                         // Remove data from array
3114                         foreach (array("ye", "mo", "we", "da", "ho", "mi", "se") as $rem) {
3115                                 unset($POST[$test."_".$rem]);
3116                         } // END - foreach
3117
3118                         // Skip adding
3119                         unset($id); $skip = true; $test2 = $test;
3120                 } // END - if
3121         } else {
3122                 // Process this entry
3123                 $skip = false;
3124                 $test2 = "";
3125         }
3126 }
3127
3128 // Reverts the german decimal comma into Computer decimal dot
3129 function REVERT_COMMA ($str) {
3130         // Default float is not a float... ;-)
3131         $float = false;
3132
3133         // Which language is selected?
3134         switch (GET_LANGUAGE()) {
3135                 case "de": // German language
3136                         // Remove german thousand dots first
3137                         $str = str_replace(".", "", $str);
3138
3139                         // Replace german commata with decimal dot and cast it
3140                         $float = (float)str_replace(",", ".", $str);
3141                         break;
3142
3143                 default: // US and so on
3144                         // Remove thousand dots first and cast
3145                         $float = (float)str_replace(",", "", $str);
3146                         break;
3147         }
3148
3149         // Return float
3150         return $float;
3151 }
3152
3153 // Handle menu-depending failed logins and return the rendered content
3154 function HANDLE_LOGIN_FAILTURES ($accessLevel) {
3155         // Default output is empty ;-)
3156         $OUT = "";
3157
3158         // Is the session data set?
3159         if ((isSessionVariableSet('mxchange_'.$accessLevel.'_failures')) && (isSessionVariableSet('mxchange_'.$accessLevel.'_last_fail'))) {
3160                 // Ignore zero values
3161                 if (get_session('mxchange_'.$accessLevel.'_failures') > 0) {
3162                         // Non-guest has login failures found, get both data and prepare it for template
3163                         //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):accessLevel={$accessLevel}<br />\n";
3164                         $content = array(
3165                                 'login_failures' => get_session('mxchange_'.$accessLevel.'_failures'),
3166                                 'last_failure'   => MAKE_DATETIME(get_session('mxchange_'.$accessLevel.'_last_fail'), "2")
3167                         );
3168
3169                         // Load template
3170                         $OUT = LOAD_TEMPLATE("login_failures", true, $content);
3171                 } // END - if
3172
3173                 // Reset session data
3174                 set_session('mxchange_'.$accessLevel.'_failures', "");
3175                 set_session('mxchange_'.$accessLevel.'_last_fail', "");
3176         } // END - if
3177
3178         // Return rendered content
3179         return $OUT;
3180 }
3181
3182 // Rebuild cache
3183 function rebuildCacheFiles ($cache, $inc="") {
3184         // Shall I remove the cache file?
3185         if ((EXT_IS_ACTIVE("cache")) && (isCacheInstanceValid())) {
3186                 // Rebuild cache
3187                 if ($GLOBALS['cache_instance']->loadCacheFile($cache)) {
3188                         // Destroy it
3189                         $GLOBALS['cache_instance']->destroyCacheFile();
3190                 } // END - if
3191
3192                 // Include file given?
3193                 if (!empty($inc)) {
3194                         // Construct FQFN
3195                         $INC = sprintf("inc/loader/load_cache-%s.php", $inc);
3196
3197                         // Is the include there?
3198                         if (INCLUDE_READABLE($INC)) {
3199                                 // And rebuild it from scratch
3200                                 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>): inc={$inc} - LOADED!<br />\n";
3201                                 LOAD_INC($INC);
3202                         } else {
3203                                 // Include not found!
3204                                 DEBUG_LOG(__FUNCTION__, __LINE__, "Include {$inc} not found. cache={$cache}");
3205                         }
3206                 } // END - if
3207         } // END - if
3208 }
3209
3210 // Purge admin menu cache
3211 function CACHE_PURGE_ADMIN_MENU ($id=0, $action="", $what="", $str="") {
3212         // Is the cache extension enabled or no cache instance or admin menu cache disabled?
3213         if (!EXT_IS_ACTIVE("cache")) {
3214                 // Cache extension not active
3215                 return false;
3216         } elseif (!isCacheInstanceValid()) {
3217                 // No cache instance!
3218                 DEBUG_LOG(__FUNCTION__, __LINE__, " No cache instance found.");
3219                 return false;
3220         } elseif ((!isConfigEntrySet('cache_admin_menu')) || (getConfig('cache_admin_menu') != "Y")) {
3221                 // Caching disabled (currently experiemental!)
3222                 return false;
3223         }
3224
3225         // Experiemental feature!
3226         debug_report_bug("<strong>Experimental feature:</strong> You have to delete the admin_*.cache files by yourself at this point.");
3227 }
3228
3229 // Translates the "pool type" into human-readable
3230 function TRANSLATE_POOL_TYPE ($type) {
3231         // Default type is unknown
3232         $translated = sprintf(getMessage('POOL_TYPE_UNKNOWN'), $type);
3233
3234         // Generate constant
3235         $constName = sprintf("POOL_TYPE_%s", $type);
3236
3237         // Does it exist?
3238         if (defined($constName)) {
3239                 // Then use it
3240                 $translated = getMessage($constName);
3241         } // END - if
3242
3243         // Return "translation"
3244         return $translated;
3245 }
3246
3247 // "Getter" for remote IP number
3248 function GET_REMOTE_ADDR () {
3249         // Get remote ip from environment
3250         $remoteAddr = getenv('REMOTE_ADDR');
3251
3252         // Is removeip installed?
3253         if (EXT_IS_ACTIVE("removeip")) {
3254                 // Then anonymize it
3255                 $remoteAddr = GET_ANONYMOUS_REMOTE_ADDR($remoteAddr);
3256         } // END - if
3257
3258         // Return it
3259         return $remoteAddr;
3260 }
3261
3262 // "Getter" for remote hostname
3263 function GET_REMOTE_HOST () {
3264         // Get remote ip from environment
3265         $remoteHost = getenv('REMOTE_HOST');
3266
3267         // Is removeip installed?
3268         if (EXT_IS_ACTIVE("removeip")) {
3269                 // Then anonymize it
3270                 $remoteHost = GET_ANONYMOUS_REMOTE_HOST($remoteHost);
3271         } // END - if
3272
3273         // Return it
3274         return $remoteHost;
3275 }
3276
3277 // "Getter" for user agent
3278 function GET_USER_AGENT () {
3279         // Get remote ip from environment
3280         $userAgent = getenv('HTTP_USER_AGENT');
3281
3282         // Is removeip installed?
3283         if (EXT_IS_ACTIVE("removeip")) {
3284                 // Then anonymize it
3285                 $userAgent = GET_ANONYMOUS_USER_AGENT($userAgent);
3286         } // END - if
3287
3288         // Return it
3289         return $userAgent;
3290 }
3291
3292 // "Getter" for referer
3293 function GET_REFERER () {
3294         // Get remote ip from environment
3295         $referer = getenv('HTTP_REFERER');
3296
3297         // Is removeip installed?
3298         if (EXT_IS_ACTIVE("removeip")) {
3299                 // Then anonymize it
3300                 $referer = GET_ANONYMOUS_REFERER($referer);
3301         } // END - if
3302
3303         // Return it
3304         return $referer;
3305 }
3306
3307 // Adds a bonus mail to the queue
3308 // This is a high-level function!
3309 function ADD_NEW_BONUS_MAIL ($data, $mode="", $output=true) {
3310         // Use mode from data if not set and availble ;-)
3311         if ((empty($mode)) && (isset($data['mode']))) $mode = $data['mode'];
3312
3313         // Generate receiver list
3314         $RECEIVER = GENERATE_RECEIVER_LIST($data['cat'], $data['receiver'], $mode);
3315
3316         // Receivers added?
3317         if (!empty($RECEIVER)) {
3318                 // Add bonus mail to queue
3319                 ADD_BONUS_MAIL_TO_QUEUE(
3320                         $data['subject'],
3321                         $data['text'],
3322                         $RECEIVER,
3323                         $data['points'],
3324                         $data['seconds'],
3325                         $data['url'],
3326                         $data['cat'],
3327                         $mode,
3328                         $data['receiver']
3329                 );
3330
3331                 // Mail inserted into bonus pool
3332                 if ($output) LOAD_TEMPLATE("admin_settings_saved", false, getMessage('ADMIN_BONUS_SEND'));
3333         } elseif ($output) {
3334                 // More entered than can be reached!
3335                 LOAD_TEMPLATE("admin_settings_saved", false, getMessage('ADMIN_MORE_SELECTED'));
3336         } else {
3337                 // Debug log
3338                 DEBUG_LOG(__FUNCTION__, __LINE__, " cat={$data['cat']},receiver={$data['receiver']},data=".base64_encode(serialize($data))." More selected, than available!");
3339         }
3340 }
3341
3342 // Determines referal id and sets it
3343 function DETERMINE_REFID () {
3344         global $CLICK, $_SERVER;
3345
3346         // Check if refid is set
3347         if ((!empty($_GET['user'])) && ($CLICK == 1) && (basename($_SERVER['PHP_SELF']) == "click.php")) {
3348                 // The variable user comes from the click-counter script click.php and we only accept this here
3349                 $GLOBALS['refid'] = bigintval($_GET['user']);
3350         } elseif (!empty($_POST['refid'])) {
3351                 // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
3352                 $GLOBALS['refid'] = SQL_ESCAPE(strip_tags($_POST['refid']));
3353         } elseif (!empty($_GET['refid'])) {
3354                 // Get referal id from variable refid (so I hope this makes my script more compatible to other scripts)
3355                 $GLOBALS['refid'] = SQL_ESCAPE(strip_tags($_GET['refid']));
3356         } elseif (!empty($_GET['ref'])) {
3357                 // Set refid=ref (the referal link uses such variable)
3358                 $GLOBALS['refid'] = SQL_ESCAPE(strip_tags($_GET['ref']));
3359         } elseif ((isSessionVariableSet('refid')) && (get_session('refid') != 0)) {
3360                 // Set session refid als global
3361                 $GLOBALS['refid'] = bigintval(get_session('refid'));
3362         } elseif ((GET_EXT_VERSION("sql_patches") != "") && (getConfig('def_refid') > 0)) {
3363                 // Set default refid as refid in URL
3364                 $GLOBALS['refid'] = getConfig(('def_refid'));
3365         } elseif ((GET_EXT_VERSION("user") >= "0.3.4") && (getConfig('select_user_zero_refid')) == "Y") {
3366                 // Select a random user which has confirmed enougth mails
3367                 $GLOBALS['refid'] = SELECT_RANDOM_REFID();
3368         } else {
3369                 // No default ID when sql_patches is not installed or none set
3370                 $GLOBALS['refid'] = 0;
3371         }
3372
3373         // Set cookie when default refid > 0
3374         if (!isSessionVariableSet('refid') || (!empty($GLOBALS['refid'])) || ((get_session('refid') == "0") && (getConfig('def_refid') > 0))) {
3375                 // Set cookie
3376                 set_session('refid', $GLOBALS['refid']);
3377         } // END - if
3378
3379         // Return determined refid
3380         return $GLOBALS['refid'];
3381 }
3382
3383 // Check wether we are installing
3384 function isInstalling () {
3385         return (isset($GLOBALS['mxchange_installing']));
3386 }
3387
3388 // Check wether this script is installed
3389 function isInstalled () {
3390         return isBooleanConstantAndTrue('mxchange_installed');
3391 }
3392
3393 // Check wether an admin is registered
3394 function isAdminRegistered () {
3395         return isBooleanConstantAndTrue('admin_registered');
3396 }
3397
3398 // Enables the reset mode. Only call this function if you really want the
3399 // reset to be run!
3400 function enableResetMode () {
3401         // Enable the reset mode
3402         $GLOBALS['reset_enabled'] = true;
3403
3404         // Run filters
3405         runFilterChain('reset_enabled');
3406 }
3407
3408 // Checks wether the reset mode is active
3409 function isResetModeEnabled () {
3410         // Now simply check it
3411         return ((isset($GLOBALS['reset_enabled'])) && ($GLOBALS['reset_enabled'] === true));
3412 }
3413
3414 // Checks wether the debug mode is enabled
3415 function isDebugModeEnabled () {
3416         // Simply check it
3417         return isBooleanConstantAndTrue('DEBUG_MODE');
3418 }
3419
3420 // Checks wether the cache instance is valid
3421 function isCacheInstanceValid () {
3422         return ((isset($GLOBALS['cache_instance'])) && (is_object($GLOBALS['cache_instance'])));
3423 }
3424
3425 //////////////////////////////////////////////////
3426 // AUTOMATICALLY RE-GENERATED MISSING FUNCTIONS //
3427 //////////////////////////////////////////////////
3428 //
3429 if (!function_exists('html_entity_decode')) {
3430         // Taken from documentation on www.php.net
3431         function html_entity_decode ($string) {
3432                 $trans_tbl = get_html_translation_table(HTML_ENTITIES);
3433                 $trans_tbl = array_flip($trans_tbl);
3434                 return strtr($string, $trans_tbl);
3435         }
3436 } // END - if
3437
3438 // [EOF]
3439 ?>