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