Caching of XML/email templates finished:
[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 - 2012 by Mailer Developer Team                   *
20  * For more information visit: http://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 whether 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         // Call inner function
74         $str = fixNullEmptyToDashes($str, 3);
75
76         // Return string
77         return $str;
78 }
79
80 // Init color switch
81 function initTemplateColorSwitch ($template) {
82         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'INIT:' . $template);
83         $GLOBALS['color_switch'][$template] = 2;
84 }
85
86 // "Getter" for color switch code
87 function getColorSwitchCode ($template) {
88         // Prepare the code
89         $code = "{DQUOTE} . doTemplateColorSwitch('" . $template . "', false, false) . {DQUOTE}";
90
91         // And return it
92         return $code;
93 }
94
95 // Output HTML code directly or 'render' it. You addionally switch the new-line character off
96 function outputHtml ($htmlCode, $newLine = true) {
97         // Init output
98         if (!isset($GLOBALS['__output'])) {
99                 $GLOBALS['__output'] = '';
100         } // END - if
101
102         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getOutputMode()=' . getOutputMode() . ',htmlCode(length)=' . strlen($htmlCode) . ',output(length)=' . strlen($GLOBALS['__output']));
103         // Is there HTML-Code here?
104         if (!empty($htmlCode)) {
105                 // Yes, so we handle it as you have configured
106                 switch (getOutputMode()) {
107                         case 'render':
108                                 // But if PHP is caching, then we don't need to do that
109                                 if (getPhpCaching() == 'on') {
110                                         // Output into PHP's internal buffer
111                                         outputRawCode($htmlCode);
112
113                                         // That's why you don't need any \n at the end of your HTML code... :-)
114                                         if ($newLine === true) {
115                                                 outputRawCode(chr(10));
116                                         } // END - if
117                                 } else {
118                                         // Render mode for old or lame servers...
119                                         $GLOBALS['__output'] .= $htmlCode;
120
121                                         // That's why you don't need any \n at the end of your HTML code... :-)
122                                         if ($newLine === true) {
123                                                 $GLOBALS['__output'] .= chr(10);
124                                         } // END - if
125                                 }
126                                 break;
127
128                         case 'direct':
129                                 // If we are switching from 'render' to 'direct' mode, all data in '__output' must be flushed and cleared
130                                 if ((!empty($GLOBALS['__output'])) && (getPhpCaching() != 'on')) {
131                                         outputRawCode($GLOBALS['__output']);
132                                         $GLOBALS['__output'] = '';
133                                 } // END - if
134
135                                 // The same as above... ^
136                                 outputRawCode($htmlCode);
137                                 if ($newLine === true) {
138                                         outputRawCode(chr(10));
139                                 } // END - if
140                                 break;
141
142                         default:
143                                 // Huh, something goes wrong or maybe you have edited config.php ???
144                                 reportBug(__FUNCTION__, __LINE__, '<strong>{--FATAL_ERROR--}:</strong> {--NO_RENDER_DIRECT--}');
145                                 break;
146                 } // END - switch
147         } elseif ((getPhpCaching() == 'on') && ((!isset($GLOBALS['http_header'])) || (count($GLOBALS['http_header']) == 0)) && (!isRawOutputMode())) {
148                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getPhpCaching()=' . getPhpCaching() . ',isset(http_header)=' . intval(isset($GLOBALS['http_header'])) . ',getScriptOutputMode()=' . getScriptOutputMode() . '');
149                 // Output cached HTML code
150                 $GLOBALS['__output'] = ob_get_contents();
151
152                 // Clear output buffer for later output if output is found
153                 if (!empty($GLOBALS['__output'])) {
154                         clearOutputBuffer();
155                 } // END - if
156
157                 // Send all HTTP headers
158                 sendHttpHeaders();
159
160                 // Compile and run finished rendered HTML code
161                 compileFinalOutput();
162
163                 // Output code here, DO NOT REMOVE! ;-)
164                 outputRawCode($GLOBALS['__output']);
165         } elseif ((getOutputMode() == 'render') && (!empty($GLOBALS['__output'])) && (!isRawOutputMode())) {
166                 // Send all HTTP headers
167                 sendHttpHeaders();
168
169                 // Compile and run finished rendered HTML code
170                 compileFinalOutput();
171
172                 // Output code here, DO NOT REMOVE! ;-)
173                 outputRawCode($GLOBALS['__output']);
174         } else {
175                 // And flush all headers
176                 flushHttpHeaders();
177         }
178 }
179
180 // Compiles the final output
181 function compileFinalOutput () {
182         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '__output(length)=' . strlen($GLOBALS['__output']) . ',getScriptOutputMode()=' . getScriptOutputMode() . ' - ENTERED!');
183         // Add page header and footer
184         addPageHeaderFooter();
185         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '__output(length)=' . strlen($GLOBALS['__output']) . ' - After addPageHeaderFooter() call.');
186
187         // Do the final compilation
188         $GLOBALS['__output'] = compileUriCode(doFinalCompilation($GLOBALS['__output']));
189
190         // Extension 'rewrite' installed?
191         if ((isExtensionActive('rewrite')) && (!isCssOutputMode())) {
192                 $GLOBALS['__output'] = rewriteLinksInCode($GLOBALS['__output']);
193         } // END - if
194
195         // Compress it?
196         /**
197          * @TODO On some pages this is buggy
198         if (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (isInStringIgnoreCase('gzip', $_SERVER['HTTP_ACCEPT_ENCODING']))) {
199                 // Compress it for HTTP gzip
200                 $GLOBALS['__output'] = gzencode($GLOBALS['__output'], 9);
201
202                 // Add header
203                 addHttpHeader('Content-Encoding: gzip');
204         } elseif (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (isInStringIgnoreCase('deflate', $_SERVER['HTTP_ACCEPT_ENCODING']))) {
205                 // Compress it for HTTP deflate
206                 $GLOBALS['__output'] = gzcompress($GLOBALS['__output'], 9);
207
208                 // Add header
209                 addHttpHeader('Content-Encoding: deflate');
210         }
211         */
212
213         // Add final length
214         addHttpHeader('Content-Length: ' . strlen($GLOBALS['__output']));
215
216         // Flush all headers
217         flushHttpHeaders();
218 }
219
220 // Main compilation loop
221 function doFinalCompilation ($code, $insertComments = true, $enableCodes = true) {
222         // Insert comments? (Only valid with HTML templates, of course)
223         enableTemplateHtml($insertComments);
224
225         // Init counter
226         $count = 0;
227
228         // Compile all out
229         while (((isInString('{--', $code)) || (isInString('{DQUOTE}', $code)) || (isInString('{?', $code)) || (isInString('{%', $code) !== false)) && ($count < 7)) {
230                 // Init common variables
231                 $content = array();
232                 $newContent = '';
233
234                 // Compile it
235                 //* DEBUG: */ debugOutput('<pre>'.linenumberCode($code).'</pre>');
236                 $eval = '$newContent = "' . str_replace('{DQUOTE}', '"', compileCode(escapeQuotes($code), false, true, $enableCodes)) . '";';
237                 //* DEBUG: */ if (!$insertComments) print('EVAL=<pre>'.linenumberCode($eval).'</pre>');
238                 eval($eval);
239                 //* DEBUG: */ if (!$insertComments) print('NEW=<pre>'.linenumberCode($newContent).'</pre>');
240                 //* DEBUG: */ die('<pre>'.encodeEntities($newContent).'</pre>');
241
242                 // Was that eval okay?
243                 if (empty($newContent)) {
244                         // Something went wrong!
245                         reportBug(__FUNCTION__, __LINE__, 'Evaluation error:<pre>' . linenumberCode($eval) . '</pre>', false);
246                 } // END - if
247
248                 // Use it again
249                 $code = $newContent;
250
251                 // Compile the final code if insertComments is true
252                 if ($insertComments == true) {
253                         // ... because SQL queries shall keep OPEN_CONFIG and such in
254                         $code = compileRawCode($code);
255                 } // END - if
256
257                 // Count round
258                 $count++;
259         } // END - while
260
261         // Add debugging data in HTML code, if mode is enabled
262         if ((isDebugModeEnabled()) && ($insertComments === true) && ((isHtmlOutputMode()) || (isCssOutputMode()))) {
263                 // Add loop count
264                 $code .= '<!-- Total compilation loop=' . $count . ' //-->';
265         } // END - if
266
267         // Return the compiled code
268         return $code;
269 }
270
271 // Output the raw HTML code
272 function outputRawCode ($htmlCode) {
273         // Output stripped HTML code to avoid broken JavaScript code, etc.
274         print(str_replace('{BACK}', chr(92), $htmlCode));
275
276         // Flush the output if only getPhpCaching() is not 'on'
277         if (getPhpCaching() != 'on') {
278                 // Flush it
279                 flush();
280         } // END - if
281 }
282
283 // Load a template file and return it's content (only it's name; do not use ' or ")
284 function loadTemplate ($template, $return = false, $content = array(), $compileCode = true) {
285         // @TODO Remove these sanity checks if all is fine
286         if (!is_bool($return)) {
287                 // $return has to be boolean
288                 reportBug(__FUNCTION__, __LINE__, 'return[] is not bool (' . gettype($return) . ')');
289         } elseif (!is_string($template)) {
290                 // $template has to be string
291                 reportBug(__FUNCTION__, __LINE__, 'template[] is not string (' . gettype($template) . ')');
292         }
293
294         // Init returned content
295         $ret = '';
296
297         // Set current template
298         $GLOBALS['current_template'] = $template;
299
300         // Is there cache?
301         if ((!isDebuggingTemplateCache()) && (isTemplateCached('html', $template))) {
302                 // Evaluate the cache
303                 eval(readTemplateCache('html', $template));
304         } elseif (!isset($GLOBALS['template_eval']['html'][$template])) {
305                 // Make all template names lowercase
306                 $template = strtolower($template);
307
308                 // Base directory
309                 $basePath = sprintf("%stemplates/%s/html/", getPath(), getLanguage());
310                 $extraPath = detectExtraTemplatePath('html', $template);
311
312                 // Generate FQFN
313                 $FQFN = $basePath . $extraPath . $template . '.tpl';
314                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Template ' . $template . ' is solved to FQFN=' . $FQFN);
315
316                 // Does the special template exists?
317                 if (!isFileReadable($FQFN)) {
318                         // Reset to default template
319                         $FQFN = $basePath . $template . '.tpl';
320                 } // END - if
321
322                 // Now does the final template exists?
323                 if (isFileReadable($FQFN)) {
324                         // Count the template load
325                         incrementConfigEntry('num_templates');
326
327                         // The local file does exists so we load it. :)
328                         $GLOBALS['template_content']['html'][$template] = readFromFile($FQFN);
329
330                         // Is there to compile the code?
331                         if ((isInString('$', $GLOBALS['template_content']['html'][$template])) || (isInString('{--', $GLOBALS['template_content']['html'][$template])) || (isInString('{?', $GLOBALS['template_content']['html'][$template])) || (isInString('{%', $GLOBALS['template_content']['html'][$template]))) {
332                                 // Normal HTML output?
333                                 if ((isHtmlOutputMode()) && (substr($template, 0, 3) != 'js_')) {
334                                         // Add surrounding HTML comments to help finding bugs faster
335                                         $code = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['template_content']['html'][$template] . '<!-- Template ' . $template . ' - End //-->';
336
337                                         // Prepare eval() command
338                                         $GLOBALS['template_eval']['html'][$template] = '$ret = "' . getColorSwitchCode($template) . compileCode(escapeQuotes($code), false, true, true, $compileCode) . '";';
339                                 } elseif (substr($template, 0, 3) == 'js_') {
340                                         // JavaScripts don't like entities, dollar signs and timings
341                                         $GLOBALS['template_eval']['html'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['template_content']['html'][$template]), false, true, true, $compileCode) . '");';
342                                 } else {
343                                         // Prepare eval() command, other output doesn't like entities, maybe
344                                         $GLOBALS['template_eval']['html'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['template_content']['html'][$template]), false, true, true, $compileCode) . '");';
345                                 }
346                         } elseif (isHtmlOutputMode()) {
347                                 // Add surrounding HTML comments to help finding bugs faster
348                                 $ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['template_content']['html'][$template] . '<!-- Template ' . $template . ' - End //-->';
349                                 $GLOBALS['template_eval']['html'][$template] = '$ret = "' . getColorSwitchCode($template) . compileRawCode(escapeQuotes($ret), false, true, true, $compileCode) . '";';
350                         } else {
351                                 // JavaScript again
352                                 $GLOBALS['template_eval']['html'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['template_content']['html'][$template]), false, true, true, $compileCode) . '");';
353                         } // END - if
354                 } elseif ((isAdmin()) || ((isInstalling()) && (!isInstalled()))) {
355                         // Only admins shall see this warning or when installation mode is active
356                         $ret = '<div class="para">
357         {--TEMPLATE_404--}
358 </div>
359 <div class="para">
360         (' . $template . ')
361 </div>
362 <div class="para">
363         {--TEMPLATE_CONTENT--}:
364         <pre>' . print_r($content, true) . '</pre>
365 </div>';
366                 } else {
367                         // No file!
368                         $GLOBALS['template_eval']['html'][$template] = '404';
369                 }
370         }
371
372         // Code set?
373         if ((isset($GLOBALS['template_eval']['html'][$template])) && ($GLOBALS['template_eval']['html'][$template] != '404')) {
374                 // Eval the code
375                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'template=' . $template . ' - BEFORE EVAL');
376                 ///* DEBUG: */ print('<pre>'.htmlentities($GLOBALS['template_eval']['html'][$template]).'</pre>');
377                 eval($GLOBALS['template_eval']['html'][$template]);
378                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'template=' . $template . ' - AFTER EVAL');
379         } // END - if
380
381         // Is there some content to output or return?
382         if (!empty($ret)) {
383                 // Not empty so let's put it out! ;)
384                 if ($return === true) {
385                         // Return the HTML code
386                         return $ret;
387                 } else {
388                         // Output directly
389                         outputHtml($ret);
390                 }
391         } elseif (isDebugModeEnabled()) {
392                 // Warning, empty output!
393                 return 'E:' . $template . ',content=<pre>' . print_r($content, true) . '</pre>';
394         }
395 }
396
397 // Detects the extra template path from given template name
398 function detectExtraTemplatePath ($prefix, $template) {
399         // Default is empty
400         $extraPath = '';
401
402         // Is there cache?
403         if (!isset($GLOBALS['extra_path'][$prefix][$template])) {
404                 // Check for admin/guest/member/etc. templates
405                 if (substr($template, 0, 6) == 'admin_') {
406                         // Admin template found
407                         $extraPath = 'admin/';
408                 } elseif (substr($template, 0, 6) == 'guest_') {
409                         // Guest template found
410                         $extraPath = 'guest/';
411                 } elseif (substr($template, 0, 7) == 'member_') {
412                         // Member template found
413                         $extraPath = 'member/';
414                 } elseif (substr($template, 0, 7) == 'select_') {
415                         // Selection template found
416                         $extraPath = 'select/';
417                 } elseif (substr($template, 0, 8) == 'install_') {
418                         // Installation template found
419                         $extraPath = 'install/';
420                 } elseif (substr($template, 0, 4) == 'ext_') {
421                         // Extension template found
422                         $extraPath = 'ext/';
423                 } elseif (substr($template, 0, 3) == 'la_') {
424                         // 'Logical-area' template found
425                         $extraPath = 'la/';
426                 } elseif (substr($template, 0, 3) == 'js_') {
427                         // JavaScript template found
428                         $extraPath = 'js/';
429                 } elseif (substr($template, 0, 5) == 'menu_') {
430                         // Menu template found
431                         $extraPath = 'menu/';
432                 } else {
433                         // Test for extension
434                         $test = substr($template, 0, strpos($template, '_'));
435
436                         // Probe for valid extension name
437                         if (isExtensionNameValid($test)) {
438                                 // Set extra path to extension's name
439                                 $extraPath = $test . '/';
440                         } // END - if
441                 }
442
443                 // Store it in cache
444                 $GLOBALS['extra_path'][$prefix][$template] = $extraPath;
445         } // END - if
446
447         // Return result
448         return $GLOBALS['extra_path'][$prefix][$template];
449 }
450
451 // Loads an email template and compiles it
452 function loadEmailTemplate ($template, $content = array(), $userid = NULL, $loadUserData = true) {
453         // Make sure all template names are lowercase!
454         $template = strtolower($template);
455
456         // Set current template
457         $GLOBALS['current_template'] = $template;
458
459         // Is content an array?
460         if (is_array($content)) {
461                 // Add expiration to array
462                 if ((isConfigEntrySet('auto_purge')) && (getAutoPurge() == '0')) {
463                         // Will never expire!
464                         $content['expiration'] = '{--MAIL_WILL_NEVER_EXPIRE--}';
465                 } elseif (isConfigEntrySet('auto_purge')) {
466                         // Create nice date string
467                         $content['expiration'] = '{%config,createFancyTime=auto_purge%}';
468                 } else {
469                         // Missing entry
470                         $content['expiration'] = '{--MAIL_NO_CONFIG_AUTO_PURGE--}';
471                 }
472         } // END - if
473
474         // Is there cache?
475         if ((!isDebuggingTemplateCache()) && (isTemplateCached('email', $template))) {
476                 // Evaluate the cache
477                 eval(readTemplateCache('email', $template));
478         } elseif (!isset($GLOBALS['template_eval']['email'][$template])) {
479                 // Base directory
480                 $basePath = sprintf("%stemplates/%s/emails/", getPath(), getLanguage());
481
482                 // Detect extra path
483                 $extraPath = detectExtraTemplatePath('email', $template);
484
485                 // Generate full FQFN
486                 $FQFN = $basePath . $extraPath . $template . '.tpl';
487
488                 // Does the special template exists?
489                 if (!isFileReadable($FQFN)) {
490                         // Reset to default template
491                         $FQFN = $basePath . $template . '.tpl';
492                 } // END - if
493
494                 // Now does the final template exists?
495                 $newContent = '';
496                 if (isFileReadable($FQFN)) {
497                         // The local file does exists so we load it. :)
498                         $GLOBALS['template_content']['email'][$template] = readFromFile($FQFN);
499
500                         // Run code
501                         $GLOBALS['template_eval']['email'][$template] = '$newContent = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['template_content']['email'][$template])) . '");';
502                 } elseif (!empty($template)) {
503                         // Template file not found
504                         $newContent = '<div class="para">
505         {--TEMPLATE_404--}: ' . $template . '
506 </div>
507 <div class="para">
508         {--TEMPLATE_CONTENT--}:
509         <pre>' . print_r($content, true) . '</pre>
510 </div>';
511
512                         // Don't cache this, as there is no template to cache
513                         $GLOBALS['template_eval']['email'][$template] = '404';
514
515                         // Debug mode not active? Then remove the HTML tags
516                         if (!isDebugModeEnabled()) {
517                                 // Remove HTML tags
518                                 $newContent = secureString($newContent);
519                         } // END - if
520                 } else {
521                         // No template name supplied!
522                         $newContent = '{--NO_TEMPLATE_SUPPLIED--}';
523                         $GLOBALS['template_eval']['email'][$template] = '404';
524                 }
525         }
526
527         // Is there something to eval?
528         if ((isset($GLOBALS['template_eval']['email'][$template])) && ($GLOBALS['template_eval']['email'][$template] != '404')) {
529                 // Eval the code
530                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'template=' . $template . ' - BEFORE EVAL');
531                 ///* DEBUG: */ print('<pre>'.htmlentities($GLOBALS['template_eval']['email'][$template]).'</pre>');
532                 eval($GLOBALS['template_eval']['email'][$template]);
533                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'template=' . $template . ' - AFTER EVAL');
534         } // END - if
535
536         // Are there some content?
537         if (empty($newContent)) {
538                 // Compiling failed
539                 $newContent = "Compiler error for template " . $template . " !\nUncompiled content:\n" . $GLOBALS['template_content']['email'][$template];
540
541                 // Add last error if the required function exists
542                 if (function_exists('error_get_last')) {
543                         // Add last error and some lines for better overview
544                         $newContent .= "\n--------------------------------------\nDebug:\n" . print_r(error_get_last(), true) . "--------------------------------------\nPlease don't alter these informations!\nThanx.";
545                 } // END - if
546         } // END - if
547
548         // Remove content and data
549         unset($content);
550
551         // Return content
552         return $newContent;
553 }
554
555 // "Getter" for menu CSS classes, mainly used in templates
556 function getMenuCssClasses ($data) {
557         //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'data=' . $data);
558
559         // Is there cache?
560         if (!isset($GLOBALS[__FUNCTION__][$data])) {
561                 // $data needs to be converted into an array
562                 $content = explode('|', $data);
563
564                 // Non-existent index 2 will happen in menu blocks
565                 if (!isset($content[2])) {
566                         $content[2] = '';
567                 } // END - if
568
569                 // Re-construct the array: 0=visible,1=locked,2=prefix
570                 $content['visible'] = $content[0];
571                 $content['locked']  = $content[1];
572
573                 // Call our "translator" function
574                 $content = translateMenuVisibleLocked($content, $content[2]);
575
576                 // Set it in cache
577                 $GLOBALS[__FUNCTION__][$data] = ($content['visible_css'] . ' ' . $content['locked_css']);
578         } // END - if
579
580         // Return cache
581         return $GLOBALS[__FUNCTION__][$data];
582 }
583
584 // Generate XHTML code for the CAPTCHA
585 function generateCaptchaCode ($code, $type, $urlId, $userid) {
586         return '<img border="0" alt="Code ' . $code . '" src="{%url=mailid_top.php?userid=' . $userid . '&amp;' . $type . '=' . $urlId . '&amp;do=img&amp;code=' . $code . '%}" />';
587 }
588
589 // Compiles the given HTML/mail code
590 function compileCode ($code, $simple = false, $constants = true, $full = true, $compileCode = true) {
591         // Is the code a string or should we not compile?
592         if ((!is_string($code)) || ($compileCode === false)) {
593                 // Silently return it
594                 return $code;
595         } // END - if
596
597         // Start couting
598         $startCompile = microtime(true);
599
600         // Comile the code
601         $code = compileRawCode($code, $simple, $constants, $full);
602
603         // Get timing
604         $compilationTime = $startCompile - microtime(true);
605
606         // Add timing if enabled
607         if (isTemplateHtml()) {
608                 // Add timing, this should be disabled in
609                 $code .= '<!-- Compilation time: ' . ($compilationTime * 1000). 'ms //-->';
610         } // END - if
611
612         // Return compiled code
613         return $code;
614 }
615
616 // Compiles the code
617 // @TODO $simple/$constants are deprecated
618 function compileRawCode ($code, $simple = false, $constants = true, $full = true, $compileCode = true) {
619         // Is the code a string or shall we not compile?
620         if ((!is_string($code)) || ($compileCode === false)) {
621                 // Silently return it
622                 return $code;
623         } // END - if
624
625         // Init replacement-array with smaller set of security characters
626         $secChars = $GLOBALS['url_chars'];
627
628         // Select full set of chars to replace when we e.g. want to compile URLs
629         if ($full === true) {
630                 $secChars = $GLOBALS['security_chars'];
631         } // END - if
632
633         // Compile more through a filter
634         $code = runFilterChain('compile_code', $code);
635
636         // First compile these chars
637         array_unshift($secChars['to']  , '{--'       , '--}');
638         array_unshift($secChars['from'], '{%message,', '%}' );
639
640         // Compile QUOT and other non-HTML codes
641         $code = str_replace($secChars['to'], $secChars['from'], $code);
642
643         // Find $content[bla][blub] entries
644         preg_match_all('/\$content((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
645         //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Second regex gave ' . count($matches[0]) . ' matches.');
646
647         // Are some matches found?
648         if ((count($matches) > 0) && (count($matches[0]) > 0)) {
649                 // Replace all matches
650                 $matchesFound = array();
651                 foreach ($matches[0] as $key => $match) {
652                         // Fuzzy look has failed by default
653                         $fuzzyFound = false;
654
655                         // Fuzzy look on match if already found
656                         foreach ($matchesFound as $found => $set) {
657                                 // Get test part
658                                 $test = substr($found, 0, strlen($match));
659
660                                 // Does this entry exist?
661                                 //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'found=' . $found . ',match=' . $match . ',set=' . $set);
662                                 if ($test == $match) {
663                                         // Match found
664                                         //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'fuzzyFound!');
665                                         $fuzzyFound = true;
666                                         break;
667                                 } // END - if
668                         } // END - foreach
669
670                         // Skip this entry?
671                         if ($fuzzyFound === true) {
672                                 continue;
673                         } // END - if
674
675                         // Take all string elements
676                         if ((is_string($matches[3][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key.'_' . $matches[3][$key]]))) {
677                                 // Replace it in the code, replace dollar sign so it won't be detected by next regex (see there)
678                                 //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key . ',match=' . $match);
679                                 $newMatch = str_replace(array('[', ']', '$'), array("['", "']", '{COMPILE_DOLLAR}'), $match);
680                                 $code = str_replace($match, '".' . $newMatch . '."', $code);
681                                 $matchesFound[$key . '_' . $matches[3][$key]] = 1;
682                                 $matchesFound[$match] = true;
683                         } elseif (!isset($matchesFound[$match])) {
684                                 // Not yet replaced!
685                                 //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'match=' . $match);
686                                 $code = str_replace($match, '".' . $match . '."', $code);
687                                 $matchesFound[$match] = 1;
688                         } else {
689                                 // Everthing else should be a least logged
690                                 logDebugMessage(__FUNCTION__, __LINE__, 'match=' . $match . ',key=' . $key);
691                         }
692                 } // END - foreach
693         } // END - if
694
695         /*
696          * Find $foobar, $foo_bar and $fooBar entries. This regex would also find
697          * $content[foo_bar] which would result in {DOLLAR}content[foo_bar] and
698          * therefore the variable's value won't be inserted. This is why
699          * {COMPILE_DOLLAR} is being used in above loop and at the end of this
700          * function being replace with the original dollar sign again.
701          */
702         preg_match_all('/\$([a-z_A-Z\[\]]){0,}/', $code, $matches);
703
704         // Are some matches found?
705         if ((count($matches) > 0) && (count($matches[0]) > 0)) {
706                 // Scan all matches for not $content
707                 foreach ($matches[0] as $match) {
708                         // Trim match
709                         $match = trim($match);
710
711                         // Debug message
712                         //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'match=' . $match);
713
714                         // Is the first part not $content/$userid and not empty?
715                         // @TODO $userid is deprecated and should be removed from loadEmailTemplate() and replaced with $content[userid] in all templates
716                         if ((!empty($match)) && (substr($match, 0, 8) != '$content') && ($match != '$userid')) {
717                                 //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'match=' . $match . ' - SECURED!');
718                                 // Then replace $ with {DOLLAR}
719                                 $matchSecured = str_replace('$', '{DOLLAR}', $match);
720
721                                 // And in $code as well
722                                 $code = str_replace($match, $matchSecured, $code);
723                         } // END - if
724                 } // END - if
725         } // END - if
726
727         // Replace {COMPILE_DOLLAR} back to dollar sign
728         $code = str_replace('{COMPILE_DOLLAR}', '$', $code);
729
730         // Finally return it
731         return $code;
732 }
733
734 //
735 function addSelectionBox ($type, $default, $prefix = '', $id = '0', $class = 'form_select') {
736         $OUT = '';
737
738         if ($type == 'yn') {
739                 // This is a yes/no selection only!
740                 if ($id > 0) $prefix .= '[' . $id . ']';
741                 $OUT .= '<select name="' . $prefix . '" class="' . $class . '" size="1">';
742         } else {
743                 // Begin with regular selection box here
744                 if (!empty($prefix)) $prefix .= '_';
745                 $type2 = $type;
746                 if ($id > 0) $type2 .= '[' . $id . ']';
747                 $OUT .= '<select name="' . strtolower($prefix . $type2) . '" class="' . $class . '" size="1">';
748         }
749
750         switch ($type) {
751                 case 'day': // Day
752                         for ($idx = 1; $idx < 32; $idx++) {
753                                 $OUT .= '<option value="' . $idx . '"';
754                                 if ($default == $idx) $OUT .= ' selected="selected"';
755                                 $OUT .= '>' . $idx . '</option>';
756                         } // END - for
757                         break;
758
759                 case 'month': // Month
760                         foreach ($GLOBALS['month_descr'] as $idx => $descr) {
761                                 $OUT .= '<option value="' . $idx . '"';
762                                 if ($default == $idx) $OUT .= ' selected="selected"';
763                                 $OUT .= '>' . $descr . '</option>';
764                         } // END - for
765                         break;
766
767                 case 'year': // Year
768                         // Get current year
769                         $year = getYear();
770
771                         // Use configured min age or fixed?
772                         if (isExtensionInstalledAndNewer('other', '0.2.1')) {
773                                 // Configured
774                                 $startYear = $year - getConfig('min_age');
775                         } else {
776                                 // Fixed 16 years
777                                 $startYear = $year - 16;
778                         }
779
780                         // Calculate earliest year (100 years old people can still enter Internet???)
781                         $minYear = $year - 100;
782
783                         // Check if the default value is larger than minimum and bigger than actual year
784                         if (($default > $minYear) && ($default >= $year)) {
785                                 for ($idx = $year; $idx < ($year + 11); $idx++) {
786                                         $OUT .= '<option value="' . $idx . '"';
787                                         if ($default == $idx) $OUT .= ' selected="selected"';
788                                         $OUT .= '>' . $idx . '</option>';
789                                 } // END - for
790                         } elseif ($default == -1) {
791                                 // Current year minus 1
792                                 for ($idx = $startYear; $idx <= ($year + 1); $idx++) {
793                                         $OUT .= '<option value="' . $idx . '">' . $idx . '</option>';
794                                 } // END - for
795                         } else {
796                                 // Get current year and subtract the configured minimum age
797                                 $OUT .= '<option value="' . ($minYear - 1) . '">&lt;' . $minYear . '</option>';
798                                 // Calculate earliest year depending on extension version
799                                 if (isExtensionInstalledAndNewer('other', '0.2.1')) {
800                                         // Use configured minimum age
801                                         $year = getYear() - getConfig('min_age');
802                                 } else {
803                                         // Use fixed 16 years age
804                                         $year = getYear() - 16;
805                                 }
806
807                                 // Construct year selection list
808                                 for ($idx = $minYear; $idx <= $year; $idx++) {
809                                         $OUT .= '<option value="' . $idx . '"';
810                                         if ($default == $idx) $OUT .= ' selected="selected"';
811                                         $OUT .= '>' . $idx . '</option>';
812                                 } // END - for
813                         }
814                         break;
815
816                 case 'sec':
817                 case 'min':
818                         for ($idx = 0; $idx < 60; $idx+=5) {
819                                 if (strlen($idx) == 1) $idx = 0 . $idx;
820                                 $OUT .= '<option value="' . $idx . '"';
821                                 if ($default == $idx) $OUT .= ' selected="selected"';
822                                 $OUT .= '>' . $idx . '</option>';
823                         } // END - for
824                         break;
825
826                 case 'hour':
827                         for ($idx = 0; $idx < 24; $idx++) {
828                                 if (strlen($idx) == 1) $idx = 0 . $idx;
829                                 $OUT .= '<option value="' . $idx . '"';
830                                 if ($default == $idx) $OUT .= ' selected="selected"';
831                                 $OUT .= '>' . $idx . '</option>';
832                         } // END - for
833                         break;
834
835                 case 'yn':
836                         $OUT .= '<option value="Y"';
837                         if ($default == 'Y') $OUT .= ' selected="selected"';
838                         $OUT .= '>{--YES--}</option><option value="N"';
839                         if ($default != 'Y') $OUT .= ' selected="selected"';
840                         $OUT .= '>{--NO--}</option>';
841                         break;
842         }
843         $OUT .= '</select>';
844         return $OUT;
845 }
846
847 // Insert the code in $img_code into jpeg or PNG image
848 function generateImageOrCode ($img_code, $headerSent = true) {
849         // Is the code size oversized or shouldn't we display it?
850         if ((strlen($img_code) > 6) || (empty($img_code)) || (getCodeLength() == '0')) {
851                 // Stop execution of function here because of over-sized code length
852                 reportBug(__FUNCTION__, __LINE__, 'img_code ' . $img_code .' has invalid length. img_code(length)=' . strlen($img_code) . ' code_length=' . getCodeLength());
853         } elseif ($headerSent === false) {
854                 // Return an HTML code here
855                 return '<img src="{%url=img.php?code=' . $img_code . '%}" alt="Image" />';
856         }
857
858         // Load image
859         $img = sprintf("%s/theme/%s/images/code_bg.%s",
860                 getPath(),
861                 getCurrentTheme(),
862                 getImgType()
863         );
864
865         // Is it readable?
866         if (isFileReadable($img)) {
867                 // Switch image type
868                 switch (getImgType()) {
869                         case 'jpg': // Okay, load image and hide all errors
870                                 $image = imagecreatefromjpeg($img);
871                                 break;
872
873                         case 'png': // Okay, load image and hide all errors
874                                 $image = imagecreatefrompng($img);
875                                 break;
876                 } // END - switch
877         } else {
878                 // Silently log the error
879                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File for image-type %s in theme %s not found.", getImgType(), getCurrentTheme()));
880                 return;
881         }
882
883         // Generate text color (red/green/blue; 0 = dark, 255 = bright)
884         $text_color = imagecolorallocate($image, 0, 0, 0);
885
886         // Insert code into image
887         imagestring($image, 5, 14, 2, $img_code, $text_color);
888
889         // Return to browser
890         setContentType('image/' . getImgType());
891
892         // Output image with matching image factory
893         switch (getImgType()) {
894                 case 'jpg': imagejpeg($image); break;
895                 case 'png': imagepng($image);  break;
896         } // END - switch
897
898         // Remove image from memory
899         imagedestroy($image);
900 }
901
902 // Create selection box or array of splitted timestamp
903 function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $asArray = false) {
904         // Do not continue if ONE_DAY is absend
905         if (!isConfigEntrySet('ONE_DAY')) {
906                 // Abort here
907                 reportBug(__FUNCTION__, __LINE__, 'Configuration entry ONE_DAY is absend. timestamp=' . $timestamp . ',prefix=' . $prefix . ',align=' . $align . ',asArray=' . intval($asArray));
908         } // END - if
909
910         // Calculate 2-seconds timestamp
911         $stamp = round($timestamp);
912         //* DEBUG: */ debugOutput('*' . $stamp .'/' . $timestamp . '*');
913
914         // Is there a leap year?
915         $SWITCH = '0';
916         $TEST = getYear() / 4;
917         $M1 = getMonth();
918         $M2 = getMonth(time() + $timestamp);
919
920         // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
921         if ((floor($TEST) == $TEST) && ($M1 == '02') && ($M2 > '02'))  {
922                 $SWITCH = getOneDay();
923         } // END - switch
924
925         // First of all years...
926         $Y = abs(floor($timestamp / (31536000 + $SWITCH)));
927         //* DEBUG: */ debugOutput('Y=' . $Y);
928         // Next months...
929         $M = abs(floor($timestamp / 2628000 - $Y * 12));
930         //* DEBUG: */ debugOutput('M=' . $M);
931         // Next weeks
932         $W = abs(floor($timestamp / 604800 - $Y * ((365 + $SWITCH / getOneDay()) / 7) - ($M / 12 * (365 + $SWITCH / getOneDay()) / 7)));
933         //* DEBUG: */ debugOutput('W=' . $W);
934         // Next days...
935         $D = abs(floor($timestamp / 86400 - $Y * (365 + $SWITCH / getOneDay()) - ($M / 12 * (365 + $SWITCH / getOneDay())) - $W * 7));
936         //* DEBUG: */ debugOutput('D=' . $D);
937         // Next hours...
938         $h = abs(floor($timestamp / 3600 - $Y * (365 + $SWITCH / getOneDay()) * 24 - ($M / 12 * (365 + $SWITCH / getOneDay()) * 24) - $W * 7 * 24 - $D * 24));
939         //* DEBUG: */ debugOutput('h=' . $h);
940         // Next minutes..
941         $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));
942         //* DEBUG: */ debugOutput('m=' . $m);
943         // And at last seconds...
944         $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));
945         //* DEBUG: */ debugOutput('s=' . $s);
946
947         // Is seconds zero and time is < 60 seconds?
948         if (($s == '0') && ($timestamp < 60)) {
949                 // Fix seconds
950                 $s = round($timestamp);
951         } // END - if
952
953         //
954         // Now we convert them in seconds...
955         //
956         if ($asArray === true) {
957                 // Just put all data in an array for later use
958                 $OUT = array(
959                         'Y' => $Y,
960                         'M' => $M,
961                         'W' => $W,
962                         'D' => $D,
963                         'h' => $h,
964                         'm' => $m,
965                         's' => $s
966                 );
967         } else {
968                 // Generate table
969                 $OUT  = '<div align="' . $align . '">';
970                 $OUT .= '<table border="0" cellspacing="0" cellpadding="0" class="timebox_table dashed">';
971                 $OUT .= '<tr>';
972
973                 if (isInString('Y', $display) || (empty($display))) {
974                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--TIME_UNIT_YEAR--}</strong></td>';
975                 } // END - if
976
977                 if (isInString('M', $display) || (empty($display))) {
978                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--TIME_UNIT_MONTH--}</strong></td>';
979                 } // END - if
980
981                 if (isInString('W', $display) || (empty($display))) {
982                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--TIME_UNIT_WEEK--}</strong></td>';
983                 } // END - if
984
985                 if (isInString('D', $display) || (empty($display))) {
986                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--TIME_UNIT_DAY--}</strong></td>';
987                 } // END - if
988
989                 if (isInString('h', $display) || (empty($display))) {
990                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--TIME_UNIT_HOUR--}</strong></td>';
991                 } // END - if
992
993                 if (isInString('m', $display) || (empty($display))) {
994                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--TIME_UNIT_MINUTE--}</strong></td>';
995                 } // END - if
996
997                 if (isInString('s', $display) || (empty($display))) {
998                         $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--TIME_UNIT_SECOND--}</strong></td>';
999                 } // END - if
1000
1001                 $OUT .= '</tr>';
1002                 $OUT .= '<tr>';
1003
1004                 if (isInString('Y', $display) || (empty($display))) {
1005                         // Generate year selection
1006                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ye" size="1">';
1007                         for ($idx = 0; $idx <= 10; $idx++) {
1008                                 $OUT .= '<option class="mini_select" value="' . $idx . '"';
1009                                 if ($idx == $Y) $OUT .= ' selected="selected"';
1010                                 $OUT .= '>' . $idx . '</option>';
1011                         } // END - for
1012                         $OUT .= '</select></td>';
1013                 } else {
1014                         $OUT .= '<input type="hidden" name="' . $prefix . '_ye" value="0" />';
1015                 }
1016
1017                 if (isInString('M', $display) || (empty($display))) {
1018                         // Generate month selection
1019                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mo" size="1">';
1020                         for ($idx = 0; $idx <= 11; $idx++) {
1021                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
1022                                 if ($idx == $M) $OUT .= ' selected="selected"';
1023                                 $OUT .= '>' . $idx . '</option>';
1024                         } // END - for
1025                         $OUT .= '</select></td>';
1026                 } else {
1027                         $OUT .= '<input type="hidden" name="' . $prefix . '_mo" value="0" />';
1028                 }
1029
1030                 if (isInString('W', $display) || (empty($display))) {
1031                         // Generate week selection
1032                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_we" size="1">';
1033                         for ($idx = 0; $idx <= 4; $idx++) {
1034                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
1035                                 if ($idx == $W) $OUT .= ' selected="selected"';
1036                                 $OUT .= '>' . $idx . '</option>';
1037                         } // END - for
1038                         $OUT .= '</select></td>';
1039                 } else {
1040                         $OUT .= '<input type="hidden" name="' . $prefix . '_we" value="0" />';
1041                 }
1042
1043                 if (isInString('D', $display) || (empty($display))) {
1044                         // Generate day selection
1045                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_da" size="1">';
1046                         for ($idx = 0; $idx <= 31; $idx++) {
1047                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
1048                                 if ($idx == $D) $OUT .= ' selected="selected"';
1049                                 $OUT .= '>' . $idx . '</option>';
1050                         } // END - for
1051                         $OUT .= '</select></td>';
1052                 } else {
1053                         $OUT .= '<input type="hidden" name="' . $prefix . '_da" value="0" />';
1054                 }
1055
1056                 if (isInString('h', $display) || (empty($display))) {
1057                         // Generate hour selection
1058                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ho" size="1">';
1059                         for ($idx = 0; $idx <= 23; $idx++) {
1060                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
1061                                 if ($idx == $h) $OUT .= ' selected="selected"';
1062                                 $OUT .= '>' . $idx . '</option>';
1063                         } // END - for
1064                         $OUT .= '</select></td>';
1065                 } else {
1066                         $OUT .= '<input type="hidden" name="' . $prefix . '_ho" value="0" />';
1067                 }
1068
1069                 if (isInString('m', $display) || (empty($display))) {
1070                         // Generate minute selection
1071                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mi" size="1">';
1072                         for ($idx = 0; $idx <= 59; $idx++) {
1073                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
1074                                 if ($idx == $m) $OUT .= ' selected="selected"';
1075                                 $OUT .= '>' . $idx . '</option>';
1076                         } // END - for
1077                         $OUT .= '</select></td>';
1078                 } else {
1079                         $OUT .= '<input type="hidden" name="' . $prefix . '_mi" value="0" />';
1080                 }
1081
1082                 if (isInString('s', $display) || (empty($display))) {
1083                         // Generate second selection
1084                         $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_se" size="1">';
1085                         for ($idx = 0; $idx <= 59; $idx++) {
1086                                 $OUT .= '  <option class="mini_select" value="' . $idx . '"';
1087                                 if ($idx == $s) $OUT .= ' selected="selected"';
1088                                 $OUT .= '>' . $idx . '</option>';
1089                         } // END - for
1090                         $OUT .= '</select></td>';
1091                 } else {
1092                         $OUT .= '<input type="hidden" name="' . $prefix . '_se" value="0" />';
1093                 }
1094                 $OUT .= '</tr>';
1095                 $OUT .= '</table>';
1096                 $OUT .= '</div>';
1097         }
1098
1099         // Return generated HTML code
1100         return $OUT;
1101 }
1102
1103 // Generate a list of administrative links to a given userid
1104 function generateMemberAdminActionLinks ($userid) {
1105         // Make sure userid is a number
1106         if ($userid != bigintval($userid)) {
1107                 reportBug(__FUNCTION__, __LINE__, 'userid is not a number!');
1108         } // END - if
1109
1110         // Define all main targets
1111         $targetArray = runFilterChain('member_admin_actions', array('del_user', 'edit_user', 'lock_user', 'list_refs', 'list_links', 'add_points', 'sub_points'));
1112
1113         // Get user status
1114         $status = getFetchedUserData('userid', $userid, 'status');
1115
1116         // Begin of navigation links
1117         $OUT = '[';
1118
1119         foreach ($targetArray as $target) {
1120                 $OUT .= '<span class="admin_user_link"><a href="{%url=modules.php?module=admin&amp;what=' . $target . '&amp;userid=' . $userid . '%}" title="{--ADMIN_USER_ACTION_LINK_';
1121                 //* DEBUG: */ debugOutput('*' . $target.'/' . $status.'*');
1122                 if (($target == 'lock_user') && ($status == 'LOCKED')) {
1123                         // Locked accounts shall be unlocked
1124                         $OUT .= 'UNLOCK_USER';
1125                 } elseif ($target == 'del_user') {
1126                         // @TODO Deprecate this thing
1127                         $OUT .= 'DELETE_USER';
1128                 } else {
1129                         // All other status is fine
1130                         $OUT .= strtoupper($target);
1131                 }
1132                 $OUT .= '_TITLE--}">{--ADMIN_USER_ACTION_LINK_';
1133                 if (($target == 'lock_user') && ($status == 'LOCKED')) {
1134                         // Locked accounts shall be unlocked
1135                         $OUT .= 'UNLOCK_USER';
1136                 } elseif ($target == 'del_user') {
1137                         // @TODO Deprecate this thing
1138                         $OUT .= 'DELETE_USER';
1139                 } else {
1140                         // All other status is fine
1141                         $OUT .= strtoupper($target);
1142                 }
1143                 $OUT .= '--}</a></span>|';
1144         } // END - foreach
1145
1146         // Add special link, in case of the account is unconfirmed
1147         if ($status == 'UNCONFIRMED') {
1148                 // Add it
1149                 $OUT .= '<span class="admin_user_link"><a target="_blank" title="{--ADMIN_USER_ACTION_LINK_CONFIRM_ACCOUNT_TITLE--}" href="{%url=confirm.php?hash=' . getFetchedUserData('userid', $userid, 'user_hash') . '%}">{--ADMIN_USER_ACTION_LINK_CONFIRM_ACCOUNT--}</a></span>|';
1150         } // END - if
1151
1152         // Finish navigation link
1153         $OUT = substr($OUT, 0, -1) . ']';
1154
1155         // Return string
1156         return $OUT;
1157 }
1158
1159 // Generate an email link
1160 function generateEmailLink ($email, $table = 'admins') {
1161         // Default email link (INSECURE! Spammer can read this by harvester programs)
1162         $EMAIL = 'mailto:' . $email;
1163
1164         // Check for several extensions
1165         if ((isExtensionActive('admins')) && ($table == 'admins')) {
1166                 // Create email link for contacting admin in guest area
1167                 $EMAIL = generateAdminEmailLink($email);
1168         } elseif ((isExtensionInstalledAndNewer('user', '0.3.3')) && ($table == 'user_data')) {
1169                 // Create email link for contacting a member within admin area (or later in other areas, too?)
1170                 $EMAIL = generateUserEmailLink($email);
1171         } elseif ((isExtensionActive('sponsor')) && ($table == 'sponsor_data')) {
1172                 // Create email link to contact sponsor within admin area (or like the link above?)
1173                 $EMAIL = generateSponsorEmailLink($email);
1174         }
1175
1176         // Return email link
1177         return $EMAIL;
1178 }
1179
1180 /**
1181  * Outputs an error message in a "fashioned way" to the user, by putting it into
1182  * a nice looking web page, if one of HTML or CSS output mode is active.
1183  *
1184  * Please use reportBug() instead of this function. reportBug() has more helpful
1185  * functionality like logging and admin notification (which you can configure
1186  * through your admin area).
1187  *
1188  * @param       $F                      Function or file basename where the error came from
1189  * @param       $L                      Line number where the error came from
1190  * @param       $message        Message which shall be output to web
1191  * @return      void
1192  */
1193 function app_exit ($F, $L, $message) {
1194         // Check if Script is already dieing and not let it kill itself another 1000 times
1195         if (isset($GLOBALS['app_died'])) {
1196                 // Script tried to kill itself twice
1197                 die('[' . __FUNCTION__ . ':' . __LINE__ . ']: Script wanted to kill itself more than once! Raw message=' . $message . ', file/function=' . $F . ', line=' . $L);
1198         } // END - if
1199
1200         // Make sure, that the script realy realy diese here and now
1201         $GLOBALS['app_died'] = true;
1202
1203         // Set content type as text/html
1204         setContentType('text/html');
1205
1206         // Load header
1207         loadIncludeOnce('inc/header.php');
1208
1209         // Rewrite message for output
1210         $message = sprintf(
1211                 getMessage('MAILER_HAS_DIED'),
1212                 basename($F),
1213                 $L,
1214                 $message
1215         );
1216
1217         // Load the message template
1218         loadTemplate('app_exit_message', false, $message);
1219
1220         // Load footer
1221         loadIncludeOnce('inc/footer.php');
1222 }
1223
1224 // Display parsing time and number of SQL queries in footer
1225 function displayParsingTime () {
1226         // Is the timer started?
1227         if (!isset($GLOBALS['__start_time'])) {
1228                 // Abort here
1229                 return false;
1230         } // END - if
1231
1232         // Get end time
1233         $endTime = microtime(true);
1234
1235         // "Explode" both times
1236         $start = explode(' ', $GLOBALS['__start_time']);
1237         $end = explode(' ', $endTime);
1238         $runTime = $end[0] - $start[0];
1239         if ($runTime < 0) {
1240                 $runTime = '0';
1241         } // END - if
1242
1243         // Prepare output
1244         // @TODO This can be easily moved out after the merge from EL branch to this is complete
1245         $content = array(
1246                 'run_time' => $runTime,
1247                 'sql_time' => (getConfig('sql_time') * 1000),
1248         );
1249
1250         // Load the template
1251         $GLOBALS['__page_footer'] .= loadTemplate('show_timings', true, $content);
1252 }
1253
1254 /**
1255  * Outputs an error message and backtrace to the user, by default a mail with
1256  * all relevant data is being mailed to the configured administrators.
1257  *
1258  * This function shall be used "publicly" because of logging, admin notification
1259  * and double-call prevention (see first if() block) instead of app_exit().
1260  * app_exit() is more a "private" function and will only output a bug message to
1261  * the user, no email and no logging.
1262  *
1263  * @param       $F                      Function or file basename where the error came from
1264  * @param       $L                      Line number where the error came from
1265  * @param       $sendEmail      Wether to send an email to all configured administrators
1266  * @return      void
1267  */
1268 function reportBug ($F, $L, $message = '', $sendEmail = true) {
1269         // Is this already called?
1270         if (isset($GLOBALS[__FUNCTION__])) {
1271                 // Other backtrace
1272                 print '[' . $F . ':' . $L . ':] ' . __FUNCTION__ . ' has already died! Message:' . $message . '<br />Backtrace:<pre>';
1273                 debug_print_backtrace();
1274                 die('</pre>');
1275         } // END - if
1276
1277         // Set HTTP status to 500 (e.g. for AJAX requests)
1278         setHttpStatus('500 Internal Server Error');
1279
1280         // Mark this function as called
1281         $GLOBALS[__FUNCTION__] = true;
1282
1283         // Init message
1284         $debug = '';
1285
1286         // Is the optional message set?
1287         if (!empty($message)) {
1288                 // Use and log it
1289                 $debug = sprintf("Note: %s<br />\n",
1290                         $message
1291                 );
1292
1293                 // @TODO Add a little more infos here
1294                 logDebugMessage($F, $L, strip_tags($message));
1295         } // END - if
1296
1297         // Add output
1298         $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 this whole message + logfile from <strong>' . str_replace(getPath(), '', getCachePath()) . 'debug.log</strong> in your report (you can now attach files).<br />Backtrace:<pre>';
1299         $debug .= debug_get_printable_backtrace();
1300         $debug .= '</pre>';
1301         $debug .= '<div class="para">Request-URI: ' . getRequestUri() . '</div>';
1302         $debug .= '<div class="para">Thank you for finding bugs.</div>';
1303
1304         // Send an email? (e.g. not wanted for evaluation errors)
1305         if (($sendEmail === true) && (!isInstallationPhase())) {
1306                 // Prepare content
1307                 $content = array(
1308                         'message'   => trim($message),
1309                         'backtrace' => trim(debug_get_mailable_backtrace())
1310                 );
1311
1312                 // Send email to webmaster
1313                 sendAdminNotification('{--REPORT_BUG_SUBJECT--}', 'admin_report_bug', $content);
1314         } // END - if
1315
1316         // Is there HTML/CSS/AJAX mode?
1317         if ((isHtmlOutputMode()) || (isCssOutputMode()) || (isAjaxOutputMode())) {
1318                 // And abort here
1319                 app_exit($F, $L, $debug);
1320         } else {
1321                 // Raw/image output mode and all other modes doesn't work well with text ...
1322                 die();
1323         }
1324 }
1325
1326 // Compile characters which are allowed in URLs
1327 function compileUriCode ($code, $simple = true) {
1328         // Trim code
1329         $test = trim($code);
1330
1331         // Is it empty?
1332         if (empty($test)) {
1333                 // Then abort here and return the original code
1334                 return $code;
1335         } // END - if
1336
1337         // Compile these by default
1338         $charsCompile = array(
1339                 'from' => array(
1340                         '{DOT}',
1341                         '{SLASH}',
1342                         '{QUOT}',
1343                         '{DOLLAR}',
1344                         '{OPEN_ANCHOR}',
1345                         '{CLOSE_ANCHOR}',
1346                         '{OPEN_SQR}',
1347                         '{CLOSE_SQR}',
1348                         '{PER}'
1349                 ),
1350                 'to' => array(
1351                         '.',
1352                         '/',
1353                         chr(39),
1354                         '$',
1355                         '(',
1356                         ')',
1357                         '[',
1358                         ']',
1359                         '%'
1360                 )
1361         );
1362
1363         // Compile constants
1364         if ($simple === false) {
1365                 // Add more 'from'
1366                 array_push($charsCompile['from'], '{--', '--}');
1367
1368                 // Add more 'to'
1369                 array_push($charsCompile['to'], '".', '."');
1370         } // END - if
1371
1372         // Compile QUOT and other non-HTML codes
1373         $code = str_replace($charsCompile['from'], $charsCompile['to'], $code);
1374
1375         // Return compiled code
1376         return $code;
1377 }
1378
1379 // Handle message codes from URL
1380 function handleCodeMessage () {
1381         // Is 'code' set?
1382         if (isGetRequestElementSet('code')) {
1383                 // Default extension is 'unknown'
1384                 $ext = 'unknown';
1385
1386                 // Is extension given?
1387                 if (isGetRequestElementSet('ext')) {
1388                         $ext = getRequestElement('ext');
1389                 } // END - if
1390
1391                 // Convert the 'code' parameter from URL to a human-readable message
1392                 $message = getMessageFromErrorCode(getRequestElement('code'));
1393
1394                 // Load message template
1395                 loadTemplate('message', false, $message);
1396         } // END - if
1397 }
1398
1399 // Generates a 'extension foo out-dated' message
1400 function generateExtensionOutdatedMessage ($ext_name, $ext_ver) {
1401         // Is the extension empty?
1402         if (empty($ext_name)) {
1403                 // This should not happen
1404                 reportBug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1405         } // END - if
1406
1407         // Default message
1408         $message = '{%message,EXTENSION_PROBLEM_EXTENSION_OUTDATED=' . $ext_name . '%}';
1409
1410         // Is an admin logged in?
1411         if (isAdmin()) {
1412                 // Then output admin message
1413                 $message = sprintf(getMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE'), $ext_name, $ext_name, $ext_ver);
1414         } // END - if
1415
1416         // Return prepared message
1417         return $message;
1418 }
1419
1420 // Generates a 'extension foo inactive' message
1421 function generateExtensionInactiveMessage ($ext_name) {
1422         // Is the extension empty?
1423         if (empty($ext_name)) {
1424                 // This should not happen
1425                 reportBug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1426         } // END - if
1427
1428         // Default message
1429         $message = '{%message,EXTENSION_PROBLEM_EXTENSION_INACTIVE=' . $ext_name . '%}';
1430
1431         // Is an admin logged in?
1432         if (isAdmin()) {
1433                 // Then output admin message
1434                 $message = '{%message,ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE=' . $ext_name . '%}';
1435         } // END - if
1436
1437         // Return prepared message
1438         return $message;
1439 }
1440
1441 // Generates a 'extension foo not installed' message
1442 function generateExtensionNotInstalledMessage ($ext_name) {
1443         // Is the extension empty?
1444         if (empty($ext_name)) {
1445                 // This should not happen
1446                 reportBug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1447         } // END - if
1448
1449         // Default message
1450         $message = '{%message,EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED=' . $ext_name . '%}';
1451
1452         // Is an admin logged in?
1453         if (isAdmin()) {
1454                 // Then output admin message
1455                 $message = '{%message,ADMIN_EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED=' . $ext_name . '%}';
1456         } // END - if
1457
1458         // Return prepared message
1459         return $message;
1460 }
1461
1462 // Generates a message depending on if the extension is not installed or not
1463 // just activated
1464 function generateExtensionInactiveNotInstalledMessage ($ext_name) {
1465         // Init message
1466         $message = '';
1467
1468         // Is the extension not installed or just deactivated?
1469         switch (isExtensionInstalled($ext_name)) {
1470                 case true; // Deactivated!
1471                         $message = generateExtensionInactiveMessage($ext_name);
1472                         break;
1473
1474                 case false; // Not installed!
1475                         $message = generateExtensionNotInstalledMessage($ext_name);
1476                         break;
1477
1478                 default: // Should not happen!
1479                         logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid state of extension %s detected.", $ext_name));
1480                         $message = sprintf("Invalid state of extension %s detected.", $ext_name);
1481                         break;
1482         } // END - switch
1483
1484         // Return the message
1485         return $message;
1486 }
1487
1488 // Print code with line numbers
1489 function linenumberCode ($code)    {
1490         // By default copy the code
1491         $codeE = $code;
1492
1493         if (!is_array($code)) {
1494                 // We need an array, so try it with the new-line character
1495                 $codeE = explode(chr(10), $code);
1496         } // END - if
1497
1498         $count_lines = count($codeE);
1499
1500         $r = 'Line | Code:<br />';
1501         foreach ($codeE as $line => $c) {
1502                 $r .= '<div class="line"><span class="linenum">';
1503                 if ($count_lines == 1) {
1504                         $r .= 1;
1505                 } else {
1506                         $r .= ($line == ($count_lines - 1)) ? '' : ($line+1);
1507                 }
1508                 $r .= '</span>|';
1509
1510                 // Add code
1511                 $r .= '<span class="linetext">' . encodeEntities($c) . '</span></div>';
1512         } // END - foreach
1513
1514         return '<div class="code">' . $r . '</div>';
1515 }
1516
1517 // Determines the right page title
1518 function determinePageTitle () {
1519         // Init page title
1520         $pageTitle = '';
1521
1522         // Config and database connection valid?
1523         if ((isConfigLocalLoaded()) && (isConfigurationLoaded()) && (SQL_IS_LINK_UP()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1524                 // Title decoration enabled?
1525                 if ((isTitleDecorationEnabled()) && (getTitleLeft() != '')) {
1526                         $pageTitle .= '{%config,trim=title_left%} ';
1527                 } // END - if
1528
1529                 // Is there an extra title?
1530                 if (isExtraTitleSet()) {
1531                         // Then prepend it
1532                         $pageTitle .= '{%pipe,getExtraTitle%} by ';
1533                 } // END - if
1534
1535                 // Add main title
1536                 $pageTitle .= '{?MAIN_TITLE?}';
1537
1538                 // Add title of module? (middle decoration will also be added!)
1539                 if ((isModuleTitleEnabled()) || ((!isWhatSet()) && (!isActionSet())) || (getModule() == 'admin')) {
1540                         $pageTitle .= ' {%config,trim=title_middle%} {DQUOTE} . getModuleTitle(getModule()) . {DQUOTE}';
1541                 } // END - if
1542
1543                 // Add title from what file
1544                 $menuMode = '';
1545                 if (getModule() == 'login') {
1546                         $menuMode = 'member';
1547                 } elseif (getModule() == 'index') {
1548                         $menuMode = 'guest';
1549                 } elseif (getModule() == 'admin') {
1550                         $menuMode = 'admin';
1551                 } elseif (getModule() == 'sponsor') {
1552                         $menuMode = 'sponsor';
1553                 }
1554
1555                 // Add middle part (always in admin area!)
1556                 if ((!empty($menuMode)) && ((isWhatTitleEnabled()) || ($menuMode == 'admin'))) {
1557                         $pageTitle .= ' {%config,trim=title_middle%} ' . getTitleFromMenu($menuMode, getWhat());
1558                 } // END - if
1559
1560                 // Add title decorations? (right)
1561                 if ((isTitleDecorationEnabled()) && (getTitleRight() != '')) {
1562                         $pageTitle .= ' {%config,trim=title_right%}';
1563                 } // END - if
1564         } elseif ((isInstalled()) && (isAdminRegistered())) {
1565                 // Installed, admin registered but no ext-sql_patches
1566                 $pageTitle = '[-- {?MAIN_TITLE?} - {%pipe,getModule,getModuleTitle%} --]';
1567         } elseif ((isInstalled()) && (!isAdminRegistered())) {
1568                 // Installed but no admin registered
1569                 $pageTitle = '{--INSTALLER_OF_MAILER_NO_ADMIN--}';
1570         } elseif ((!isInstalled()) || (!isAdminRegistered())) {
1571                 // Installation mode
1572                 $pageTitle = '{--INSTALLER_OF_MAILER--}';
1573         } else {
1574                 // Configuration not found
1575                 $pageTitle = '{--NO_CONFIG_FOUND_TITLE--}';
1576
1577                 // Do not add the fatal message in installation mode
1578                 if ((!isInstalling()) && (!isConfigurationLoaded())) {
1579                         // Please report this
1580                         reportBug(__FUNCTION__, __LINE__, 'No configuration data found!');
1581                 } // END - if
1582         }
1583
1584         // Return title
1585         return decodeEntities($pageTitle);
1586 }
1587
1588 // Checks whethere there is a cache file there. This function is cached.
1589 function isTemplateCached ($prefix, $template) {
1590         // Is there cached this result?
1591         if (!isset($GLOBALS['template_cache'][$prefix][$template])) {
1592                 // Generate FQFN
1593                 $FQFN = generateCacheFqfn($prefix, $template);
1594
1595                 // Is it there?
1596                 $GLOBALS['template_cache'][$prefix][$template] = isFileReadable($FQFN);
1597         } // END - if
1598
1599         // Return it
1600         return $GLOBALS['template_cache'][$prefix][$template];
1601 }
1602
1603 // Flushes non-flushed template cache to disk
1604 function flushTemplateCache ($prefix, $template, $eval) {
1605         // Is this cache flushed?
1606         if ((isDebuggingTemplateCache() === false) && (isTemplateCached($prefix, $template) === false) && ($eval != '404')) {
1607                 // Generate FQFN
1608                 $FQFN = generateCacheFqfn($prefix, $template);
1609
1610                 // Is this a XML template?
1611                 if ($prefix == 'xml') {
1612                         // Compact only XML templates as emails needs new-line characters and HTML may contain required "comments"
1613                         $eval = compactContent($eval);
1614                 } // END - if
1615
1616                 // And flush it
1617                 writeToFile($FQFN, $eval, true);
1618         } // END - if
1619 }
1620
1621 // Reads a template cache
1622 function readTemplateCache ($prefix, $template) {
1623         // Check it again
1624         if ((isDebuggingTemplateCache()) || (!isTemplateCached($prefix, $template))) {
1625                 // This should not happen
1626                 reportBug('Wether debugging of template cache is enabled or template ' . $template . ' is not cached while expected.');
1627         } // END - if
1628
1629         // Is it cached?
1630         if (!isset($GLOBALS['template_eval'][$prefix][$template])) {
1631                 // Generate FQFN
1632                 $FQFN = generateCacheFqfn($prefix, $template);
1633
1634                 // And read from it
1635                 $GLOBALS['template_eval'][$prefix][$template] = readFromFile($FQFN);
1636         } // END - if
1637
1638         // And return it
1639         return $GLOBALS['template_eval'][$prefix][$template];
1640 }
1641
1642 // Escapes quotes (default is only double-quotes)
1643 function escapeQuotes ($str, $single = false) {
1644         // Should we escape all?
1645         if ($single === true) {
1646                 // Escape all (including null)
1647                 $str = addslashes($str);
1648         } else {
1649                 // Replace all chars at once
1650                 $str = str_replace(array("\\'", '"', "\\\\"), array(chr(39), "\\\"", chr(92)), $str);
1651         }
1652
1653         // Return the escaped string
1654         return $str;
1655 }
1656
1657 // Escapes the JavaScript code, prevents \r and \n becoming char 10/13
1658 function escapeJavaScriptQuotes ($str) {
1659         // Replace all double-quotes and secure back-ticks
1660         $str = str_replace(array(chr(92), '"'), array('{BACK}', '\"'), $str);
1661
1662         // Return it
1663         return $str;
1664 }
1665
1666 // Send out mails depending on the 'mod/modes' combination
1667 // @TODO Lame description for this function
1668 function sendModeMails ($mod, $modes) {
1669         // Init user data
1670         $content = array ();
1671
1672         // Load hash
1673         if (fetchUserData(getMemberId())) {
1674                 // Extract salt from cookie
1675                 $salt = substr(getSession('u_hash'), 0, -40);
1676
1677                 // Now let's compare passwords
1678                 $hash = encodeHashForCookie(getUserData('password'));
1679
1680                 // Does the hash match or should we change it?
1681                 if (($hash == getSession('u_hash')) || (postRequestElement('pass1') == postRequestElement('pass2'))) {
1682                         // Load the data
1683                         $content = getUserDataArray();
1684
1685                         // Clear/init the content variable
1686                         $content['message'] = '';
1687
1688                         // Which mail?
1689                         // @TODO Move this in a filter
1690                         switch ($mod) {
1691                                 case 'mydata':
1692                                         foreach ($modes as $mode) {
1693                                                 switch ($mode) {
1694                                                         case 'normal': break; // Do not add any special lines
1695                                                         case 'email': // Email was changed!
1696                                                                 $content['message'] = '{--MEMBER_CHANGED_EMAIL--}' . ': ' . postRequestElement('old_email') . chr(10);
1697                                                                 break;
1698
1699                                                         case 'password': // Password was changed
1700                                                                 $content['message'] = '{--MEMBER_CHANGED_PASS--}' . chr(10);
1701                                                                 break;
1702
1703                                                         default:
1704                                                                 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown mode %s detected.", $mode));
1705                                                                 $content['message'] = '{--MEMBER_UNKNOWN_MODE--}' . ': ' . $mode . "\n\n";
1706                                                                 break;
1707                                                 } // END - switch
1708                                         } // END - foreach
1709
1710                                         if (isExtensionActive('country')) {
1711                                                 // Replace code with description
1712                                                 $content['country'] = generateCountryInfo(postRequestElement('country_code'));
1713                                         } // END - if
1714
1715                                         // Merge content with data from POST
1716                                         $content = merge_array($content, postRequestArray());
1717
1718                                         // Load template
1719                                         $message = loadEmailTemplate('member_mydata_notify', $content, getMemberId());
1720
1721                                         if (isAdminNotificationEnabled()) {
1722                                                 // The admin needs to be notified about a profile change
1723                                                 $message_admin = 'admin_mydata_notify';
1724                                                 $sub_adm   = '{--ADMIN_CHANGED_DATA--}';
1725                                         } else {
1726                                                 // No mail to admin
1727                                                 $message_admin = '';
1728                                                 $sub_adm   = '';
1729                                         }
1730
1731                                         // Set subject lines
1732                                         $sub_mem = '{--MEMBER_CHANGED_DATA--}';
1733
1734                                         // Output success message
1735                                         $content['message'] = '<span class="message">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1736                                         break;
1737
1738                                 default: // Unsupported module!
1739                                         logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unsupported module %s detected.", $mod));
1740                                         $content['message'] = '<span class="bad">{--UNKNOWN_MODULE--}</span>';
1741                                         break;
1742                         } // END - switch
1743                 } else {
1744                         // Passwords mismatch
1745                         $content['message'] = '<span class="bad">{--MEMBER_PASSWORD_ERROR--}</span>';
1746                 }
1747         } else {
1748                 // Could not load profile
1749                 $content['message'] = '<span class="bad">{--MEMBER_CANNOT_LOAD_PROFILE--}</span>';
1750         }
1751
1752         // Send email to user if required
1753         if ((!empty($sub_mem)) && (!empty($message)) && (!empty($content['userid']))) {
1754                 // Send member mail
1755                 sendEmail($content['userid'], $sub_mem, $message);
1756         } // END - if
1757
1758         // Send only if no other error has occured
1759         if ((!empty($sub_adm)) && (!empty($message_admin)) && (isAdminNotificationEnabled())) {
1760                 // Send admin mail
1761                 sendAdminNotification($sub_adm, $message_admin, $content, getMemberId());
1762         } elseif (isAdminNotificationEnabled()) {
1763                 // Cannot send mails to admin!
1764                 $content['message'] = '{--CANNOT_SEND_ADMIN_MAILS--}';
1765         } else {
1766                 // No mail to admin
1767                 $content['message'] = '<span class="message">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1768         }
1769
1770         // Load template
1771         displayMessage($content['message']);
1772 }
1773
1774 // Generates a 'selection box' from given array
1775 function generateSelectionBoxFromArray ($options, $name, $optionKey, $optionContent = '', $extraName = '', $templateName = '', $default = NULL, $nameElement = '', $allowNone = false, $useDefaultAsArray = false) {
1776         // Default is empty
1777         $addKey = '';
1778
1779         // Use default value as array key?
1780         if ($useDefaultAsArray === true) {
1781                 // Then set it
1782                 $addKey = '[' . convertNullToZero($default) . ']';
1783         } // END - if
1784
1785         // Start the output
1786         $OUT = '<select name="' . $name . $addKey . '" size="1" class="form_select">
1787 <option value="X" disabled="disabled">{--PLEASE_SELECT--}</option>';
1788
1789         // Allow none?
1790         if ($allowNone === true) {
1791                 // Then add it
1792                 $OUT .= '<option value="0">{--SELECT_NONE--}</option>';
1793         } // END - if
1794
1795         // Walk through all options
1796         foreach ($options as $option) {
1797                 // Default 'default' is not set
1798                 $option['default'] = '';
1799
1800                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'name=' . $name . ',default[' . gettype($default) . ']=' . $default . ',optionKey[' . gettype($optionKey) . ']=' . $optionKey);
1801                 // Is default value same as given value?
1802                 if ((!is_null($default)) && (isset($option[$optionKey])) && ($default == $option[$optionKey])) {
1803                         // Then set default
1804                         $option['default'] = ' selected="selected"';
1805                 } // END - if
1806
1807                 // Is 'nameElement' set?
1808                 if ((!empty($nameElement)) && (isset($option[$nameElement]))) {
1809                         // Then set this as extraName, but lower-case
1810                         $extraName = '_' . strtolower($option[$nameElement]);
1811                 } // END - if
1812
1813                 // Add the <option> entry from ...
1814                 if (empty($optionContent)) {
1815                         // Is a template name given?
1816                         if (empty($templateName)) {
1817                                 // ... $name template
1818                                 $OUT .= loadTemplate('select_' . $name . $extraName . '_option', true, $option);
1819                         } else {
1820                                 // ... $templateName template
1821                                 $OUT .= loadTemplate('select_' . $templateName . $extraName . '_option', true, $option);
1822                         }
1823                 } else {
1824                         // ... direct HTML code
1825                         $OUT .= '<option value="' . $option[$optionKey] . '">' . $option[$optionContent] . '</option>';
1826                 }
1827         } // END - foreach
1828
1829         // Finish selection box
1830         $OUT .= '</select>';
1831
1832         // Prepare output
1833         $content = array(
1834                 'selection_box' => $OUT,
1835         );
1836
1837         // Load template and return it
1838         if (empty($templateName)) {
1839                 // Use name from $name + $extraName
1840                 return loadTemplate('select_' . $name . $extraName . '_box', true, $content);
1841         } else {
1842                 // Use name from $templateName + $extraName
1843                 return loadTemplate('select_' . $templateName . $extraName . '_box', true, $content);
1844         }
1845 }
1846
1847 // Prepares the header for HTML output
1848 function loadHtmlHeader () {
1849         /*
1850          * Run two filters:
1851          * 1.) pre_page_header (mainly loads the page_header template and includes
1852          *     meta description)
1853          */
1854         runFilterChain('pre_page_header');
1855
1856         /*
1857          * Here can be something be added, but normally one of the two filters
1858          * around this line should do the job for you.
1859          */
1860
1861         /*
1862          * 2.) post_page_header (mainly to load stylesheet, extra JavaScripts and
1863          *     to close the head-tag)
1864          * Include more header data here
1865          */
1866         runFilterChain('post_page_header');
1867 }
1868
1869 // Adds page header and footer to output array element
1870 function addPageHeaderFooter () {
1871         // Init output
1872         $OUT = '';
1873
1874         // Add them all together. This is maybe to simple
1875         foreach (array('__page_header', '__output', '__page_footer') as $pagePart) {
1876                 // Add page part if set
1877                 if (isset($GLOBALS[$pagePart])) {
1878                         $OUT .= $GLOBALS[$pagePart];
1879                 } // END - if
1880         } // END - foreach
1881
1882         // Transfer $OUT to '__output'
1883         $GLOBALS['__output'] = $OUT;
1884 }
1885
1886 // Generates meta description for current module and 'what' value
1887 function generateMetaDescriptionCode () {
1888         // Only include from guest area and if sql_patches has correct version
1889         if ((getModule() == 'index') && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1890                 // Output it directly
1891                 $GLOBALS['__page_header'] .= '<meta name="description" content="' . '{?MAIN_TITLE?} ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu('guest', getWhat()) . '" />';
1892         } // END - if
1893
1894         // Initialize referral system
1895         initReferralSystem();
1896 }
1897
1898 // Generates an FQFN for template cache from the given template name
1899 function generateCacheFqfn ($prefix, $template) {
1900         // Is this cached?
1901         if (!isset($GLOBALS['template_cache_fqfn'][$prefix][$template])) {
1902                 // Generate the FQFN
1903                 $GLOBALS['template_cache_fqfn'][$prefix][$template] = sprintf(
1904                         "%s_compiled/%s/%s.tpl.cache",
1905                         getCachePath(),
1906                         $prefix,
1907                         $template
1908                 );
1909         } // END - if
1910
1911         // Return it
1912         return $GLOBALS['template_cache_fqfn'][$prefix][$template];
1913 }
1914
1915 // "Fixes" null or empty string to count of dashes
1916 function fixNullEmptyToDashes ($str, $num) {
1917         // Use str as default
1918         $return = $str;
1919
1920         // Is it empty?
1921         if ((is_null($str)) || (trim($str) == '')) {
1922                 // Set it
1923                 $return = str_repeat('-', $num);
1924         } // END - if
1925
1926         // Return final string
1927         return $return;
1928 }
1929
1930 // Translates the "pool type" into human-readable
1931 function translatePoolType ($type) {
1932         // Return "translation"
1933         return sprintf("{--POOL_TYPE_%s--}", strtoupper($type));
1934 }
1935
1936 // "Translates" given time unit
1937 function translateTimeUnit ($unit) {
1938         // Default is unknown
1939         $message = '{%message,TIME_UNIT_UNKNOWN=' . $unit . '%}';
1940
1941         // "Detect" it
1942         if (!isset($GLOBALS['time_units'][$unit])) {
1943                 // Not found
1944                 logDebugMessage(__FUNCTION__, __LINE__, 'Unknown time unit ' . $unit . ' detected.');
1945         } else {
1946                 // Translate it with generic function
1947                 $message = translateGeneric('TIME_UNIT' , $GLOBALS['time_units'][$unit]);
1948         }
1949
1950         // Return message
1951         return $message;
1952 }
1953
1954 // Displays given message in admin_settings_saved template
1955 function displayMessage ($message, $return = false) {
1956         // Load the template
1957         return loadTemplate('admin_settings_saved', $return, $message);
1958 }
1959
1960 // Generates a selection box for (maybe) given gender
1961 function generateGenderSelectionBox ($selectedGender = '', $fieldName = 'gender') {
1962         // Start the HTML code
1963         $out  = '<select name="' . $fieldName . '" size="1" class="form_select">';
1964
1965         // Add options
1966         $out .= generateOptions(
1967                 '/ARRAY/',
1968                 array(
1969                         'M',
1970                         'F',
1971                         'C'
1972                 ), array(
1973                         '{--GENDER_M--}',
1974                         '{--GENDER_F--}',
1975                         '{--GENDER_C--}'
1976                 ),
1977                 $selectedGender
1978         );
1979
1980         // Finish HTML code
1981         $out .= '</select>';
1982
1983         // Return the code
1984         return $out;
1985 }
1986
1987 // Generates a selection box for given default value
1988 function generateTimeUnitSelectionBox ($defaultUnit, $fieldName, $unitArray) {
1989         // Init variables
1990         $messageIds = array();
1991
1992         // Generate message id array
1993         foreach ($unitArray as $unit) {
1994                 // "Translate" it
1995                 array_push($messageIds, '{%pipe,translateTimeUnit=' . $unit . '%}');
1996         } // END - foreach
1997
1998         // Start the HTML code
1999         $out = '<select name="' . $fieldName . '" size="1" class="form_select">';
2000
2001         // Add options
2002         $out .= generateOptions('/ARRAY/', $unitArray, $messageIds, $defaultUnit);
2003
2004         // Finish HTML code
2005         $out .= '</select>';
2006
2007         // Return the code
2008         return $out;
2009 }
2010
2011 // Function to add style tag (whether display:none/block)
2012 function addStyleMenuContent ($menuMode, $mainAction, $action) {
2013         // Is there foo_menu_javascript enabled?
2014         if ((!isConfigEntrySet($menuMode . '_menu_javascript')) || (getConfig($menuMode . '_menu_javascript') == 'N')) {
2015                 // Silently abort here, not enabled
2016                 return '';
2017         } // END - if
2018
2019         // Is action=mainAction?
2020         if ($action == $mainAction) {
2021                 // Add "menu open" style
2022                 return ' style="display:block"';
2023         } else {
2024                 return ' style="display:none"';
2025         }
2026 }
2027
2028 // Function to add onclick attribute
2029 function addJavaScriptMenuContent ($menuMode, $mainAction, $action, $what) {
2030         // Is there foo_menu_javascript enabled?
2031         if ((!isConfigEntrySet($menuMode . '_menu_javascript')) || (getConfig($menuMode . '_menu_javascript') == 'N')) {
2032                 // Silently abort here, not enabled
2033                 return '';
2034         } // END - if
2035
2036         // Prepare output
2037         $OUT = ' onclick="return changeMenuFoldState(' . $menuMode . ', ' . $mainAction . ', ' . $action . ', ' . $what . ')';
2038
2039         // Return output
2040         return $OUT;
2041 }
2042
2043 //-----------------------------------------------------------------------------
2044 //                     Template helper functions for EL code
2045 //-----------------------------------------------------------------------------
2046
2047 // Color-switch helper function
2048 function doTemplateColorSwitch ($templateName, $clear = false, $return = true) {
2049         // Is it there?
2050         if (!isset($GLOBALS['color_switch'][$templateName])) {
2051                 // Initialize it
2052                 initTemplateColorSwitch($templateName);
2053         } elseif ($clear === false) {
2054                 // Switch color if called from loadTemplate()
2055                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SWITCH:' . $templateName);
2056                 $GLOBALS['color_switch'][$templateName] = 3 - $GLOBALS['color_switch'][$templateName];
2057         }
2058
2059         // Return CSS class name
2060         if ($return === true) {
2061                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'RETURN:' . $templateName . '=' . $GLOBALS['color_switch'][$templateName]);
2062                 return 'switch_sw' . $GLOBALS['color_switch'][$templateName];
2063         } // END - if
2064 }
2065
2066 // Helper function for extension registration link
2067 function doTemplateExtensionRegistrationLink ($templateName, $clear, $ext_name) {
2068         // Default is all non-productive
2069         $OUT = '<div style="cursor:help" title="{%message,ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK_TITLE=' . $ext_name . '%}">{--ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK--}</div>';
2070
2071         // Is the given extension non-productive?
2072         if (isExtensionDeprecated($ext_name)) {
2073                 // Is deprecated
2074                 $OUT = '<span title="{--ADMIN_EXTENSION_IS_DEPRECATED_TITLE--}">---</span>';
2075         } elseif (isExtensionProductive($ext_name)) {
2076                 // Productive code
2077                 $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>';
2078         }
2079
2080         // Return code
2081         return $OUT;
2082 }
2083
2084 // Helper function to create bonus mail admin links
2085 function doTemplateAdminBonusMailLinks ($templateName, $clear, $bonusId) {
2086         // Call the inner function
2087         return generateAdminMailLinks('bid', $bonusId);
2088 }
2089
2090 // Helper function to create member mail admin links
2091 function doTemplateAdminMemberMailLinks ($templateName, $clear, $mailId) {
2092         // Call the inner function
2093         return generateAdminMailLinks('mid', $mailId);
2094 }
2095
2096 // Helper function to create a selection box for YES/NO configuration entries
2097 function doTemplateConfigurationYesNoSelectionBox ($templateName, $clear, $configEntry) {
2098         // Default is a "missing entry" warning
2099         $OUT = '<div class="bad" style="cursor:help" title="{%message,ADMIN_CONFIG_ENTRY_MISSING=' . $configEntry . '%}">!' . $configEntry . '!</div>';
2100
2101         // Generate the HTML code
2102         if (isConfigEntrySet($configEntry)) {
2103                 // Configuration entry is found
2104                 $OUT = '<select name="' . $configEntry . '" class="form_select" size="1">
2105 {%config,generateYesNoOptions=' . $configEntry . '%}
2106 </select>';
2107         } // END - if
2108
2109         // Return it
2110         return $OUT;
2111 }
2112
2113 // Helper function to create a selection box for YES/NO form fields
2114 function doTemplateYesNoSelectionBox ($templateName, $clear, $formField) {
2115         // Generate the HTML code
2116         $OUT = '<select name="' . $formField . '" class="form_select" size="1">
2117 {%pipe,generateYesNoOptions%}
2118 </select>';
2119
2120         // Return it
2121         return $OUT;
2122 }
2123
2124 // Helper function to create a selection box for YES/NO form fields, by NO is default
2125 function doTemplateNoYesSelectionBox ($templateName, $clear, $formField) {
2126         // Generate the HTML code
2127         $OUT = '<select name="' . $formField . '" class="form_select" size="1">
2128 {%pipe,generateYesNoOptions=N%}
2129 </select>';
2130
2131         // Return it
2132         return $OUT;
2133 }
2134
2135 // Helper function to add extra content for member area (module=login)
2136 function doTemplateMemberFooterExtras ($templateName, $clear) {
2137         // Is a member logged in?
2138         if (!isMember()) {
2139                 // This shall not happen
2140                 reportBug(__FUNCTION__, __LINE__, 'Please use this template helper only for logged-in members.');
2141         } // END - if
2142
2143         // Init filter data
2144         $filterData = array(
2145                 // Current user's id number
2146                 'userid'   => getMemberId(),
2147                 // Name of used template
2148                 'template' => $templateName,
2149                 // Target array for gathered data
2150                 '__data'   => array(),
2151                 // Where the HTML output will go
2152                 '__output' => '',
2153         );
2154
2155         // Run the filter chain
2156         $filterData = runFilterChain('member_footer_extras', $filterData);
2157
2158         // Return output
2159         return $filterData['__output'];
2160 }
2161
2162 /**
2163  * Helper function to determine whether current userid is set, if none is set,
2164  * return a zero, else an EL code is being returned as of this function is used
2165  * only in templates.
2166  *
2167  * @param       $templateName   Name of template (unused)
2168  * @param       $clear                  Wether to clear something (unused)
2169  * @return      $userId                 Wether zero or EL code snippet
2170  */
2171 function doTemplateUserId ($templateName, $clear) {
2172         // By default no userid is set
2173         $userId = '0';
2174
2175         // Is there a user id currently set?
2176         if (isCurrentUserIdSet()) {
2177                 // Then get the current user id
2178                 $userId = getCurrentUserId();
2179         } // END - if
2180
2181         // Return it
2182         return $userId;
2183 }
2184
2185 // Template helper function to generate "Terms&Conditions" link (EL code again)
2186 function doTemplateGetTermsConditionsLink ($templateName, $clear) {
2187         /*
2188          * Use default link by default ;-) This link, however, will become
2189          * deprecated once ext-terms is rolled out.
2190          */
2191         $linkCode = '{%url=modules.php?module=index&amp;what=agb%}';
2192
2193         // Is ext-terms installed?
2194         if (isExtensionInstalled('terms')) {
2195                 // Then use that link (only 'what' has changed)
2196                 $linkCode = '{%url=modules.php?module=index&amp;what=terms%}';
2197         } // END - if
2198
2199         // Return link (EL) code
2200         return $linkCode;
2201 }
2202
2203 // Template helper function to create selection box for "locked points mode"
2204 function doTemplatePointsLockedModeSelectionBox ($templateName, $clear = false, $default = NULL) {
2205         // Init array
2206         $lockedModes = array(
2207                 0 => array('mode' => 'LOCKED'),
2208                 1 => array('mode' => 'UNLOCKED'),
2209         );
2210
2211         // Handle it over to generateSelectionBoxFromArray()
2212         $content = generateSelectionBoxFromArray($lockedModes, 'points_locked_mode', 'mode', '', '', '', $default);
2213
2214         // Return prepared content
2215         return $content;
2216 }
2217
2218 // Template helper function to create selection box for payment method
2219 function doTemplatePointsPaymentMethodSelectionBox ($templateName, $clear = false, $default = NULL) {
2220         // Init array
2221         $paymentMethods = array(
2222                 0 => array('method' => 'DIRECT'),
2223                 1 => array('method' => 'REFERRAL'),
2224         );
2225
2226         // Handle it over to generateSelectionBoxFromArray()
2227         $content = generateSelectionBoxFromArray($paymentMethods, 'points_payment_method', 'method', '', '', '', $default);
2228
2229         // Return prepared content
2230         return $content;
2231 }
2232
2233 // Tries to anonymize some sensitive data (e.g. IP address, user agent, referrer, etc.)
2234 function anonymizeSensitiveData ($data) {
2235         // Trim it
2236         $data = trim($data);
2237
2238         // Is it empty?
2239         if (empty($data)) {
2240                 // Then add three dashes
2241                 $data = '---';
2242         } elseif (isUrlValid($data)) {
2243                 // Is a referrer, so is it black-listed?
2244                 if (isAdmin()) {
2245                         // Is admin, has always priority
2246                         $data = '[<a href="{%pipe,generateFrametesterUrl=' . $data . '%}" target="_blank">{--ADMIN_TEST_URL--}</a>]';
2247                 } elseif (isUrlBlacklisted($data)) {
2248                         // Yes, so replace it with text
2249                         $data = '<em>{--URL_IS_BLACKLISTED--}</em>';
2250                 } else {
2251                         // A  member is viewing this referral URL
2252                         $data = '[<a href="{%pipe,generateDereferrerUrl=' . $data . '%}" target="_blank">{--MEMBER_TEST_URL--}</a>]';
2253                 }
2254         } elseif (isIp4AddressValid($data)) {
2255                 // Is an IPv4 address
2256                 $ipArray = explode('.', $data);
2257
2258                 // Only display first 2 octets
2259                 $data = $ipArray[0] . '.' . $ipArray[1] . '.?.?';
2260         } else {
2261                 // Generic data
2262                 $data = '<em>{--DATA_IS_HIDDEN--}</em>';
2263         }
2264
2265         // Return it (hopefully) anonymized
2266         return $data;
2267 }
2268
2269 /**
2270  * Removes all commentd, tabs and new-line characters to compact the content
2271  *
2272  * @param       $uncompactedContent             The uncompacted content
2273  * @return      $compactedContent               The compacted content
2274  */
2275 function compactContent ($uncompactedContent) {
2276         // First, remove all tab/new-line/revert characters
2277         $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
2278
2279         // Then regex all comments like <!-- //--> away
2280         preg_match_all('/<!--[\w\W]*?(\/\/){0,1}-->/', $compactedContent, $matches);
2281
2282         // Do we have entries?
2283         if (isset($matches[0][0])) {
2284                 // Remove all
2285                 foreach ($matches[0] as $match) {
2286                         // Remove the match
2287                         $compactedContent = str_replace($match, '', $compactedContent);
2288                 } // END - foreach
2289         } // END - if
2290
2291         // Set the content again
2292         // @TODO Is this needed for e.g. $GLOBALS['template_content'] ? $this->setRawTemplateData($compactedContent);
2293
2294         // Return compacted content
2295         return $compactedContent;
2296 }
2297
2298 // [EOF]
2299 ?>