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