bdb505d8fbd63be40be7494ebefdcf60eca102ca
[mailer.git] / inc / template-functions.php
1 <?php
2 /************************************************************************
3  * Mailer v0.2.1-FINAL                                Start: 04/04/2009 *
4  * ===================                          Last change: 04/04/2009 *
5  *                                                                      *
6  * -------------------------------------------------------------------- *
7  * File              : template-functions.php                           *
8  * -------------------------------------------------------------------- *
9  * Short description : Template functions                               *
10  * -------------------------------------------------------------------- *
11  * Kurzbeschreibung  : Template-Funktionen                              *
12  * -------------------------------------------------------------------- *
13  * $Revision::                                                        $ *
14  * $Date::                                                            $ *
15  * $Tag:: 0.2.1-FINAL                                                 $ *
16  * $Author::                                                          $ *
17  * -------------------------------------------------------------------- *
18  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
19  * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
20  * For more information visit: http://www.mxchange.org                  *
21  *                                                                      *
22  * This program is free software; you can redistribute it and/or modify *
23  * it under the terms of the GNU General Public License as published by *
24  * the Free Software Foundation; either version 2 of the License, or    *
25  * (at your option) any later version.                                  *
26  *                                                                      *
27  * This program is distributed in the hope that it will be useful,      *
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
30  * GNU General Public License for more details.                         *
31  *                                                                      *
32  * You should have received a copy of the GNU General Public License    *
33  * along with this program; if not, write to the Free Software          *
34  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
35  * MA  02110-1301  USA                                                  *
36  ************************************************************************/
37
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
40         die();
41 } // END - if
42
43 // Wrapper until we merged to the EL branch
44 function preCompileCode ($code, $template = '', $compiled = false, $full = true, $overwrite = false) {
45         return compileCode($code, false, true, $full);
46 }
47
48 // Setter for 'is_template_html'
49 function enableTemplateHtml ($enable = true) {
50         $GLOBALS['is_template_html'] = (bool) $enable;
51 }
52
53 // Checks wether the template is HTML or not by previously set flag
54 // Default: true
55 function isTemplateHtml () {
56         // Is the output_mode other than 0 (HTML), then no comments are enabled
57         if (!isHtmlOutputMode()) {
58                 // No HTML
59                 return false;
60         } else {
61                 // Maybe HTML?
62                 return $GLOBALS['is_template_html'];
63         }
64 }
65
66 // Wrapper for writing debug informations to the browser
67 function debugOutput ($message) {
68         outputHtml('<div class="debug_message">' . $message . '</div>');
69 }
70
71 // "Fixes" an empty string into three dashes (use for templates)
72 function fixEmptyContentToDashes ($str) {
73         // Trim the string
74         $str = trim($str);
75
76         // Is the string empty?
77         if (empty($str)) {
78                 $str = '---';
79         } // END - if
80
81         // Return string
82         return $str;
83 }
84
85 // Init color switch
86 function initTemplateColorSwitch ($template) {
87         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'INIT:' . $template);
88         $GLOBALS['color_switch'][$template] = 2;
89 }
90
91 // "Getter" for color switch code
92 function getColorSwitchCode ($template) {
93         // Prepare the code
94         $code = "{DQUOTE} . doTemplateColorSwitch('" . $template . "', false, false) . {DQUOTE}";
95
96         // And return it
97         return $code;
98 }
99
100 // Output HTML code directly or 'render' it. You addionally switch the new-line character off
101 function outputHtml ($htmlCode, $newLine = true) {
102         // Init output
103         if (!isset($GLOBALS['output'])) {
104                 $GLOBALS['output'] = '';
105         } // END - if
106
107         // Do we have HTML-Code here?
108         if (!empty($htmlCode)) {
109                 // Yes, so we handle it as you have configured
110                 switch (getOutputMode()) {
111                         case 'render':
112                                 // That's why you don't need any \n at the end of your HTML code... :-)
113                                 if (getPhpCaching() == 'on') {
114                                         // Output into PHP's internal buffer
115                                         outputRawCode($htmlCode);
116
117                                         // That's why you don't need any \n at the end of your HTML code... :-)
118                                         if ($newLine === true) print("\n");
119                                 } else {
120                                         // Render mode for old or lame servers...
121                                         $GLOBALS['output'] .= $htmlCode;
122
123                                         // That's why you don't need any \n at the end of your HTML code... :-)
124                                         if ($newLine === true) $GLOBALS['output'] .= "\n";
125                                 }
126                                 break;
127
128                         case 'direct':
129                                 // If we are switching from render to direct output rendered code
130                                 if ((!empty($GLOBALS['output'])) && (getPhpCaching() != 'on')) { outputRawCode($GLOBALS['output']); $GLOBALS['output'] = ''; }
131
132                                 // The same as above... ^
133                                 outputRawCode($htmlCode);
134                                 if ($newLine === true) print("\n");
135                                 break;
136
137                         default:
138                                 // Huh, something goes wrong or maybe you have edited config.php ???
139                                 debug_report_bug(__FUNCTION__, __LINE__, '<strong>{--FATAL_ERROR--}:</strong> {--NO_RENDER_DIRECT--}');
140                                 break;
141                 } // END - switch
142         } elseif ((getPhpCaching() == 'on') && ((!isset($GLOBALS['header'])) || (count($GLOBALS['header']) == 0))) {
143                 // Output cached HTML code
144                 $GLOBALS['output'] = ob_get_contents();
145
146                 // Clear output buffer for later output if output is found
147                 if (!empty($GLOBALS['output'])) {
148                         clearOutputBuffer();
149                 } // END - if
150
151                 // Send all HTTP headers
152                 sendHttpHeaders();
153
154                 // Compile and run finished rendered HTML code
155                 compileFinalOutput();
156
157                 // Output code here, DO NOT REMOVE! ;-)
158                 outputRawCode($GLOBALS['output']);
159         } elseif ((getOutputMode() == 'render') && (!empty($GLOBALS['output']))) {
160                 // Send all HTTP headers
161                 sendHttpHeaders();
162
163                 // Compile and run finished rendered HTML code
164                 compileFinalOutput();
165
166                 // Output code here, DO NOT REMOVE! ;-)
167                 outputRawCode($GLOBALS['output']);
168         } else {
169                 // And flush all headers
170                 flushHeaders();
171         }
172 }
173
174 // Compiles the final output
175 function compileFinalOutput () {
176         // Add page header and footer
177         addPageHeaderFooter();
178
179         // Do the final compilation
180         $GLOBALS['output'] = doFinalCompilation($GLOBALS['output']);
181
182         // Extension 'rewrite' installed?
183         if ((isExtensionActive('rewrite')) && (!isCssOutputMode())) {
184                 $GLOBALS['output'] = rewriteLinksInCode($GLOBALS['output']);
185         } // END - if
186
187         // Compress it?
188         /**
189          * @TODO On some pages this is buggy
190         if (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('gzip', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
191                 // Compress it for HTTP gzip
192                 $GLOBALS['output'] = gzencode($GLOBALS['output'], 9);
193
194                 // Add header
195                 sendHeader('Content-Encoding: gzip');
196         } elseif (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('deflate', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
197                 // Compress it for HTTP deflate
198                 $GLOBALS['output'] = gzcompress($GLOBALS['output'], 9);
199
200                 // Add header
201                 sendHeader('Content-Encoding: deflate');
202         }
203         */
204
205         // Add final length
206         sendHeader('Content-Length: ' . strlen($GLOBALS['output']));
207
208         // Flush all headers
209         flushHeaders();
210 }
211
212 // Main compilation loop
213 function doFinalCompilation ($code, $insertComments = true, $enableCodes = true) {
214         // Insert comments? (Only valid with HTML templates, of course)
215         enableTemplateHtml($insertComments);
216
217         // Init counter
218         $count = 0;
219
220         // Compile all out
221         while (((strpos($code, '{--') !== false) || (strpos($code, '{DQUOTE}') !== false) || (strpos($code, '{?') !== false) || (strpos($code, '{%') !== false)) && ($count < 5)) {
222                 // Init common variables
223                 $content = array();
224                 $newContent = '';
225
226                 // Compile it
227                 //* DEBUG: */ debugOutput('<pre>'.linenumberCode($code).'</pre>');
228                 $eval = '$newContent = "' . str_replace('{DQUOTE}', '"', compileCode(escapeQuotes($code), false, true, $enableCodes)) . '";';
229                 //* DEBUG: */ if (!$insertComments) print('EVAL=<pre>'.linenumberCode($eval).'</pre>');
230                 eval($eval);
231                 //* DEBUG: */ if (!$insertComments) print('NEW=<pre>'.linenumberCode($newContent).'</pre>');
232                 //* DEBUG: */ die('<pre>'.encodeEntities($newContent).'</pre>');
233
234                 // Was that eval okay?
235                 if (empty($newContent)) {
236                         // Something went wrong!
237                         debug_report_bug(__FUNCTION__, __LINE__, 'Evaluation error:<pre>' . linenumberCode($eval) . '</pre>', false);
238                 } // END - if
239
240                 // Use it again
241                 $code = $newContent;
242
243                 // Count round
244                 $count++;
245         } // END - while
246
247         // Return the compiled code
248         return $code;
249 }
250
251 // Output the raw HTML code
252 function outputRawCode ($htmlCode) {
253         // Output stripped HTML code to avoid broken JavaScript code, etc.
254         print(str_replace('{BACK}', "\\", $htmlCode));
255
256         // Flush the output if only getPhpCaching() is not 'on'
257         if (getPhpCaching() != 'on') {
258                 // Flush it
259                 flush();
260         } // END - if
261 }
262
263 // Load a template file and return it's content (only it's name; do not use ' or ")
264 function loadTemplate ($template, $return = false, $content = array(), $compileCode = true) {
265         // @TODO Remove this sanity-check if all is fine
266         if (!is_bool($return)) debug_report_bug(__FUNCTION__, __LINE__, 'return is not bool (' . gettype($return) . ')');
267
268         // Set current template
269         $GLOBALS['current_template'] = $template;
270
271         // Do we have cache?
272         if ((!isDebuggingTemplateCache()) && (isTemplateCached($template))) {
273                 // Evaluate the cache
274                 eval(readTemplateCache($template));
275         } elseif (!isset($GLOBALS['template_eval'][$template])) {
276                 // Make all template names lowercase
277                 $template = strtolower($template);
278
279                 // Init some data
280                 $ret = '';
281
282                 // Base directory
283                 $basePath = sprintf("%stemplates/%s/html/", getPath(), getLanguage());
284                 $extraPath = detectExtraTemplatePath($template);
285
286                 // Generate FQFN
287                 $FQFN = $basePath . $extraPath . $template . '.tpl';
288
289                 // Does the special template exists?
290                 if (!isFileReadable($FQFN)) {
291                         // Reset to default template
292                         $FQFN = $basePath . $template . '.tpl';
293                 } // END - if
294
295                 // Now does the final template exists?
296                 if (isFileReadable($FQFN)) {
297                         // Count the template load
298                         incrementConfigEntry('num_templates');
299
300                         // The local file does exists so we load it. :)
301                         $GLOBALS['tpl_content'][$template] = readFromFile($FQFN);
302
303                         // Do we have to compile the code?
304                         $ret = '';
305                         if ((strpos($GLOBALS['tpl_content'][$template], '$') !== false) || (strpos($GLOBALS['tpl_content'][$template], '{--') !== false) || (strpos($GLOBALS['tpl_content'][$template], '{?') !== false) || (strpos($GLOBALS['tpl_content'][$template], '{%') !== false)) {
306                                 // Normal HTML output?
307                                 if (isHtmlOutputMode()) {
308                                         // Add surrounding HTML comments to help finding bugs faster
309                                         $ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'][$template] . '<!-- Template ' . $template . ' - End //-->';
310
311                                         // Prepare eval() command
312                                         $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileCode(escapeQuotes($ret), false, true, true, $compileCode) . '";';
313                                 } elseif (substr($template, 0, 3) == 'js_') {
314                                         // JavaScripts don't like entities and timings
315                                         $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['tpl_content'][$template]), false, true, true, $compileCode) . '");';
316                                 } else {
317                                         // Prepare eval() command, other output doesn't like entities, maybe
318                                         $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template]), false, true, true, $compileCode) . '");';
319                                 }
320                         } else {
321                                 // Add surrounding HTML comments to help finding bugs faster
322                                 $ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'][$template] . '<!-- Template ' . $template . ' - End //-->';
323                                 $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileRawCode(escapeQuotes($ret), false, true, true, $compileCode) . '";';
324                         } // END - if
325                 } elseif ((isAdmin()) || ((isInstalling()) && (!isInstalled()))) {
326                         // Only admins shall see this warning or when installation mode is active
327                         $ret = '<div class="para">
328         <span class="notice">{--TEMPLATE_404--}</span>
329 </div>
330 <div class="para">
331         (' . $template . ')
332 </div>
333 <div class="para">
334         {--TEMPLATE_CONTENT--}
335         <pre>' . print_r($content, true) . '</pre>
336 </div>';
337                 } else {
338                         // No file!
339                         $GLOBALS['template_eval'][$template] = '404';
340                 }
341         }
342
343         // Code set?
344         if ((isset($GLOBALS['template_eval'][$template])) && ($GLOBALS['template_eval'][$template] != '404')) {
345                 // Eval the code
346                 eval($GLOBALS['template_eval'][$template]);
347         } // END - if
348
349         // Do we have some content to output or return?
350         if (!empty($ret)) {
351                 // Not empty so let's put it out! ;)
352                 if ($return === true) {
353                         // Return the HTML code
354                         return $ret;
355                 } else {
356                         // Output directly
357                         outputHtml($ret);
358                 }
359         } elseif (isDebugModeEnabled()) {
360                 // Warning, empty output!
361                 return 'E:' . $template . ',content=<pre>' . print_r($content, true) . '</pre>';
362         }
363 }
364
365 // Detects the extra template path from given template name
366 function detectExtraTemplatePath ($template) {
367         // Default is empty
368         $extraPath = '';
369
370         // Do we have cache?
371         if (!isset($GLOBALS['extra_path'][$template])) {
372                 // Check for admin/guest/member/etc. templates
373                 if (substr($template, 0, 6) == 'admin_') {
374                         // Admin template found
375                         $extraPath = 'admin/';
376                 } elseif (substr($template, 0, 6) == 'guest_') {
377                         // Guest template found
378                         $extraPath = 'guest/';
379                 } elseif (substr($template, 0, 7) == 'member_') {
380                         // Member template found
381                         $extraPath = 'member/';
382                 } elseif (substr($template, 0, 7) == 'select_') {
383                         // Selection template found
384                         $extraPath = 'select/';
385                 } elseif (substr($template, 0, 8) == 'install_') {
386                         // Installation template found
387                         $extraPath = 'install/';
388                 } elseif (substr($template, 0, 4) == 'ext_') {
389                         // Extension template found
390                         $extraPath = 'ext/';
391                 } elseif (substr($template, 0, 3) == 'la_') {
392                         // 'Logical-area' template found
393                         $extraPath = 'la/';
394                 } elseif (substr($template, 0, 3) == 'js_') {
395                         // JavaScript template found
396                         $extraPath = 'js/';
397                 } elseif (substr($template, 0, 5) == 'menu_') {
398                         // Menu template found
399                         $extraPath = 'menu/';
400                 } else {
401                         // Test for extension
402                         $test = substr($template, 0, strpos($template, '_'));
403
404                         // Probe for valid extension name
405                         if (isExtensionNameValid($test)) {
406                                 // Set extra path to extension's name
407                                 $extraPath = $test . '/';
408                         } // END - if
409                 }
410
411                 // Store it in cache
412                 $GLOBALS['extra_path'][$template] = $extraPath;
413         } // END - if
414
415         // Return result
416         return $GLOBALS['extra_path'][$template];
417 }
418
419 // Loads an email template and compiles it
420 function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadUserData = true) {
421         global $DATA;
422
423         // Make sure all template names are lowercase!
424         $template = strtolower($template);
425
426         // Is content an array?
427         if (is_array($content)) {
428                 // Add expiration to array
429                 if ((isConfigEntrySet('auto_purge')) && (getAutoPurge() == '0')) {
430                         // Will never expire!
431                         $content['expiration'] = '{--MAIL_WILL_NEVER_EXPIRE--}';
432                 } elseif (isConfigEntrySet('auto_purge')) {
433                         // Create nice date string
434                         $content['expiration'] = '{%pipe,getAutoPurge,createFancyTime%}';
435                 } else {
436                         // Missing entry
437                         $content['expiration'] = '{--MAIL_NO_CONFIG_AUTO_PURGE--}';
438                 }
439         } // END - if
440
441         // Load user's data
442         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UID={$userid},template={$template},content[]=".gettype($content));
443         if ((isValidUserId($userid)) && (is_array($content))) {
444                 // If nickname extension is installed, fetch nickname as well
445                 if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
446                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NICKNAME!<br />");
447                         // Load by nickname
448                         fetchUserData($userid, 'nickname');
449                 } else {
450                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NO-NICK!<br />");
451                         /// Load by userid
452                         fetchUserData($userid);
453                 }
454
455                 // Merge data if valid
456                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - PRE<br />");
457                 if ((isUserDataValid()) && ($loadUserData === true)) {
458                         $content = merge_array($content, getUserDataArray());
459                 } // END - if
460                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - AFTER<br />");
461         } // END - if
462
463         // Base directory
464         $basePath = sprintf("%stemplates/%s/emails/", getPath(), getLanguage());
465
466         // Detect extra path
467         $extraPath = detectExtraTemplatePath($template);
468
469         // Generate full FQFN
470         $FQFN = $basePath . $extraPath . $template . '.tpl';
471
472         // Does the special template exists?
473         if (!isFileReadable($FQFN)) {
474                 // Reset to default template
475                 $FQFN = $basePath . $template . '.tpl';
476         } // END - if
477
478         // Now does the final template exists?
479         $newContent = '';
480         if (isFileReadable($FQFN)) {
481                 // The local file does exists so we load it. :)
482                 $GLOBALS['tpl_content'][$template] = readFromFile($FQFN);
483
484                 // Run code
485                 $GLOBALS['tpl_content'][$template] = '$newContent = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template])) . '");';
486                 eval($GLOBALS['tpl_content'][$template]);
487         } elseif (!empty($template)) {
488                 // Template file not found
489                 $newContent = '<div class="para">
490         {--TEMPLATE_404--}: ' . $template . '
491 </div>
492 <div class="para">
493         {--TEMPLATE_CONTENT--}
494         <pre>' . print_r($content, true) . '</pre>
495         {--TEMPLATE_DATA--}
496         <pre>' . print_r($DATA, true) . '</pre>
497 </div>';
498
499                 // Debug mode not active? Then remove the HTML tags
500                 if (!isDebugModeEnabled()) {
501                         // Remove HTML tags
502                         $newContent = secureString($newContent);
503                 } // END - if
504         } else {
505                 // No template name supplied!
506                 $newContent = '{--NO_TEMPLATE_SUPPLIED--}';
507         }
508
509         // Is there some content?
510         if (empty($newContent)) {
511                 // Compiling failed
512                 $newContent = "Compiler error for template " . $template . " !\nUncompiled content:\n" . $GLOBALS['tpl_content'][$template];
513
514                 // Add last error if the required function exists
515                 if (function_exists('error_get_last')) $newContent .= "\n--------------------------------------\nDebug:\n".print_r(error_get_last(), true)."--------------------------------------\nPlease don't alter these informations!\nThanx.";
516         } // END - if
517
518         // Remove content and data
519         unset($content);
520         unset($DATA);
521
522         // Return content
523         return $newContent;
524 }
525
526 // "Getter" for menu CSS classes, mainly used in templates
527 function getMenuCssClasses ($data) {
528         // $data needs to be converted into an array
529         $content = explode('|', $data);
530
531         // Non-existent index 2 will happen in menu blocks
532         if (!isset($content[2])) $content[2] = '';
533
534         // Re-construct the array: 0=visible,1=locked,2=prefix
535         $content['visible'] = $content[0];
536         $content['locked']  = $content[1];
537
538         // Call our "translator" function
539         $content = translateMenuVisibleLocked($content, $content[2]);
540
541         // Return CSS classes
542         return ($content['visible_css'] . ' ' . $content['locked_css']);
543 }
544
545 // Generate XHTML code for the CAPTCHA
546 function generateCaptchaCode ($code, $type, $DATA, $userid) {
547         return '<img border="0" alt="Code ' . $code . '" src="{%url=mailid_top.php?userid=' . $userid . '&amp;' . $type . '=' . $DATA . '&amp;mode=img&amp;code=' . $code . '%}" />';
548 }
549
550 // Compiles the given HTML/mail code
551 function compileCode ($code, $simple = false, $constants = true, $full = true, $compileCode = true) {
552         // Is the code a string or should we not compile?
553         if ((!is_string($code)) || ($compileCode === false)) {
554                 // Silently return it
555                 return $code;
556         } // END - if
557
558         // Start couting
559         $startCompile = microtime(true);
560
561         // Comile the code
562         $code = compileRawCode($code, $simple, $constants, $full);
563
564         // Get timing
565         $compiled = microtime(true);
566
567         // Add timing if enabled
568         if (isTemplateHtml()) {
569                 // Add timing, this should be disabled in
570                 $code .= '<!-- Compilation time: ' . (($compiled - $startCompile) * 1000). 'ms //-->';
571         } // END - if
572
573         // Return compiled code
574         return $code;
575 }
576
577 // Compiles the code (use compileCode() only for HTML because of the comments)
578 // @TODO $simple/$constants are deprecated
579 function compileRawCode ($code, $simple = false, $constants = true, $full = true, $compileCode = true) {
580         // Is the code a string or shall we not compile?
581         if ((!is_string($code)) || ($compileCode === false)) {
582                 // Silently return it
583                 return $code;
584         } // END - if
585
586         // Init replacement-array with smaller set of security characters
587         $secChars = $GLOBALS['url_chars'];
588
589         // Select full set of chars to replace when we e.g. want to compile URLs
590         if ($full === true) {
591                 $secChars = $GLOBALS['security_chars'];
592         } // END - if
593
594         // Compile more through a filter
595         $code = runFilterChain('compile_code', $code);
596
597         // Compile message strings
598         $code = str_replace('{--', '{%message,', str_replace('--}', '%}', $code));
599
600         // Compile QUOT and other non-HTML codes
601         $code = str_replace($secChars['to'], $secChars['from'], $code);
602
603         // Find $content[bla][blub] entries
604         // @TODO Do only use $content and deprecate $GLOBALS and $DATA in templates
605         preg_match_all('/\$(content|GLOBALS|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
606
607         // Are some matches found?
608         if ((count($matches) > 0) && (count($matches[0]) > 0)) {
609                 // Replace all matches
610                 $matchesFound = array();
611                 foreach ($matches[0] as $key => $match) {
612                         // Fuzzy look has failed by default
613                         $fuzzyFound = false;
614
615                         // Fuzzy look on match if already found
616                         foreach ($matchesFound as $found => $set) {
617                                 // Get test part
618                                 $test = substr($found, 0, strlen($match));
619
620                                 // Does this entry exist?
621                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "found={$found},match={$match},set={$set}<br />");
622                                 if ($test == $match) {
623                                         // Match found
624                                         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "fuzzyFound!<br />");
625                                         $fuzzyFound = true;
626                                         break;
627                                 } // END - if
628                         } // END - foreach
629
630                         // Skip this entry?
631                         if ($fuzzyFound === true) continue;
632
633                         // Take all string elements
634                         if ((is_string($matches[4][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key.'_' . $matches[4][$key]]))) {
635                                 // Replace it in the code
636                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "key={$key},match={$match}<br />");
637                                 $newMatch = str_replace('[', "['", str_replace(']', "']", $match));
638                                 $code = str_replace($match, '".' . $newMatch . '."', $code);
639                                 $matchesFound[$key . '_' . $matches[4][$key]] = 1;
640                                 $matchesFound[$match] = 1;
641                         } elseif (!isset($matchesFound[$match])) {
642                                 // Not yet replaced!
643                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "match={$match}<br />");
644                                 $code = str_replace($match, '".' . $match . '."', $code);
645                                 $matchesFound[$match] = 1;
646                         }
647                 } // END - foreach
648         } // END - if
649
650         // Return it
651         return $code;
652 }
653
654 //
655 function addSelectionBox ($type, $default, $prefix = '', $id = '0', $class = 'form_select') {
656         $OUT = '';
657
658         if ($type == 'yn') {
659                 // This is a yes/no selection only!
660                 if ($id > 0) $prefix .= '[' . $id . ']';
661                 $OUT .= '<select name="' . $prefix . '" class="' . $class . '" size="1">';
662         } else {
663                 // Begin with regular selection box here
664                 if (!empty($prefix)) $prefix .= '_';
665                 $type2 = $type;
666                 if ($id > 0) $type2 .= '[' . $id . ']';
667                 $OUT .= '<select name="' . strtolower($prefix . $type2) . '" class="' . $class . '" size="1">';
668         }
669
670         switch ($type) {
671                 case 'day': // Day
672                         for ($idx = 1; $idx < 32; $idx++) {
673                                 $OUT .= '<option value="' . $idx . '"';
674                                 if ($default == $idx) $OUT .= ' selected="selected"';
675                                 $OUT .= '>' . $idx . '</option>';
676                         } // END - for
677                         break;
678
679                 case 'month': // Month
680                         foreach ($GLOBALS['month_descr'] as $idx => $descr) {
681                                 $OUT .= '<option value="' . $idx . '"';
682                                 if ($default == $idx) $OUT .= ' selected="selected"';
683                                 $OUT .= '>' . $descr . '</option>';
684                         } // END - for
685                         break;
686
687                 case 'year': // Year
688                         // Get current year
689                         $year = getYear();
690
691                         // Use configured min age or fixed?
692                         if (isExtensionInstalledAndNewer('order', '0.2.1')) {
693                                 // Configured
694                                 $startYear = $year - getConfig('min_age');
695                         } else {
696                                 // Fixed 16 years
697                                 $startYear = $year - 16;
698                         }
699
700                         // Calculate earliest year (100 years old people can still enter Internet???)
701                         $minYear = $year - 100;
702
703                         // Check if the default value is larger than minimum and bigger than actual year
704                         if (($default > $minYear) && ($default >= $year)) {
705                                 for ($idx = $year; $idx < ($year + 11); $idx++) {
706                                         $OUT .= '<option value="' . $idx . '"';
707                                         if ($default == $idx) $OUT .= ' selected="selected"';
708                                         $OUT .= '>' . $idx . '</option>';
709                                 } // END - for
710                         } elseif ($default == -1) {
711                                 // Current year minus 1
712                                 for ($idx = $startYear; $idx <= ($year + 1); $idx++) {
713                                         $OUT .= '<option value="' . $idx . '">' . $idx . '</option>';
714                                 } // END - for
715                         } else {
716                                 // Get current year and subtract the configured minimum age
717                                 $OUT .= '<option value="' . ($minYear - 1) . '">&lt;' . $minYear . '</option>';
718                                 // Calculate earliest year depending on extension version
719                                 if (isExtensionInstalledAndNewer('order', '0.2.1')) {
720                                         // Use configured minimum age
721                                         $year = getYear() - getConfig('min_age');
722                                 } else {
723                                         // Use fixed 16 years age
724                                         $year = getYear() - 16;
725                                 }
726
727                                 // Construct year selection list
728                                 for ($idx = $minYear; $idx <= $year; $idx++) {
729                                         $OUT .= '<option value="' . $idx . '"';
730                                         if ($default == $idx) $OUT .= ' selected="selected"';
731                                         $OUT .= '>' . $idx . '</option>';
732                                 } // END - for
733                         }
734                         break;
735
736                 case 'sec':
737                 case 'min':
738                         for ($idx = 0; $idx < 60; $idx+=5) {
739                                 if (strlen($idx) == 1) $idx = '0' . $idx;
740                                 $OUT .= '<option value="' . $idx . '"';
741                                 if ($default == $idx) $OUT .= ' selected="selected"';
742                                 $OUT .= '>' . $idx . '</option>';
743                         } // END - for
744                         break;
745
746                 case 'hour':
747                         for ($idx = 0; $idx < 24; $idx++) {
748                                 if (strlen($idx) == 1) $idx = '0' . $idx;
749                                 $OUT .= '<option value="' . $idx . '"';
750                                 if ($default == $idx) $OUT .= ' selected="selected"';
751                                 $OUT .= '>' . $idx . '</option>';
752                         } // END - for
753                         break;
754
755                 case 'yn':
756                         $OUT .= '<option value="Y"';
757                         if ($default == 'Y') $OUT .= ' selected="selected"';
758                         $OUT .= '>{--YES--}</option><option value="N"';
759                         if ($default != 'Y') $OUT .= ' selected="selected"';
760                         $OUT .= '>{--NO--}</option>';
761                         break;
762         }
763         $OUT .= '</select>';
764         return $OUT;
765 }
766
767 // Insert the code in $img_code into jpeg or PNG image
768 function generateImageOrCode ($img_code, $headerSent = true) {
769         // Is the code size oversized or shouldn't we display it?
770         if ((strlen($img_code) > 6) || (empty($img_code)) || (getCodeLength() == '0')) {
771                 // Stop execution of function here because of over-sized code length
772                 debug_report_bug(__FUNCTION__, __LINE__, 'img_code ' . $img_code .' has invalid length. img_code()=' . strlen($img_code) . ' code_length=' . getCodeLength());
773         } elseif ($headerSent === false) {
774                 // Return an HTML code here
775                 return '<img src="{%url=img.php?code=' . $img_code . '%}" alt="Image" />';
776         }
777
778         // Load image
779         $img = sprintf("%s/theme/%s/images/code_bg.%s",
780                 getPath(),
781                 getCurrentTheme(),
782                 getImgType()
783         );
784
785         // Is it readable?
786         if (isFileReadable($img)) {
787                 // Switch image type
788                 switch (getImgType()) {
789                         case 'jpg': // Okay, load image and hide all errors
790                                 $image = imagecreatefromjpeg($img);
791                                 break;
792
793                         case 'png': // Okay, load image and hide all errors
794                                 $image = imagecreatefrompng($img);
795                                 break;
796                 } // END - switch
797         } else {
798                 // Silently log the error
799                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File for image-type %s in theme %s not found.", getImgType(), getCurrentTheme()));
800                 return;
801         }
802
803         // Generate text color (red/green/blue; 0 = dark, 255 = bright)
804         $text_color = imagecolorallocate($image, 0, 0, 0);
805
806         // Insert code into image
807         imagestring($image, 5, 14, 2, $img_code, $text_color);
808
809         // Return to browser
810         setContentType('image/' . getImgType());
811
812         // Output image with matching image factory
813         switch (getImgType()) {
814                 case 'jpg': imagejpeg($image); break;
815                 case 'png': imagepng($image);  break;
816         } // END - switch
817
818         // Remove image from memory
819         imagedestroy($image);
820 }
821 // Create selection box or array of splitted timestamp
822 function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $return_array=false) {
823         // Do not continue if ONE_DAY is absend
824         if (!isConfigEntrySet('ONE_DAY')) {
825                 // And return the timestamp itself or empty array
826                 if ($return_array === true) {
827                         return array();
828                 } else {
829                         return $timestamp;
830                 }
831         } // END - if
832
833         // Calculate 2-seconds timestamp
834         $stamp = round($timestamp);
835         //* DEBUG: */ debugOutput('*' . $stamp .'/' . $timestamp . '*');
836
837         // Do we have a leap year?
838         $SWITCH = '0';
839         $TEST = getYear() / 4;
840         $M1 = getMonth();
841         $M2 = getMonth(time() + $timestamp);
842
843         // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
844         if ((floor($TEST) == $TEST) && ($M1 == '02') && ($M2 > '02'))  $SWITCH = getOneDay();
845
846         // First of all years...
847         $Y = abs(floor($timestamp / (31536000 + $SWITCH)));
848         //* DEBUG: */ debugOutput('Y=' . $Y);
849         // Next months...
850         $M = abs(floor($timestamp / 2628000 - $Y * 12));
851         //* DEBUG: */ debugOutput('M=' . $M);
852         // Next weeks
853         $W = abs(floor($timestamp / 604800 - $Y * ((365 + $SWITCH / getOneDay()) / 7) - ($M / 12 * (365 + $SWITCH / getOneDay()) / 7)));
854         //* DEBUG: */ debugOutput('W=' . $W);
855         // Next days...
856         $D = abs(floor($timestamp / 86400 - $Y * (365 + $SWITCH / getOneDay()) - ($M / 12 * (365 + $SWITCH / getOneDay())) - $W * 7));
857         //* DEBUG: */ debugOutput('D=' . $D);
858         // Next hours...
859         $h = abs(floor($timestamp / 3600 - $Y * (365 + $SWITCH / getOneDay()) * 24 - ($M / 12 * (365 + $SWITCH / getOneDay()) * 24) - $W * 7 * 24 - $D * 24));
860         //* DEBUG: */ debugOutput('h=' . $h);
861         // Next minutes..
862         $m = abs(floor($timestamp / 60 - $Y * (365 + $SWITCH / getOneDay()) * 24 * 60 - ($M / 12 * (365 + $SWITCH / getOneDay()) * 24 * 60) - $W * 7 * 24 * 60 - $D * 24 * 60 - $h * 60));
863         //* DEBUG: */ debugOutput('m=' . $m);
864         // And at last seconds...
865         $s = abs(floor($timestamp - $Y * (365 + $SWITCH / getOneDay()) * 24 * 3600 - ($M / 12 * (365 + $SWITCH / getOneDay()) * 24 * 3600) - $W * 7 * 24 * 3600 - $D * 24 * 3600 - $h * 3600 - $m * 60));
866         //* DEBUG: */ debugOutput('s=' . $s);
867
868         // Is seconds zero and time is < 60 seconds?
869         if (($s == '0') && ($timestamp < 60)) {
870                 // Fix seconds
871                 $s = round($timestamp);
872         } // END - if
873
874         //
875         // Now we convert them in seconds...
876         //
877         if ($return_array) {
878                 // Just put all data in an array for later use
879                 $OUT = array(
880                         'YEARS'   => $Y,
881                         'MONTHS'  => $M,
882                         'WEEKS'   => $W,
883                         'DAYS'    => $D,
884                         'HOURS'   => $h,
885                         'MINUTES' => $m,
886                         'SECONDS' => $s
887                 );
888         } else {
889                 // Generate table
890                 $OUT  = '<div align="' . $align . '">';
891                 $OUT .= '<table border="0" cellspacing="0" cellpadding="0" class="timebox_table dashed">';
892                 $OUT .= '<tr>';
893
894                 if (isInString('Y', $display) || (empty($display))) {
895                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_YEARS--}</strong></td>';
896                 } // END - if
897
898                 if (isInString('M', $display) || (empty($display))) {
899                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MONTHS--}</strong></td>';
900                 } // END - if
901
902                 if (isInString('W', $display) || (empty($display))) {
903                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_WEEKS--}</strong></td>';
904                 } // END - if
905
906                 if (isInString('D', $display) || (empty($display))) {
907                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_DAYS--}</strong></td>';
908                 } // END - if
909
910                 if (isInString('h', $display) || (empty($display))) {
911                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_HOURS--}</strong></td>';
912                 } // END - if
913
914                 if (isInString('m', $display) || (empty($display))) {
915                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MINUTES--}</strong></td>';
916                 } // END - if
917
918                 if (isInString('s', $display) || (empty($display))) {
919                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_SECONDS--}</strong></td>';
920                 } // END - if
921
922                 $OUT .= '</tr>';
923                 $OUT .= '<tr>';
924
925                 if (isInString('Y', $display) || (empty($display))) {
926                         // Generate year selection
927                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ye" size="1">';
928                         for ($idx = 0; $idx <= 10; $idx++) {
929                                 $OUT .= '<option class="mini_select" value="' . $idx . '"';
930                                 if ($idx == $Y) $OUT .= ' selected="selected"';
931                                 $OUT .= '>' . $idx . '</option>';
932                         } // END - for
933                         $OUT .= '</select></td>';
934                 } else {
935                         $OUT .= '<input type="hidden" name="' . $prefix . '_ye" value="0" />';
936                 }
937
938                 if (isInString('M', $display) || (empty($display))) {
939                         // Generate month selection
940                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mo" size="1">';
941                         for ($idx = 0; $idx <= 11; $idx++) {
942                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
943                                 if ($idx == $M) $OUT .= ' selected="selected"';
944                                 $OUT .= '>' . $idx . '</option>';
945                         } // END - for
946                         $OUT .= '</select></td>';
947                 } else {
948                         $OUT .= '<input type="hidden" name="' . $prefix . '_mo" value="0" />';
949                 }
950
951                 if (isInString('W', $display) || (empty($display))) {
952                         // Generate week selection
953                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_we" size="1">';
954                         for ($idx = 0; $idx <= 4; $idx++) {
955                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
956                                 if ($idx == $W) $OUT .= ' selected="selected"';
957                                 $OUT .= '>' . $idx . '</option>';
958                         } // END - for
959                         $OUT .= '</select></td>';
960                 } else {
961                         $OUT .= '<input type="hidden" name="' . $prefix . '_we" value="0" />';
962                 }
963
964                 if (isInString('D', $display) || (empty($display))) {
965                         // Generate day selection
966                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_da" size="1">';
967                         for ($idx = 0; $idx <= 31; $idx++) {
968                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
969                                 if ($idx == $D) $OUT .= ' selected="selected"';
970                                 $OUT .= '>' . $idx . '</option>';
971                         } // END - for
972                         $OUT .= '</select></td>';
973                 } else {
974                         $OUT .= '<input type="hidden" name="' . $prefix . '_da" value="0" />';
975                 }
976
977                 if (isInString('h', $display) || (empty($display))) {
978                         // Generate hour selection
979                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ho" size="1">';
980                         for ($idx = 0; $idx <= 23; $idx++) {
981                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
982                                 if ($idx == $h) $OUT .= ' selected="selected"';
983                                 $OUT .= '>' . $idx . '</option>';
984                         } // END - for
985                         $OUT .= '</select></td>';
986                 } else {
987                         $OUT .= '<input type="hidden" name="' . $prefix . '_ho" value="0" />';
988                 }
989
990                 if (isInString('m', $display) || (empty($display))) {
991                         // Generate minute selection
992                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mi" size="1">';
993                         for ($idx = 0; $idx <= 59; $idx++) {
994                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
995                                 if ($idx == $m) $OUT .= ' selected="selected"';
996                                 $OUT .= '>' . $idx . '</option>';
997                         } // END - for
998                         $OUT .= '</select></td>';
999                 } else {
1000                         $OUT .= '<input type="hidden" name="' . $prefix . '_mi" value="0" />';
1001                 }
1002
1003                 if (isInString('s', $display) || (empty($display))) {
1004                         // Generate second selection
1005                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_se" size="1">';
1006                         for ($idx = 0; $idx <= 59; $idx++) {
1007                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
1008                                 if ($idx == $s) $OUT .= ' selected="selected"';
1009                                 $OUT .= '>' . $idx . '</option>';
1010                         } // END - for
1011                         $OUT .= '</select></td>';
1012                 } else {
1013                         $OUT .= '<input type="hidden" name="' . $prefix . '_se" value="0" />';
1014                 }
1015                 $OUT .= '</tr>';
1016                 $OUT .= '</table>';
1017                 $OUT .= '</div>';
1018         }
1019
1020         // Return generated HTML code
1021         return $OUT;
1022 }
1023
1024 // Generate a list of administrative links to a given userid
1025 function generateMemberAdminActionLinks ($userid) {
1026         // Make sure userid is a number
1027         if ($userid != bigintval($userid)) debug_report_bug(__FUNCTION__, __LINE__, 'userid is not a number!');
1028
1029         // Define all main targets
1030         $targetArray = array('del_user', 'edit_user', 'lock_user', 'add_points', 'sub_points');
1031
1032         // Get user status
1033         $status = getFetchedUserData('userid', $userid, 'status');
1034
1035         // Begin of navigation links
1036         $OUT = '[';
1037
1038         foreach ($targetArray as $tar) {
1039                 $OUT .= '<span class="admin_user_link"><a href="{%url=modules.php?module=admin&amp;what=' . $tar . '&amp;userid=' . $userid . '%}" title="{--ADMIN_USER_ACTION_LINK_';
1040                 //* DEBUG: */ debugOutput('*' . $tar.'/' . $status.'*');
1041                 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
1042                         // Locked accounts shall be unlocked
1043                         $OUT .= 'UNLOCK_USER';
1044                 } elseif ($tar == 'del_user') {
1045                         // @TODO Deprecate this thing
1046                         $OUT .= 'DELETE_USER';
1047                 } else {
1048                         // All other status is fine
1049                         $OUT .= strtoupper($tar);
1050                 }
1051                 $OUT .= '_TITLE--}">{--ADMIN_USER_ACTION_LINK_';
1052                 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
1053                         // Locked accounts shall be unlocked
1054                         $OUT .= 'UNLOCK_USER';
1055                 } elseif ($tar == 'del_user') {
1056                         // @TODO Deprecate this thing
1057                         $OUT .= 'DELETE_USER';
1058                 } else {
1059                         // All other status is fine
1060                         $OUT .= strtoupper($tar);
1061                 }
1062                 $OUT .= '--}</a></span>|';
1063         } // END - foreach
1064
1065         // Finish navigation link
1066         $OUT = substr($OUT, 0, -1) . ']';
1067
1068         // Return string
1069         return $OUT;
1070 }
1071
1072 // Generate an email link
1073 function generateEmailLink ($email, $table = 'admins') {
1074         // Default email link (INSECURE! Spammer can read this by harvester programs)
1075         $EMAIL = 'mailto:' . $email;
1076
1077         // Check for several extensions
1078         if ((isExtensionActive('admins')) && ($table == 'admins')) {
1079                 // Create email link for contacting admin in guest area
1080                 $EMAIL = generateAdminEmailLink($email);
1081         } elseif ((isExtensionInstalledAndNewer('user', '0.3.3')) && ($table == 'user_data')) {
1082                 // Create email link for contacting a member within admin area (or later in other areas, too?)
1083                 $EMAIL = generateUserEmailLink($email);
1084         } elseif ((isExtensionActive('sponsor')) && ($table == 'sponsor_data')) {
1085                 // Create email link to contact sponsor within admin area (or like the link above?)
1086                 $EMAIL = generateSponsorEmailLink($email);
1087         }
1088
1089         // Shall I close the link when there is no admin?
1090         if ((!isAdmin()) && ($EMAIL == $email)) $EMAIL = '#'; // Closed!
1091
1092         // Return email link
1093         return $EMAIL;
1094 }
1095
1096 // Output error messages in a fasioned way and die...
1097 function app_die ($F, $L, $message) {
1098         // Check if Script is already dieing and not let it kill itself another 1000 times
1099         if (isset($GLOBALS['app_died'])) {
1100                 // Script tried to kill itself twice
1101                 die('[' . __FUNCTION__ . ':' . __LINE__ . ']: Script wanted to kill itself more than once! Raw message=' . $message . ', file/function=' . $F . ', line=' . $L);
1102         } // END - if
1103
1104         // Make sure, that the script realy realy diese here and now
1105         $GLOBALS['app_died'] = true;
1106
1107         // Set content type as text/html
1108         setContentType('text/html');
1109
1110         // Load header
1111         loadIncludeOnce('inc/header.php');
1112
1113         // Rewrite message for output
1114         $message = sprintf(getMessage('MAILER_HAS_DIED'), basename($F), $L, $message);
1115
1116         // Load the message template
1117         loadTemplate('app_die_message', false, $message);
1118
1119         // Load footer
1120         loadIncludeOnce('inc/footer.php');
1121 }
1122
1123 // Display parsing time and number of SQL queries in footer
1124 function displayParsingTime () {
1125         // Is the timer started?
1126         if (!isset($GLOBALS['startTime'])) {
1127                 // Abort here
1128                 return false;
1129         } // END - if
1130
1131         // Get end time
1132         $endTime = microtime(true);
1133
1134         // "Explode" both times
1135         $start = explode(' ', $GLOBALS['startTime']);
1136         $end = explode(' ', $endTime);
1137         $runTime = $end[0] - $start[0];
1138         if ($runTime < 0) {
1139                 $runTime = '0';
1140         } // END - if
1141
1142         // Prepare output
1143         // @TODO This can be easily moved out after the merge from EL branch to this is complete
1144         $content = array(
1145                 'run_time' => $runTime,
1146                 'sql_time' => (getConfig('sql_time') * 1000),
1147         );
1148
1149         // Load the template
1150         $GLOBALS['page_footer'] .= loadTemplate('show_timings', true, $content);
1151 }
1152
1153 // Output a debug backtrace to the user
1154 function debug_report_bug ($F, $L, $message = '', $sendEmail = true) {
1155         // Is this already called?
1156         if (isset($GLOBALS[__FUNCTION__])) {
1157                 // Other backtrace
1158                 print 'Message:' . $message . '<br />Backtrace:<pre>';
1159                 debug_print_backtrace();
1160                 die('</pre>');
1161         } // END - if
1162
1163         // Set this function as called
1164         $GLOBALS[__FUNCTION__] = true;
1165
1166         // Init message
1167         $debug = '';
1168
1169         // Is the optional message set?
1170         if (!empty($message)) {
1171                 // Use and log it
1172                 $debug = sprintf("Note: %s<br />\n",
1173                         $message
1174                 );
1175
1176                 // @TODO Add a little more infos here
1177                 logDebugMessage($F, $L, strip_tags($message));
1178         } // END - if
1179
1180         // Add output
1181         $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(getPath(), '', getCachePath()) . 'debug.log</strong> in your report (you can now attach files):<pre>';
1182         $debug .= debug_get_printable_backtrace();
1183         $debug .= '</pre>';
1184         $debug .= '<div class="para">Request-URI: ' . getRequestUri() . '</div>';
1185         $debug .= '<div class="para">Thank you for finding bugs.</div>';
1186
1187         // Send an email? (e.g. not wanted for evaluation errors)
1188         if (($sendEmail === true) && (!isInstallationPhase())) {
1189                 // Prepare content
1190                 $content = array(
1191                         'message'   => trim($message),
1192                         'backtrace' => trim(debug_get_mailable_backtrace())
1193                 );
1194
1195                 // Send email to webmaster
1196                 sendAdminNotification('{--DEBUG_REPORT_BUG_SUBJECT--}', 'admin_report_bug', $content);
1197         } // END - if
1198
1199         // And abort here
1200         app_die($F, $L, $debug);
1201 }
1202
1203 // Compile characters which are allowed in URLs
1204 function compileUriCode ($code, $simple = true) {
1205         // Compile constants
1206         if ($simple === false) $code = str_replace('{--', '".', str_replace('--}', '."', $code));
1207
1208         // Compile QUOT and other non-HTML codes
1209         $code = str_replace('{DOT}', '.',
1210                 str_replace('{SLASH}', '/',
1211                 str_replace('{QUOT}', "'",
1212                 str_replace('{DOLLAR}', '$',
1213                 str_replace('{OPEN_ANCHOR}', '(',
1214                 str_replace('{CLOSE_ANCHOR}', ')',
1215                 str_replace('{OPEN_SQR}', '[',
1216                 str_replace('{CLOSE_SQR}', ']',
1217                 str_replace('{PER}', '%',
1218                 $code
1219         )))))))));
1220
1221         // Return compiled code
1222         return $code;
1223 }
1224
1225 // Handle message codes from URL
1226 function handleCodeMessage () {
1227         if (isGetRequestParameterSet('code')) {
1228                 // Default extension is 'unknown'
1229                 $ext = 'unknown';
1230
1231                 // Is extension given?
1232                 if (isGetRequestParameterSet('ext')) $ext = getRequestParameter('ext');
1233
1234                 // Convert the 'code' parameter from URL to a human-readable message
1235                 $message = getMessageFromErrorCode(getRequestParameter('code'));
1236
1237                 // Load message template
1238                 loadTemplate('message', false, $message);
1239         } // END - if
1240 }
1241
1242 // Generates a 'extension foo out-dated' message
1243 function generateExtensionOutdatedMessage ($ext_name, $ext_ver) {
1244         // Is the extension empty?
1245         if (empty($ext_name)) {
1246                 // This should not happen
1247                 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1248         } // END - if
1249
1250         // Default message
1251         $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_OUTDATED', $ext_name);
1252
1253         // Is an admin logged in?
1254         if (isAdmin()) {
1255                 // Then output admin message
1256                 $message = sprintf(getMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE'), $ext_name, $ext_name, $ext_ver);
1257         } // END - if
1258
1259         // Return prepared message
1260         return $message;
1261 }
1262
1263 // Generates a 'extension foo inactive' message
1264 function generateExtensionInactiveMessage ($ext_name) {
1265         // Is the extension empty?
1266         if (empty($ext_name)) {
1267                 // This should not happen
1268                 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1269         } // END - if
1270
1271         // Default message
1272         $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_INACTIVE', $ext_name);
1273
1274         // Is an admin logged in?
1275         if (isAdmin()) {
1276                 // Then output admin message
1277                 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE', $ext_name);
1278         } // END - if
1279
1280         // Return prepared message
1281         return $message;
1282 }
1283
1284 // Generates a 'extension foo not installed' message
1285 function generateExtensionNotInstalledMessage ($ext_name) {
1286         // Is the extension empty?
1287         if (empty($ext_name)) {
1288                 // This should not happen
1289                 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1290         } // END - if
1291
1292         // Default message
1293         $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
1294
1295         // Is an admin logged in?
1296         if (isAdmin()) {
1297                 // Then output admin message
1298                 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
1299         } // END - if
1300
1301         // Return prepared message
1302         return $message;
1303 }
1304
1305 // Generates a message depending on if the extension is not installed or not
1306 // just activated
1307 function generateExtensionInactiveNotInstalledMessage ($ext_name) {
1308         // Init message
1309         $message = '';
1310
1311         // Is the extension not installed or just deactivated?
1312         switch (isExtensionInstalled($ext_name)) {
1313                 case true; // Deactivated!
1314                         $message = generateExtensionInactiveMessage($ext_name);
1315                         break;
1316
1317                 case false; // Not installed!
1318                         $message = generateExtensionNotInstalledMessage($ext_name);
1319                         break;
1320
1321                 default: // Should not happen!
1322                         logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid state of extension %s detected.", $ext_name));
1323                         $message = sprintf("Invalid state of extension %s detected.", $ext_name);
1324                         break;
1325         } // END - switch
1326
1327         // Return the message
1328         return $message;
1329 }
1330
1331 // Print code with line numbers
1332 function linenumberCode ($code)    {
1333         if (!is_array($code)) $codeE = explode("\n", $code); else $codeE = $code;
1334         $count_lines = count($codeE);
1335
1336         $r = 'Line | Code:<br />';
1337         foreach ($codeE as $line => $c) {
1338                 $r .= '<div class="line"><span class="linenum">';
1339                 if ($count_lines == 1) {
1340                         $r .= 1;
1341                 } else {
1342                         $r .= ($line == ($count_lines - 1)) ? '' :  ($line+1);
1343                 }
1344                 $r .= '</span>|';
1345
1346                 // Add code
1347                 $r .= '<span class="linetext">' . encodeEntities($c) . '</span></div>';
1348         } // END - foreach
1349
1350         return '<div class="code">' . $r . '</div>';
1351 }
1352
1353 // Determines the right page title
1354 function determinePageTitle () {
1355         // Config and database connection valid?
1356         if ((isConfigLocalLoaded()) && (isConfigurationLoaded()) && (SQL_IS_LINK_UP()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1357                 // Init title
1358                 $TITLE = '';
1359
1360                 // Title decoration enabled?
1361                 if ((isTitleDecorationEnabled()) && (getConfig('title_left') != '')) $TITLE .= trim(getConfig('title_left')) . ' ';
1362
1363                 // Do we have some extra title?
1364                 if (isExtraTitleSet()) {
1365                         // Then prepent it
1366                         $TITLE .= getExtraTitle() . ' by ';
1367                 } // END - if
1368
1369                 // Add main title
1370                 $TITLE .= getMainTitle();
1371
1372                 // Add title of module? (middle decoration will also be added!)
1373                 if ((isModuleTitleEnabled()) || ((!isWhatSet()) && (!isActionSet())) || (getModule() == 'admin')) {
1374                         $TITLE .= ' ' . trim(getConfig('title_middle')) . ' {DQUOTE} . getModuleTitle(getModule()) . {DQUOTE}';
1375                 } // END - if
1376
1377                 // Add title from what file
1378                 $mode = '';
1379                 if (getModule() == 'login') $mode = 'member';
1380                 elseif (getModule() == 'index') $mode = 'guest';
1381                 if ((!empty($mode)) && (isWhatTitleEnabled())) $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu($mode, getWhat());
1382
1383                 // Add title decorations? (right)
1384                 if ((isTitleDecorationEnabled()) && (getConfig('title_right') != '')) $TITLE .= ' ' . trim(getConfig('title_right'));
1385
1386                 // Remember title in constant for the template
1387                 $pageTitle = $TITLE;
1388         } elseif ((isInstalled()) && (isAdminRegistered())) {
1389                 // Installed, admin registered but no ext-sql_patches
1390                 $pageTitle = '[-- ' . getMainTitle() . ' - ' . getModuleTitle(getModule()) . ' --]';
1391         } elseif ((isInstalled()) && (!isAdminRegistered())) {
1392                 // Installed but no admin registered
1393                 $pageTitle = '{--INSTALLER_OF_MAILER_NO_ADMIN--}';
1394         } elseif ((!isInstalled()) || (!isAdminRegistered())) {
1395                 // Installation mode
1396                 $pageTitle = '{--INSTALLER_OF_MAILER--}';
1397         } else {
1398                 // Configuration not found
1399                 $pageTitle = '{--NO_CONFIG_FOUND_TITLE--}';
1400
1401                 // Do not add the fatal message in installation mode
1402                 if ((!isInstalling()) && (!isConfigurationLoaded())) addFatalMessage(__FUNCTION__, __LINE__, '{--NO_CONFIG_FOUND--}');
1403         }
1404
1405         // Return title
1406         return decodeEntities($pageTitle);
1407 }
1408
1409 // Checks wethere there is a cache file there. This function is cached.
1410 function isTemplateCached ($template) {
1411         // Do we have cached this result?
1412         if (!isset($GLOBALS['template_cache'][$template])) {
1413                 // Generate FQFN
1414                 $FQFN = generateCacheFqfn($template);
1415
1416                 // Is it there?
1417                 $GLOBALS['template_cache'][$template] = isFileReadable($FQFN);
1418         } // END - if
1419
1420         // Return it
1421         return $GLOBALS['template_cache'][$template];
1422 }
1423
1424 // Flushes non-flushed template cache to disk
1425 function flushTemplateCache ($template, $eval) {
1426         // Is this cache flushed?
1427         if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template) === false) && ($eval != '404')) {
1428                 // Generate FQFN
1429                 $FQFN = generateCacheFqfn($template);
1430
1431                 // And flush it
1432                 writeToFile($FQFN, $eval, true);
1433         } // END - if
1434 }
1435
1436 // Reads a template cache
1437 function readTemplateCache ($template) {
1438         // Check it again
1439         if ((isDebuggingTemplateCache()) || (!isTemplateCached($template))) {
1440                 // This should not happen
1441                 debug_report_bug('Wether debugging of template cache is enabled or template ' . $template . ' is not cached while expected.');
1442         } // END - if
1443
1444         // Is it cached?
1445         if (!isset($GLOBALS['template_eval'][$template])) {
1446                 // Generate FQFN
1447                 $FQFN = generateCacheFqfn($template);
1448
1449                 // And read from it
1450                 $GLOBALS['template_eval'][$template] = readFromFile($FQFN);
1451         } // END - if
1452
1453         // And return it
1454         return $GLOBALS['template_eval'][$template];
1455 }
1456
1457 // Escapes quotes (default is only double-quotes)
1458 function escapeQuotes ($str, $single = false) {
1459         // Should we escape all?
1460         if ($single === true) {
1461                 // Escape all (including null)
1462                 $str = addslashes($str);
1463         } else {
1464                 // Remove escaping of single quotes
1465                 $str = str_replace("\'", "'", $str);
1466
1467                 // Escape only double-quotes but prevent double-quoting
1468                 $str = str_replace("\\\\", "\\", str_replace('"', "\\\"", $str));
1469         }
1470
1471         // Return the escaped string
1472         return $str;
1473 }
1474
1475 // Escapes the JavaScript code, prevents \r and \n becoming char 10/13
1476 function escapeJavaScriptQuotes ($str) {
1477         // Replace all double-quotes and secure back-ticks
1478         $str = str_replace('"', '\"', str_replace("\\", '{BACK}', $str));
1479
1480         // Return it
1481         return $str;
1482 }
1483
1484 // Send out mails depending on the 'mod/modes' combination
1485 // @TODO Lame description for this function
1486 function sendModeMails ($mod, $modes) {
1487         // Init user data
1488         $content = array ();
1489
1490         // Load hash
1491         if (fetchUserData(getMemberId())) {
1492                 // Extract salt from cookie
1493                 $salt = substr(getSession('u_hash'), 0, -40);
1494
1495                 // Now let's compare passwords
1496                 $hash = encodeHashForCookie(getUserData('password'));
1497
1498                 // Does the hash match or should we change it?
1499                 if (($hash == getSession('u_hash')) || (postRequestParameter('pass1') == postRequestParameter('pass2'))) {
1500                         // Load the data
1501                         $content = getUserDataArray();
1502
1503                         // Clear/init the content variable
1504                         $content['message'] = '';
1505
1506                         // Which mail?
1507                         // @TODO Move this in a filter
1508                         switch ($mod) {
1509                                 case 'mydata':
1510                                         foreach ($modes as $mode) {
1511                                                 switch ($mode) {
1512                                                         case 'normal': break; // Do not add any special lines
1513                                                         case 'email': // Email was changed!
1514                                                                 $content['message'] = '{--MEMBER_CHANGED_EMAIL--}' . ': ' . postRequestParameter('old_email') . "\n";
1515                                                                 break;
1516
1517                                                         case 'password': // Password was changed
1518                                                                 $content['message'] = '{--MEMBER_CHANGED_PASS--}' . "\n";
1519                                                                 break;
1520
1521                                                         default:
1522                                                                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown mode %s detected.", $mode));
1523                                                                 $content['message'] = '{--MEMBER_UNKNOWN_MODE--}' . ': ' . $mode . "\n\n";
1524                                                                 break;
1525                                                 } // END - switch
1526                                         } // END - foreach
1527
1528                                         if (isExtensionActive('country')) {
1529                                                 // Replace code with description
1530                                                 $content['country'] = generateCountryInfo(postRequestParameter('country_code'));
1531                                         } // END - if
1532
1533                                         // Merge content with data from POST
1534                                         $content = merge_array($content, postRequestArray());
1535
1536                                         // Load template
1537                                         $message = loadEmailTemplate('member_mydata_notify', $content, getMemberId());
1538
1539                                         if (isAdminNotificationEnabled()) {
1540                                                 // The admin needs to be notified about a profile change
1541                                                 $message_admin = 'admin_mydata_notify';
1542                                                 $sub_adm   = '{--ADMIN_CHANGED_DATA--}';
1543                                         } else {
1544                                                 // No mail to admin
1545                                                 $message_admin = '';
1546                                                 $sub_adm   = '';
1547                                         }
1548
1549                                         // Set subject lines
1550                                         $sub_mem = '{--MEMBER_CHANGED_DATA--}';
1551
1552                                         // Output success message
1553                                         $content['message'] = '<span class="message">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1554                                         break;
1555
1556                                 default: // Unsupported module!
1557                                         logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unsupported module %s detected.", $mod));
1558                                         $content['message'] = '<span class="notice">{--UNKNOWN_MODULE--}</span>';
1559                                         break;
1560                         } // END - switch
1561                 } else {
1562                         // Passwords mismatch
1563                         $content['message'] = '<span class="notice">{--MEMBER_PASSWORD_ERROR--}</span>';
1564                 }
1565         } else {
1566                 // Could not load profile
1567                 $content['message'] = '<span class="notice">{--MEMBER_CANNOT_LOAD_PROFILE--}</span>';
1568         }
1569
1570         // Send email to user if required
1571         if ((!empty($sub_mem)) && (!empty($message)) && (!empty($content['email']))) {
1572                 // Send member mail
1573                 sendEmail($content['email'], $sub_mem, $message);
1574         } // END - if
1575
1576         // Send only if no other error has occured
1577         if ((!empty($sub_adm)) && (!empty($message_admin)) && (isAdminNotificationEnabled())) {
1578                 // Send admin mail
1579                 sendAdminNotification($sub_adm, $message_admin, $content, getMemberId());
1580         } elseif (isAdminNotificationEnabled()) {
1581                 // Cannot send mails to admin!
1582                 $content['message'] = '{--CANNOT_SEND_ADMIN_MAILS--}';
1583         } else {
1584                 // No mail to admin
1585                 $content['message'] = '<span class="message">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1586         }
1587
1588         // Load template
1589         loadTemplate('admin_settings_saved', false, $content['message']);
1590 }
1591
1592 // Generates a 'selection box' from given array
1593 function generateSelectionBoxFromArray ($options, $name, $optionValue, $optionContent = '', $extraName = '') {
1594         // Start the output
1595         $OUT = '<select name="' . $name . '" size="1" class="form_select">
1596 <option value="X" disabled="disabled">{--PLEASE_SELECT--}</option>';
1597
1598         // Walk through all options
1599         foreach ($options as $option) {
1600                 // Add the <option> entry from ...
1601                 if (empty($optionContent)) {
1602                         // ... template
1603                         $OUT .= loadTemplate('select_' . $name . $extraName . '_option', true, $option);
1604                 } else {
1605                         // ... direct HTML code
1606                         $OUT .= '<option value="' . $option[$optionValue] . '">' . $option[$optionContent] . '</option>';
1607                 }
1608         } // END - foreach
1609
1610         // Finish selection box
1611         $OUT .= '</select>';
1612
1613         // Prepare output
1614         $content = array(
1615                 'selection_box' => $OUT,
1616         );
1617
1618         // Load template and return it
1619         return loadTemplate('select_' . $name . $extraName . '_box', true, $content);
1620 }
1621
1622 // Prepares the header for HTML output
1623 function loadHtmlHeader () {
1624         // Run two filters:
1625         // 1.) pre_page_header (mainly loads the page_header template and includes
1626         //     meta description)
1627         runFilterChain('pre_page_header');
1628
1629         // Here can be something be added, but normally one of the two filters
1630         // around this line should do the job for you.
1631
1632         // 2.) post_page_header (mainly to load stylesheet, extra JavaScripts and
1633         //     to close the head-tag)
1634         // Include more header data here
1635         runFilterChain('post_page_header');
1636 }
1637
1638 // Adds page header and footer to output array element
1639 function addPageHeaderFooter () {
1640         // Init output
1641         $OUT = '';
1642
1643         // Add them all together. This is maybe to simple
1644         foreach (array('page_header', 'output', 'page_footer') as $pagePart) {
1645                 // Add page part if set
1646                 if (isset($GLOBALS[$pagePart])) $OUT .= $GLOBALS[$pagePart];
1647         } // END - foreach
1648
1649         // Transfer $OUT to 'output'
1650         $GLOBALS['output'] = $OUT;
1651 }
1652
1653 // Generates meta description for current module and 'what' value
1654 function generateMetaDescriptionCode () {
1655         // Only include from guest area and if sql_patches has correct version
1656         if ((getModule() == 'index') && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1657                 // Construct dynamic description
1658                 $DESCR = '{?MAIN_TITLE?} ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu('guest', getWhat());
1659
1660                 // Output it directly
1661                 $GLOBALS['page_header'] .= '<meta name="description" content="' . $DESCR . '" />';
1662         } // END - if
1663
1664         // Remove depth
1665         unset($GLOBALS['ref_level']);
1666 }
1667
1668 // Generates an FQFN for template cache from the given template name
1669 function generateCacheFqfn ($template, $mode = 'html') {
1670         // Is this cached?
1671         if (!isset($GLOBALS['template_cache_fqfn'][$template])) {
1672                 // Generate the FQFN
1673                 $GLOBALS['template_cache_fqfn'][$template] = sprintf(
1674                         "%s_compiled/%s/%s.tpl.cache",
1675                         getCachePath(),
1676                         $mode,
1677                         $template
1678                 );
1679         } // END - if
1680
1681         // Return it
1682         return $GLOBALS['template_cache_fqfn'][$template];
1683 }
1684
1685 // "Fixes" null or empty string to count of dashes
1686 function fixNullEmptyToDashes ($str, $num) {
1687         // Use str as default
1688         $return = $str;
1689
1690         // Is it empty?
1691         if ((is_null($str)) || (trim($str) == '')) {
1692                 // Set it
1693                 $return = str_repeat('-', $num);
1694         } // END - if
1695
1696         // Return final string
1697         return $return;
1698 }
1699
1700 // Translates the "pool type" into human-readable
1701 function translatePoolType ($type) {
1702         // Return "translation"
1703         return sprintf("{--POOL_TYPE_%s--}", strtoupper($type));
1704 }
1705
1706 //-----------------------------------------------------------------------------
1707 //                      Template helper functions for EL
1708 //-----------------------------------------------------------------------------
1709
1710 // Color-switch helper function
1711 function doTemplateColorSwitch ($template, $clear = false, $return = true) {
1712         // Is it there?
1713         if (!isset($GLOBALS['color_switch'][$template])) {
1714                 // Initialize it
1715                 initTemplateColorSwitch($template);
1716         } elseif ($clear === false) {
1717                 // Switch color if called from loadTemplate()
1718                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SWITCH:' . $template);
1719                 $GLOBALS['color_switch'][$template] = 3 - $GLOBALS['color_switch'][$template];
1720         }
1721
1722         // Return CSS class name
1723         if ($return === true) {
1724                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'RETURN:' . $template . '=' . $GLOBALS['color_switch'][$template]);
1725                 return 'switch_sw' . $GLOBALS['color_switch'][$template];
1726         } // END - if
1727 }
1728
1729 // Helper function for extension registration link
1730 function doTemplateExtensionRegistrationLink ($template, $dummy, $ext_name) {
1731         // Default is all non-productive
1732         $OUT = '<em style="cursor:help" class="notice" title="{%message,ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK_TITLE=' . $ext_name . '%}">{--ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK--}</em>';
1733
1734         // Is the given extension non-productive?
1735         if (isExtensionProductive($ext_name)) {
1736                 // Productive code
1737                 $OUT = '<a title="{--ADMIN_REGISTER_EXTENSION_TITLE--}" href="{%url=modules.php?module=admin&amp;what=extensions&amp;reg_ext=' . $ext_name . '%}">{--ADMIN_REGISTER_EXTENSION--}</a>';
1738         } // END - if
1739
1740         // Return code
1741         return $OUT;
1742 }
1743
1744 // Helper function to create bonus mail admin links
1745 function doTemplateAdminBonusMailLinks ($template, $bonusId) {
1746         // Call the inner function
1747         return generateAdminMailLinks('bid', $bonusId);
1748 }
1749
1750 // Helper function to create member mail admin links
1751 function doTemplateAdminMemberMailLinks ($template, $mailId) {
1752         // Call the inner function
1753         return generateAdminMailLinks('mid', $mailId);
1754 }
1755
1756 // [EOF]
1757 ?>