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