2 /************************************************************************
3 * Mailer v0.2.1-FINAL Start: 04/04/2009 *
4 * =================== Last change: 04/04/2009 *
6 * -------------------------------------------------------------------- *
7 * File : template-functions.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Template functions *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Template-Funktionen *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * -------------------------------------------------------------------- *
18 * Copyright (c) 2003 - 2009 by Roland Haeder *
19 * Copyright (c) 2009 - 2011 by Mailer Developer Team *
20 * For more information visit: http://www.mxchange.org *
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. *
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. *
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, *
36 ************************************************************************/
38 // Some security stuff...
39 if (!defined('__SECURITY')) {
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);
48 // Setter for 'is_template_html'
49 function enableTemplateHtml ($enable = true) {
50 $GLOBALS['is_template_html'] = (bool) $enable;
53 // Checks wether the template is HTML or not by previously set flag
55 function isTemplateHtml () {
56 // Is the output_mode other than 0 (HTML), then no comments are enabled
57 if (!isHtmlOutputMode()) {
62 return $GLOBALS['is_template_html'];
66 // Wrapper for writing debug informations to the browser
67 function debugOutput ($message) {
68 outputHtml('<div class="debug_message">' . $message . '</div>');
71 // "Fixes" an empty string into three dashes (use for templates)
72 function fixEmptyContentToDashes ($str) {
76 // Is the string empty?
86 function initTemplateColorSwitch ($template) {
87 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'INIT:' . $template);
88 $GLOBALS['color_switch'][$template] = 2;
91 // "Getter" for color switch code
92 function getColorSwitchCode ($template) {
94 $code = "{DQUOTE} . doTemplateColorSwitch('" . $template . "', false, false) . {DQUOTE}";
100 // Output HTML code directly or 'render' it. You addionally switch the new-line character off
101 function outputHtml ($htmlCode, $newLine = true) {
103 if (!isset($GLOBALS['output'])) {
104 $GLOBALS['output'] = '';
107 // Do we have HTML-Code here?
108 if (!empty($htmlCode)) {
109 // Yes, so we handle it as you have configured
110 switch (getOutputMode()) {
112 // That's why you don't need any \n at the end of your HTML code... :-)
113 if (getPhpCaching() == 'on') {
114 // Output into PHP's internal buffer
115 outputRawCode($htmlCode);
117 // That's why you don't need any \n at the end of your HTML code... :-)
118 if ($newLine === true) print("\n");
120 // Render mode for old or lame servers...
121 $GLOBALS['output'] .= $htmlCode;
123 // That's why you don't need any \n at the end of your HTML code... :-)
124 if ($newLine === true) $GLOBALS['output'] .= "\n";
129 // If we are switching from render to direct output rendered code
130 if ((!empty($GLOBALS['output'])) && (getPhpCaching() != 'on')) { outputRawCode($GLOBALS['output']); $GLOBALS['output'] = ''; }
132 // The same as above... ^
133 outputRawCode($htmlCode);
134 if ($newLine === true) print("\n");
138 // Huh, something goes wrong or maybe you have edited config.php ???
139 debug_report_bug(__FUNCTION__, __LINE__, '<strong>{--FATAL_ERROR--}:</strong> {--NO_RENDER_DIRECT--}');
142 } elseif ((getPhpCaching() == 'on') && ((!isset($GLOBALS['header'])) || (count($GLOBALS['header']) == 0))) {
143 // Output cached HTML code
144 $GLOBALS['output'] = ob_get_contents();
146 // Clear output buffer for later output if output is found
147 if (!empty($GLOBALS['output'])) {
151 // Send all HTTP headers
154 // Compile and run finished rendered HTML code
155 compileFinalOutput();
157 // Output code here, DO NOT REMOVE! ;-)
158 outputRawCode($GLOBALS['output']);
159 } elseif ((getOutputMode() == 'render') && (!empty($GLOBALS['output']))) {
160 // Send all HTTP headers
163 // Compile and run finished rendered HTML code
164 compileFinalOutput();
166 // Output code here, DO NOT REMOVE! ;-)
167 outputRawCode($GLOBALS['output']);
169 // And flush all headers
174 // Compiles the final output
175 function compileFinalOutput () {
176 // Add page header and footer
177 addPageHeaderFooter();
179 // Do the final compilation
180 $GLOBALS['output'] = doFinalCompilation($GLOBALS['output']);
182 // Extension 'rewrite' installed?
183 if ((isExtensionActive('rewrite')) && (!isCssOutputMode())) {
184 $GLOBALS['output'] = rewriteLinksInCode($GLOBALS['output']);
189 * @TODO On some pages this is buggy
190 if (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('gzip', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
191 // Compress it for HTTP gzip
192 $GLOBALS['output'] = gzencode($GLOBALS['output'], 9);
195 sendHeader('Content-Encoding: gzip');
196 } elseif (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('deflate', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
197 // Compress it for HTTP deflate
198 $GLOBALS['output'] = gzcompress($GLOBALS['output'], 9);
201 sendHeader('Content-Encoding: deflate');
206 sendHeader('Content-Length: ' . strlen($GLOBALS['output']));
212 // Main compilation loop
213 function doFinalCompilation ($code, $insertComments = true, $enableCodes = true) {
214 // Insert comments? (Only valid with HTML templates, of course)
215 enableTemplateHtml($insertComments);
221 while (((strpos($code, '{--') !== false) || (strpos($code, '{DQUOTE}') !== false) || (strpos($code, '{?') !== false) || (strpos($code, '{%') !== false)) && ($count < 7)) {
222 // Init common variables
227 //* DEBUG: */ debugOutput('<pre>'.linenumberCode($code).'</pre>');
228 $eval = '$newContent = "' . str_replace('{DQUOTE}', '"', compileCode(escapeQuotes($code), false, true, $enableCodes)) . '";';
229 //* DEBUG: */ if (!$insertComments) print('EVAL=<pre>'.linenumberCode($eval).'</pre>');
231 //* DEBUG: */ if (!$insertComments) print('NEW=<pre>'.linenumberCode($newContent).'</pre>');
232 //* DEBUG: */ die('<pre>'.encodeEntities($newContent).'</pre>');
234 // Was that eval okay?
235 if (empty($newContent)) {
236 // Something went wrong!
237 debug_report_bug(__FUNCTION__, __LINE__, 'Evaluation error:<pre>' . linenumberCode($eval) . '</pre>', false);
247 // Return the compiled code
251 // Output the raw HTML code
252 function outputRawCode ($htmlCode) {
253 // Output stripped HTML code to avoid broken JavaScript code, etc.
254 print(str_replace('{BACK}', "\\", $htmlCode));
256 // Flush the output if only getPhpCaching() is not 'on'
257 if (getPhpCaching() != 'on') {
263 // Load a template file and return it's content (only it's name; do not use ' or ")
264 function loadTemplate ($template, $return = false, $content = array(), $compileCode = true) {
265 // @TODO Remove this sanity-check if all is fine
266 if (!is_bool($return)) debug_report_bug(__FUNCTION__, __LINE__, 'return is not bool (' . gettype($return) . ')');
268 // Set current template
269 $GLOBALS['current_template'] = $template;
272 if ((!isDebuggingTemplateCache()) && (isTemplateCached($template))) {
273 // Evaluate the cache
274 eval(readTemplateCache($template));
275 } elseif (!isset($GLOBALS['template_eval'][$template])) {
276 // Make all template names lowercase
277 $template = strtolower($template);
283 $basePath = sprintf("%stemplates/%s/html/", getPath(), getLanguage());
284 $extraPath = detectExtraTemplatePath($template);
287 $FQFN = $basePath . $extraPath . $template . '.tpl';
289 // Does the special template exists?
290 if (!isFileReadable($FQFN)) {
291 // Reset to default template
292 $FQFN = $basePath . $template . '.tpl';
295 // Now does the final template exists?
296 if (isFileReadable($FQFN)) {
297 // Count the template load
298 incrementConfigEntry('num_templates');
300 // The local file does exists so we load it. :)
301 $GLOBALS['tpl_content'][$template] = readFromFile($FQFN);
303 // Do we have to compile the code?
305 if ((strpos($GLOBALS['tpl_content'][$template], '$') !== false) || (strpos($GLOBALS['tpl_content'][$template], '{--') !== false) || (strpos($GLOBALS['tpl_content'][$template], '{?') !== false) || (strpos($GLOBALS['tpl_content'][$template], '{%') !== false)) {
306 // Normal HTML output?
307 if (isHtmlOutputMode()) {
308 // Add surrounding HTML comments to help finding bugs faster
309 $ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'][$template] . '<!-- Template ' . $template . ' - End //-->';
311 // Prepare eval() command
312 $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileCode(escapeQuotes($ret), false, true, true, $compileCode) . '";';
313 } elseif (substr($template, 0, 3) == 'js_') {
314 // JavaScripts don't like entities and timings
315 $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['tpl_content'][$template]), false, true, true, $compileCode) . '");';
317 // Prepare eval() command, other output doesn't like entities, maybe
318 $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template]), false, true, true, $compileCode) . '");';
321 // Add surrounding HTML comments to help finding bugs faster
322 $ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'][$template] . '<!-- Template ' . $template . ' - End //-->';
323 $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileRawCode(escapeQuotes($ret), false, true, true, $compileCode) . '";';
325 } elseif ((isAdmin()) || ((isInstalling()) && (!isInstalled()))) {
326 // Only admins shall see this warning or when installation mode is active
327 $ret = '<div class="para">
328 <span class="notice">{--TEMPLATE_404--}</span>
334 {--TEMPLATE_CONTENT--}:
335 <pre>' . print_r($content, true) . '</pre>
339 $GLOBALS['template_eval'][$template] = '404';
344 if ((isset($GLOBALS['template_eval'][$template])) && ($GLOBALS['template_eval'][$template] != '404')) {
346 eval($GLOBALS['template_eval'][$template]);
349 // Do we have some content to output or return?
351 // Not empty so let's put it out! ;)
352 if ($return === true) {
353 // Return the HTML code
359 } elseif (isDebugModeEnabled()) {
360 // Warning, empty output!
361 return 'E:' . $template . ',content=<pre>' . print_r($content, true) . '</pre>';
365 // Detects the extra template path from given template name
366 function detectExtraTemplatePath ($template) {
371 if (!isset($GLOBALS['extra_path'][$template])) {
372 // Check for admin/guest/member/etc. templates
373 if (substr($template, 0, 6) == 'admin_') {
374 // Admin template found
375 $extraPath = 'admin/';
376 } elseif (substr($template, 0, 6) == 'guest_') {
377 // Guest template found
378 $extraPath = 'guest/';
379 } elseif (substr($template, 0, 7) == 'member_') {
380 // Member template found
381 $extraPath = 'member/';
382 } elseif (substr($template, 0, 7) == 'select_') {
383 // Selection template found
384 $extraPath = 'select/';
385 } elseif (substr($template, 0, 8) == 'install_') {
386 // Installation template found
387 $extraPath = 'install/';
388 } elseif (substr($template, 0, 4) == 'ext_') {
389 // Extension template found
391 } elseif (substr($template, 0, 3) == 'la_') {
392 // 'Logical-area' template found
394 } elseif (substr($template, 0, 3) == 'js_') {
395 // JavaScript template found
397 } elseif (substr($template, 0, 5) == 'menu_') {
398 // Menu template found
399 $extraPath = 'menu/';
401 // Test for extension
402 $test = substr($template, 0, strpos($template, '_'));
404 // Probe for valid extension name
405 if (isExtensionNameValid($test)) {
406 // Set extra path to extension's name
407 $extraPath = $test . '/';
412 $GLOBALS['extra_path'][$template] = $extraPath;
416 return $GLOBALS['extra_path'][$template];
419 // Loads an email template and compiles it
420 function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadUserData = true) {
423 // Make sure all template names are lowercase!
424 $template = strtolower($template);
426 // Is content an array?
427 if (is_array($content)) {
428 // Add expiration to array
429 if ((isConfigEntrySet('auto_purge')) && (getAutoPurge() == '0')) {
430 // Will never expire!
431 $content['expiration'] = '{--MAIL_WILL_NEVER_EXPIRE--}';
432 } elseif (isConfigEntrySet('auto_purge')) {
433 // Create nice date string
434 $content['expiration'] = '{%config,createFancyTime=auto_purge%}';
437 $content['expiration'] = '{--MAIL_NO_CONFIG_AUTO_PURGE--}';
442 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UID={$userid},template={$template},content[]=".gettype($content));
443 if ((isValidUserId($userid)) && (is_array($content))) {
444 // If nickname extension is installed, fetch nickname as well
445 if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
447 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NICKNAME!<br />");
448 fetchUserData($userid, 'nickname');
449 } elseif (isNicknameUsed($userid)) {
450 // Non-number characters entered but no ext-nickname found
451 debug_report_bug(__FUNCTION__, __LINE__, 'userid=' . $userid . ': is no id number and ext-nickname is gone.');
454 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NO-NICK!<br />");
455 fetchUserData($userid);
458 // Merge data if valid
459 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - PRE<br />");
460 if ((isUserDataValid()) && ($loadUserData === true)) {
462 $content = merge_array($content, getUserDataArray());
464 // But we don't like hashed passwords be mailed
465 unset($content['password']);
468 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - AFTER<br />");
472 $basePath = sprintf("%stemplates/%s/emails/", getPath(), getLanguage());
475 $extraPath = detectExtraTemplatePath($template);
477 // Generate full FQFN
478 $FQFN = $basePath . $extraPath . $template . '.tpl';
480 // Does the special template exists?
481 if (!isFileReadable($FQFN)) {
482 // Reset to default template
483 $FQFN = $basePath . $template . '.tpl';
486 // Now does the final template exists?
488 if (isFileReadable($FQFN)) {
489 // The local file does exists so we load it. :)
490 $GLOBALS['tpl_content'][$template] = readFromFile($FQFN);
493 $GLOBALS['tpl_content'][$template] = '$newContent = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template])) . '");';
494 eval($GLOBALS['tpl_content'][$template]);
495 } elseif (!empty($template)) {
496 // Template file not found
497 $newContent = '<div class="para">
498 {--TEMPLATE_404--}: ' . $template . '
501 {--TEMPLATE_CONTENT--}:
502 <pre>' . print_r($content, true) . '</pre>
504 <pre>' . print_r($DATA, true) . '</pre>
507 // Debug mode not active? Then remove the HTML tags
508 if (!isDebugModeEnabled()) {
510 $newContent = secureString($newContent);
513 // No template name supplied!
514 $newContent = '{--NO_TEMPLATE_SUPPLIED--}';
517 // Is there some content?
518 if (empty($newContent)) {
520 $newContent = "Compiler error for template " . $template . " !\nUncompiled content:\n" . $GLOBALS['tpl_content'][$template];
522 // Add last error if the required function exists
523 if (function_exists('error_get_last')) $newContent .= "\n--------------------------------------\nDebug:\n".print_r(error_get_last(), true)."--------------------------------------\nPlease don't alter these informations!\nThanx.";
526 // Remove content and data
534 // "Getter" for menu CSS classes, mainly used in templates
535 function getMenuCssClasses ($data) {
536 // $data needs to be converted into an array
537 $content = explode('|', $data);
539 // Non-existent index 2 will happen in menu blocks
540 if (!isset($content[2])) $content[2] = '';
542 // Re-construct the array: 0=visible,1=locked,2=prefix
543 $content['visible'] = $content[0];
544 $content['locked'] = $content[1];
546 // Call our "translator" function
547 $content = translateMenuVisibleLocked($content, $content[2]);
549 // Return CSS classes
550 return ($content['visible_css'] . ' ' . $content['locked_css']);
553 // Generate XHTML code for the CAPTCHA
554 function generateCaptchaCode ($code, $type, $type, $userid) {
555 return '<img border="0" alt="Code ' . $code . '" src="{%url=mailid_top.php?userid=' . $userid . '&' . $type . '=' . $type . '&mode=img&code=' . $code . '%}" />';
558 // Compiles the given HTML/mail code
559 function compileCode ($code, $simple = false, $constants = true, $full = true, $compileCode = true) {
560 // Is the code a string or should we not compile?
561 if ((!is_string($code)) || ($compileCode === false)) {
562 // Silently return it
567 $startCompile = microtime(true);
570 $code = compileRawCode($code, $simple, $constants, $full);
573 $compiled = microtime(true);
575 // Add timing if enabled
576 if (isTemplateHtml()) {
577 // Add timing, this should be disabled in
578 $code .= '<!-- Compilation time: ' . (($compiled - $startCompile) * 1000). 'ms //-->';
581 // Return compiled code
585 // Compiles the code (use compileCode() only for HTML because of the comments)
586 // @TODO $simple/$constants are deprecated
587 function compileRawCode ($code, $simple = false, $constants = true, $full = true, $compileCode = true) {
588 // Is the code a string or shall we not compile?
589 if ((!is_string($code)) || ($compileCode === false)) {
590 // Silently return it
594 // Init replacement-array with smaller set of security characters
595 $secChars = $GLOBALS['url_chars'];
597 // Select full set of chars to replace when we e.g. want to compile URLs
598 if ($full === true) {
599 $secChars = $GLOBALS['security_chars'];
602 // Compile more through a filter
603 $code = runFilterChain('compile_code', $code);
605 // Compile message strings
606 $code = str_replace('{--', '{%message,', str_replace('--}', '%}', $code));
608 // Compile QUOT and other non-HTML codes
609 $code = str_replace($secChars['to'], $secChars['from'], $code);
611 // Find $content[bla][blub] entries
612 // @TODO Do only use $content and deprecate $GLOBALS and $DATA in templates
613 preg_match_all('/\$(content|GLOBALS|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
615 // Are some matches found?
616 if ((count($matches) > 0) && (count($matches[0]) > 0)) {
617 // Replace all matches
618 $matchesFound = array();
619 foreach ($matches[0] as $key => $match) {
620 // Fuzzy look has failed by default
623 // Fuzzy look on match if already found
624 foreach ($matchesFound as $found => $set) {
626 $test = substr($found, 0, strlen($match));
628 // Does this entry exist?
629 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "found={$found},match={$match},set={$set}<br />");
630 if ($test == $match) {
632 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "fuzzyFound!<br />");
639 if ($fuzzyFound === true) continue;
641 // Take all string elements
642 if ((is_string($matches[4][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key.'_' . $matches[4][$key]]))) {
643 // Replace it in the code
644 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "key={$key},match={$match}<br />");
645 $newMatch = str_replace('[', "['", str_replace(']', "']", $match));
646 $code = str_replace($match, '".' . $newMatch . '."', $code);
647 $matchesFound[$key . '_' . $matches[4][$key]] = 1;
648 $matchesFound[$match] = 1;
649 } elseif (!isset($matchesFound[$match])) {
651 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "match={$match}<br />");
652 $code = str_replace($match, '".' . $match . '."', $code);
653 $matchesFound[$match] = 1;
663 function addSelectionBox ($type, $default, $prefix = '', $id = '0', $class = 'form_select') {
667 // This is a yes/no selection only!
668 if ($id > 0) $prefix .= '[' . $id . ']';
669 $OUT .= '<select name="' . $prefix . '" class="' . $class . '" size="1">';
671 // Begin with regular selection box here
672 if (!empty($prefix)) $prefix .= '_';
674 if ($id > 0) $type2 .= '[' . $id . ']';
675 $OUT .= '<select name="' . strtolower($prefix . $type2) . '" class="' . $class . '" size="1">';
680 for ($idx = 1; $idx < 32; $idx++) {
681 $OUT .= '<option value="' . $idx . '"';
682 if ($default == $idx) $OUT .= ' selected="selected"';
683 $OUT .= '>' . $idx . '</option>';
687 case 'month': // Month
688 foreach ($GLOBALS['month_descr'] as $idx => $descr) {
689 $OUT .= '<option value="' . $idx . '"';
690 if ($default == $idx) $OUT .= ' selected="selected"';
691 $OUT .= '>' . $descr . '</option>';
699 // Use configured min age or fixed?
700 if (isExtensionInstalledAndNewer('other', '0.2.1')) {
702 $startYear = $year - getConfig('min_age');
705 $startYear = $year - 16;
708 // Calculate earliest year (100 years old people can still enter Internet???)
709 $minYear = $year - 100;
711 // Check if the default value is larger than minimum and bigger than actual year
712 if (($default > $minYear) && ($default >= $year)) {
713 for ($idx = $year; $idx < ($year + 11); $idx++) {
714 $OUT .= '<option value="' . $idx . '"';
715 if ($default == $idx) $OUT .= ' selected="selected"';
716 $OUT .= '>' . $idx . '</option>';
718 } elseif ($default == -1) {
719 // Current year minus 1
720 for ($idx = $startYear; $idx <= ($year + 1); $idx++) {
721 $OUT .= '<option value="' . $idx . '">' . $idx . '</option>';
724 // Get current year and subtract the configured minimum age
725 $OUT .= '<option value="' . ($minYear - 1) . '"><' . $minYear . '</option>';
726 // Calculate earliest year depending on extension version
727 if (isExtensionInstalledAndNewer('other', '0.2.1')) {
728 // Use configured minimum age
729 $year = getYear() - getConfig('min_age');
731 // Use fixed 16 years age
732 $year = getYear() - 16;
735 // Construct year selection list
736 for ($idx = $minYear; $idx <= $year; $idx++) {
737 $OUT .= '<option value="' . $idx . '"';
738 if ($default == $idx) $OUT .= ' selected="selected"';
739 $OUT .= '>' . $idx . '</option>';
746 for ($idx = 0; $idx < 60; $idx+=5) {
747 if (strlen($idx) == 1) $idx = '0' . $idx;
748 $OUT .= '<option value="' . $idx . '"';
749 if ($default == $idx) $OUT .= ' selected="selected"';
750 $OUT .= '>' . $idx . '</option>';
755 for ($idx = 0; $idx < 24; $idx++) {
756 if (strlen($idx) == 1) $idx = '0' . $idx;
757 $OUT .= '<option value="' . $idx . '"';
758 if ($default == $idx) $OUT .= ' selected="selected"';
759 $OUT .= '>' . $idx . '</option>';
764 $OUT .= '<option value="Y"';
765 if ($default == 'Y') $OUT .= ' selected="selected"';
766 $OUT .= '>{--YES--}</option><option value="N"';
767 if ($default != 'Y') $OUT .= ' selected="selected"';
768 $OUT .= '>{--NO--}</option>';
775 // Insert the code in $img_code into jpeg or PNG image
776 function generateImageOrCode ($img_code, $headerSent = true) {
777 // Is the code size oversized or shouldn't we display it?
778 if ((strlen($img_code) > 6) || (empty($img_code)) || (getCodeLength() == '0')) {
779 // Stop execution of function here because of over-sized code length
780 debug_report_bug(__FUNCTION__, __LINE__, 'img_code ' . $img_code .' has invalid length. img_code()=' . strlen($img_code) . ' code_length=' . getCodeLength());
781 } elseif ($headerSent === false) {
782 // Return an HTML code here
783 return '<img src="{%url=img.php?code=' . $img_code . '%}" alt="Image" />';
787 $img = sprintf("%s/theme/%s/images/code_bg.%s",
794 if (isFileReadable($img)) {
796 switch (getImgType()) {
797 case 'jpg': // Okay, load image and hide all errors
798 $image = imagecreatefromjpeg($img);
801 case 'png': // Okay, load image and hide all errors
802 $image = imagecreatefrompng($img);
806 // Silently log the error
807 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File for image-type %s in theme %s not found.", getImgType(), getCurrentTheme()));
811 // Generate text color (red/green/blue; 0 = dark, 255 = bright)
812 $text_color = imagecolorallocate($image, 0, 0, 0);
814 // Insert code into image
815 imagestring($image, 5, 14, 2, $img_code, $text_color);
818 setContentType('image/' . getImgType());
820 // Output image with matching image factory
821 switch (getImgType()) {
822 case 'jpg': imagejpeg($image); break;
823 case 'png': imagepng($image); break;
826 // Remove image from memory
827 imagedestroy($image);
830 // Create selection box or array of splitted timestamp
831 function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $return_array=false) {
832 // Do not continue if ONE_DAY is absend
833 if (!isConfigEntrySet('ONE_DAY')) {
834 // And return the timestamp itself or empty array
835 if ($return_array === true) {
842 // Calculate 2-seconds timestamp
843 $stamp = round($timestamp);
844 //* DEBUG: */ debugOutput('*' . $stamp .'/' . $timestamp . '*');
846 // Do we have a leap year?
848 $TEST = getYear() / 4;
850 $M2 = getMonth(time() + $timestamp);
852 // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
853 if ((floor($TEST) == $TEST) && ($M1 == '02') && ($M2 > '02')) {
854 $SWITCH = getOneDay();
857 // First of all years...
858 $Y = abs(floor($timestamp / (31536000 + $SWITCH)));
859 //* DEBUG: */ debugOutput('Y=' . $Y);
861 $M = abs(floor($timestamp / 2628000 - $Y * 12));
862 //* DEBUG: */ debugOutput('M=' . $M);
864 $W = abs(floor($timestamp / 604800 - $Y * ((365 + $SWITCH / getOneDay()) / 7) - ($M / 12 * (365 + $SWITCH / getOneDay()) / 7)));
865 //* DEBUG: */ debugOutput('W=' . $W);
867 $D = abs(floor($timestamp / 86400 - $Y * (365 + $SWITCH / getOneDay()) - ($M / 12 * (365 + $SWITCH / getOneDay())) - $W * 7));
868 //* DEBUG: */ debugOutput('D=' . $D);
870 $h = abs(floor($timestamp / 3600 - $Y * (365 + $SWITCH / getOneDay()) * 24 - ($M / 12 * (365 + $SWITCH / getOneDay()) * 24) - $W * 7 * 24 - $D * 24));
871 //* DEBUG: */ debugOutput('h=' . $h);
873 $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));
874 //* DEBUG: */ debugOutput('m=' . $m);
875 // And at last seconds...
876 $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));
877 //* DEBUG: */ debugOutput('s=' . $s);
879 // Is seconds zero and time is < 60 seconds?
880 if (($s == '0') && ($timestamp < 60)) {
882 $s = round($timestamp);
886 // Now we convert them in seconds...
889 // Just put all data in an array for later use
901 $OUT = '<div align="' . $align . '">';
902 $OUT .= '<table border="0" cellspacing="0" cellpadding="0" class="timebox_table dashed">';
905 if (isInString('Y', $display) || (empty($display))) {
906 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_YEARS--}</strong></td>';
909 if (isInString('M', $display) || (empty($display))) {
910 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MONTHS--}</strong></td>';
913 if (isInString('W', $display) || (empty($display))) {
914 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_WEEKS--}</strong></td>';
917 if (isInString('D', $display) || (empty($display))) {
918 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_DAYS--}</strong></td>';
921 if (isInString('h', $display) || (empty($display))) {
922 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_HOURS--}</strong></td>';
925 if (isInString('m', $display) || (empty($display))) {
926 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MINUTES--}</strong></td>';
929 if (isInString('s', $display) || (empty($display))) {
930 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_SECONDS--}</strong></td>';
936 if (isInString('Y', $display) || (empty($display))) {
937 // Generate year selection
938 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ye" size="1">';
939 for ($idx = 0; $idx <= 10; $idx++) {
940 $OUT .= '<option class="mini_select" value="' . $idx . '"';
941 if ($idx == $Y) $OUT .= ' selected="selected"';
942 $OUT .= '>' . $idx . '</option>';
944 $OUT .= '</select></td>';
946 $OUT .= '<input type="hidden" name="' . $prefix . '_ye" value="0" />';
949 if (isInString('M', $display) || (empty($display))) {
950 // Generate month selection
951 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mo" size="1">';
952 for ($idx = 0; $idx <= 11; $idx++) {
953 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
954 if ($idx == $M) $OUT .= ' selected="selected"';
955 $OUT .= '>' . $idx . '</option>';
957 $OUT .= '</select></td>';
959 $OUT .= '<input type="hidden" name="' . $prefix . '_mo" value="0" />';
962 if (isInString('W', $display) || (empty($display))) {
963 // Generate week selection
964 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_we" size="1">';
965 for ($idx = 0; $idx <= 4; $idx++) {
966 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
967 if ($idx == $W) $OUT .= ' selected="selected"';
968 $OUT .= '>' . $idx . '</option>';
970 $OUT .= '</select></td>';
972 $OUT .= '<input type="hidden" name="' . $prefix . '_we" value="0" />';
975 if (isInString('D', $display) || (empty($display))) {
976 // Generate day selection
977 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_da" size="1">';
978 for ($idx = 0; $idx <= 31; $idx++) {
979 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
980 if ($idx == $D) $OUT .= ' selected="selected"';
981 $OUT .= '>' . $idx . '</option>';
983 $OUT .= '</select></td>';
985 $OUT .= '<input type="hidden" name="' . $prefix . '_da" value="0" />';
988 if (isInString('h', $display) || (empty($display))) {
989 // Generate hour selection
990 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ho" size="1">';
991 for ($idx = 0; $idx <= 23; $idx++) {
992 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
993 if ($idx == $h) $OUT .= ' selected="selected"';
994 $OUT .= '>' . $idx . '</option>';
996 $OUT .= '</select></td>';
998 $OUT .= '<input type="hidden" name="' . $prefix . '_ho" value="0" />';
1001 if (isInString('m', $display) || (empty($display))) {
1002 // Generate minute selection
1003 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mi" size="1">';
1004 for ($idx = 0; $idx <= 59; $idx++) {
1005 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
1006 if ($idx == $m) $OUT .= ' selected="selected"';
1007 $OUT .= '>' . $idx . '</option>';
1009 $OUT .= '</select></td>';
1011 $OUT .= '<input type="hidden" name="' . $prefix . '_mi" value="0" />';
1014 if (isInString('s', $display) || (empty($display))) {
1015 // Generate second selection
1016 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_se" size="1">';
1017 for ($idx = 0; $idx <= 59; $idx++) {
1018 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
1019 if ($idx == $s) $OUT .= ' selected="selected"';
1020 $OUT .= '>' . $idx . '</option>';
1022 $OUT .= '</select></td>';
1024 $OUT .= '<input type="hidden" name="' . $prefix . '_se" value="0" />';
1031 // Return generated HTML code
1035 // Generate a list of administrative links to a given userid
1036 function generateMemberAdminActionLinks ($userid) {
1037 // Make sure userid is a number
1038 if ($userid != bigintval($userid)) {
1039 debug_report_bug(__FUNCTION__, __LINE__, 'userid is not a number!');
1042 // Define all main targets
1043 $targetArray = array('del_user', 'edit_user', 'lock_user', 'add_points', 'sub_points');
1046 $status = getFetchedUserData('userid', $userid, 'status');
1048 // Begin of navigation links
1051 foreach ($targetArray as $tar) {
1052 $OUT .= '<span class="admin_user_link"><a href="{%url=modules.php?module=admin&what=' . $tar . '&userid=' . $userid . '%}" title="{--ADMIN_USER_ACTION_LINK_';
1053 //* DEBUG: */ debugOutput('*' . $tar.'/' . $status.'*');
1054 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
1055 // Locked accounts shall be unlocked
1056 $OUT .= 'UNLOCK_USER';
1057 } elseif ($tar == 'del_user') {
1058 // @TODO Deprecate this thing
1059 $OUT .= 'DELETE_USER';
1061 // All other status is fine
1062 $OUT .= strtoupper($tar);
1064 $OUT .= '_TITLE--}">{--ADMIN_USER_ACTION_LINK_';
1065 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
1066 // Locked accounts shall be unlocked
1067 $OUT .= 'UNLOCK_USER';
1068 } elseif ($tar == 'del_user') {
1069 // @TODO Deprecate this thing
1070 $OUT .= 'DELETE_USER';
1072 // All other status is fine
1073 $OUT .= strtoupper($tar);
1075 $OUT .= '--}</a></span>|';
1078 // Add special link, in case of the account is unconfirmed
1079 if ($status == 'UNCONFIRMED') {
1081 $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>|';
1084 // Finish navigation link
1085 $OUT = substr($OUT, 0, -1) . ']';
1091 // Generate an email link
1092 function generateEmailLink ($email, $table = 'admins') {
1093 // Default email link (INSECURE! Spammer can read this by harvester programs)
1094 $EMAIL = 'mailto:' . $email;
1096 // Check for several extensions
1097 if ((isExtensionActive('admins')) && ($table == 'admins')) {
1098 // Create email link for contacting admin in guest area
1099 $EMAIL = generateAdminEmailLink($email);
1100 } elseif ((isExtensionInstalledAndNewer('user', '0.3.3')) && ($table == 'user_data')) {
1101 // Create email link for contacting a member within admin area (or later in other areas, too?)
1102 $EMAIL = generateUserEmailLink($email);
1103 } elseif ((isExtensionActive('sponsor')) && ($table == 'sponsor_data')) {
1104 // Create email link to contact sponsor within admin area (or like the link above?)
1105 $EMAIL = generateSponsorEmailLink($email);
1108 // Shall I close the link when there is no admin?
1109 if ((!isAdmin()) && ($EMAIL == $email)) $EMAIL = '#'; // Closed!
1111 // Return email link
1115 // Output error messages in a fasioned way and die...
1116 function app_die ($F, $L, $message) {
1117 // Check if Script is already dieing and not let it kill itself another 1000 times
1118 if (isset($GLOBALS['app_died'])) {
1119 // Script tried to kill itself twice
1120 die('[' . __FUNCTION__ . ':' . __LINE__ . ']: Script wanted to kill itself more than once! Raw message=' . $message . ', file/function=' . $F . ', line=' . $L);
1123 // Make sure, that the script realy realy diese here and now
1124 $GLOBALS['app_died'] = true;
1126 // Set content type as text/html
1127 setContentType('text/html');
1130 loadIncludeOnce('inc/header.php');
1132 // Rewrite message for output
1133 $message = sprintf(getMessage('MAILER_HAS_DIED'), basename($F), $L, $message);
1135 // Load the message template
1136 loadTemplate('app_die_message', false, $message);
1139 loadIncludeOnce('inc/footer.php');
1142 // Display parsing time and number of SQL queries in footer
1143 function displayParsingTime () {
1144 // Is the timer started?
1145 if (!isset($GLOBALS['startTime'])) {
1151 $endTime = microtime(true);
1153 // "Explode" both times
1154 $start = explode(' ', $GLOBALS['startTime']);
1155 $end = explode(' ', $endTime);
1156 $runTime = $end[0] - $start[0];
1162 // @TODO This can be easily moved out after the merge from EL branch to this is complete
1164 'run_time' => $runTime,
1165 'sql_time' => (getConfig('sql_time') * 1000),
1168 // Load the template
1169 $GLOBALS['page_footer'] .= loadTemplate('show_timings', true, $content);
1172 // Output a debug backtrace to the user
1173 function debug_report_bug ($F, $L, $message = '', $sendEmail = true) {
1174 // Is this already called?
1175 if (isset($GLOBALS[__FUNCTION__])) {
1177 print 'Message:' . $message . '<br />Backtrace:<pre>';
1178 debug_print_backtrace();
1182 // Set this function as called
1183 $GLOBALS[__FUNCTION__] = true;
1188 // Is the optional message set?
1189 if (!empty($message)) {
1191 $debug = sprintf("Note: %s<br />\n",
1195 // @TODO Add a little more infos here
1196 logDebugMessage($F, $L, strip_tags($message));
1200 $debug .= 'Please report this bug at <a title="Direct link to the bug-tracker" href="http://bugs.mxchange.org" rel="external" target="_blank">http://bugs.mxchange.org</a> and include the logfile from <strong>' . str_replace(getPath(), '', getCachePath()) . 'debug.log</strong> in your report (you can now attach files):<pre>';
1201 $debug .= debug_get_printable_backtrace();
1203 $debug .= '<div class="para">Request-URI: ' . getRequestUri() . '</div>';
1204 $debug .= '<div class="para">Thank you for finding bugs.</div>';
1206 // Send an email? (e.g. not wanted for evaluation errors)
1207 if (($sendEmail === true) && (!isInstallationPhase())) {
1210 'message' => trim($message),
1211 'backtrace' => trim(debug_get_mailable_backtrace())
1214 // Send email to webmaster
1215 sendAdminNotification('{--DEBUG_REPORT_BUG_SUBJECT--}', 'admin_report_bug', $content);
1219 app_die($F, $L, $debug);
1222 // Compile characters which are allowed in URLs
1223 function compileUriCode ($code, $simple = true) {
1224 // Compile constants
1225 if ($simple === false) $code = str_replace('{--', '".', str_replace('--}', '."', $code));
1227 // Compile QUOT and other non-HTML codes
1228 $code = str_replace('{DOT}', '.',
1229 str_replace('{SLASH}', '/',
1230 str_replace('{QUOT}', "'",
1231 str_replace('{DOLLAR}', '$',
1232 str_replace('{OPEN_ANCHOR}', '(',
1233 str_replace('{CLOSE_ANCHOR}', ')',
1234 str_replace('{OPEN_SQR}', '[',
1235 str_replace('{CLOSE_SQR}', ']',
1236 str_replace('{PER}', '%',
1240 // Return compiled code
1244 // Handle message codes from URL
1245 function handleCodeMessage () {
1246 if (isGetRequestParameterSet('code')) {
1247 // Default extension is 'unknown'
1250 // Is extension given?
1251 if (isGetRequestParameterSet('ext')) {
1252 $ext = getRequestParameter('ext');
1255 // Convert the 'code' parameter from URL to a human-readable message
1256 $message = getMessageFromErrorCode(getRequestParameter('code'));
1258 // Load message template
1259 loadTemplate('message', false, $message);
1263 // Generates a 'extension foo out-dated' message
1264 function generateExtensionOutdatedMessage ($ext_name, $ext_ver) {
1265 // Is the extension empty?
1266 if (empty($ext_name)) {
1267 // This should not happen
1268 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1272 $message = '{%message,EXTENSION_PROBLEM_EXTENSION_OUTDATED=' . $ext_name . '%}';
1274 // Is an admin logged in?
1276 // Then output admin message
1277 $message = sprintf(getMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE'), $ext_name, $ext_name, $ext_ver);
1280 // Return prepared message
1284 // Generates a 'extension foo inactive' message
1285 function generateExtensionInactiveMessage ($ext_name) {
1286 // Is the extension empty?
1287 if (empty($ext_name)) {
1288 // This should not happen
1289 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1293 $message = '{%message,EXTENSION_PROBLEM_EXTENSION_INACTIVE=' . $ext_name . '%}';
1295 // Is an admin logged in?
1297 // Then output admin message
1298 $message = '{%message,ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE=' . $ext_name . '%}';
1301 // Return prepared message
1305 // Generates a 'extension foo not installed' message
1306 function generateExtensionNotInstalledMessage ($ext_name) {
1307 // Is the extension empty?
1308 if (empty($ext_name)) {
1309 // This should not happen
1310 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1314 $message = '{%message,EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED=' . $ext_name . '%}';
1316 // Is an admin logged in?
1318 // Then output admin message
1319 $message = '{%message,ADMIN_EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED=' . $ext_name . '%}';
1322 // Return prepared message
1326 // Generates a message depending on if the extension is not installed or not
1328 function generateExtensionInactiveNotInstalledMessage ($ext_name) {
1332 // Is the extension not installed or just deactivated?
1333 switch (isExtensionInstalled($ext_name)) {
1334 case true; // Deactivated!
1335 $message = generateExtensionInactiveMessage($ext_name);
1338 case false; // Not installed!
1339 $message = generateExtensionNotInstalledMessage($ext_name);
1342 default: // Should not happen!
1343 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid state of extension %s detected.", $ext_name));
1344 $message = sprintf("Invalid state of extension %s detected.", $ext_name);
1348 // Return the message
1352 // Print code with line numbers
1353 function linenumberCode ($code) {
1354 if (!is_array($code)) $codeE = explode("\n", $code); else $codeE = $code;
1355 $count_lines = count($codeE);
1357 $r = 'Line | Code:<br />';
1358 foreach ($codeE as $line => $c) {
1359 $r .= '<div class="line"><span class="linenum">';
1360 if ($count_lines == 1) {
1363 $r .= ($line == ($count_lines - 1)) ? '' : ($line+1);
1368 $r .= '<span class="linetext">' . encodeEntities($c) . '</span></div>';
1371 return '<div class="code">' . $r . '</div>';
1374 // Determines the right page title
1375 function determinePageTitle () {
1376 // Config and database connection valid?
1377 if ((isConfigLocalLoaded()) && (isConfigurationLoaded()) && (SQL_IS_LINK_UP()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1381 // Title decoration enabled?
1382 if ((isTitleDecorationEnabled()) && (getConfig('title_left') != '')) $TITLE .= trim(getConfig('title_left')) . ' ';
1384 // Do we have some extra title?
1385 if (isExtraTitleSet()) {
1387 $TITLE .= getExtraTitle() . ' by ';
1391 $TITLE .= getMainTitle();
1393 // Add title of module? (middle decoration will also be added!)
1394 if ((isModuleTitleEnabled()) || ((!isWhatSet()) && (!isActionSet())) || (getModule() == 'admin')) {
1395 $TITLE .= ' ' . trim(getConfig('title_middle')) . ' {DQUOTE} . getModuleTitle(getModule()) . {DQUOTE}';
1398 // Add title from what file
1400 if (getModule() == 'login') $mode = 'member';
1401 elseif (getModule() == 'index') $mode = 'guest';
1402 if ((!empty($mode)) && (isWhatTitleEnabled())) $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu($mode, getWhat());
1404 // Add title decorations? (right)
1405 if ((isTitleDecorationEnabled()) && (getConfig('title_right') != '')) $TITLE .= ' ' . trim(getConfig('title_right'));
1407 // Remember title in constant for the template
1408 $pageTitle = $TITLE;
1409 } elseif ((isInstalled()) && (isAdminRegistered())) {
1410 // Installed, admin registered but no ext-sql_patches
1411 $pageTitle = '[-- ' . getMainTitle() . ' - ' . getModuleTitle(getModule()) . ' --]';
1412 } elseif ((isInstalled()) && (!isAdminRegistered())) {
1413 // Installed but no admin registered
1414 $pageTitle = '{--INSTALLER_OF_MAILER_NO_ADMIN--}';
1415 } elseif ((!isInstalled()) || (!isAdminRegistered())) {
1416 // Installation mode
1417 $pageTitle = '{--INSTALLER_OF_MAILER--}';
1419 // Configuration not found
1420 $pageTitle = '{--NO_CONFIG_FOUND_TITLE--}';
1422 // Do not add the fatal message in installation mode
1423 if ((!isInstalling()) && (!isConfigurationLoaded())) addFatalMessage(__FUNCTION__, __LINE__, '{--NO_CONFIG_FOUND--}');
1427 return decodeEntities($pageTitle);
1430 // Checks wethere there is a cache file there. This function is cached.
1431 function isTemplateCached ($template) {
1432 // Do we have cached this result?
1433 if (!isset($GLOBALS['template_cache'][$template])) {
1435 $FQFN = generateCacheFqfn($template);
1438 $GLOBALS['template_cache'][$template] = isFileReadable($FQFN);
1442 return $GLOBALS['template_cache'][$template];
1445 // Flushes non-flushed template cache to disk
1446 function flushTemplateCache ($template, $eval) {
1447 // Is this cache flushed?
1448 if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template) === false) && ($eval != '404')) {
1450 $FQFN = generateCacheFqfn($template);
1453 writeToFile($FQFN, $eval, true);
1457 // Reads a template cache
1458 function readTemplateCache ($template) {
1460 if ((isDebuggingTemplateCache()) || (!isTemplateCached($template))) {
1461 // This should not happen
1462 debug_report_bug('Wether debugging of template cache is enabled or template ' . $template . ' is not cached while expected.');
1466 if (!isset($GLOBALS['template_eval'][$template])) {
1468 $FQFN = generateCacheFqfn($template);
1471 $GLOBALS['template_eval'][$template] = readFromFile($FQFN);
1475 return $GLOBALS['template_eval'][$template];
1478 // Escapes quotes (default is only double-quotes)
1479 function escapeQuotes ($str, $single = false) {
1480 // Should we escape all?
1481 if ($single === true) {
1482 // Escape all (including null)
1483 $str = addslashes($str);
1485 // Remove escaping of single quotes
1486 $str = str_replace("\\'", "'", $str);
1488 // Escape only double-quotes but prevent double-quoting
1489 $str = str_replace("\\\\", "\\", str_replace('"', "\\\"", $str));
1492 // Return the escaped string
1496 // Escapes the JavaScript code, prevents \r and \n becoming char 10/13
1497 function escapeJavaScriptQuotes ($str) {
1498 // Replace all double-quotes and secure back-ticks
1499 $str = str_replace('"', '\"', str_replace("\\", '{BACK}', $str));
1505 // Send out mails depending on the 'mod/modes' combination
1506 // @TODO Lame description for this function
1507 function sendModeMails ($mod, $modes) {
1509 $content = array ();
1512 if (fetchUserData(getMemberId())) {
1513 // Extract salt from cookie
1514 $salt = substr(getSession('u_hash'), 0, -40);
1516 // Now let's compare passwords
1517 $hash = encodeHashForCookie(getUserData('password'));
1519 // Does the hash match or should we change it?
1520 if (($hash == getSession('u_hash')) || (postRequestParameter('pass1') == postRequestParameter('pass2'))) {
1522 $content = getUserDataArray();
1524 // Clear/init the content variable
1525 $content['message'] = '';
1528 // @TODO Move this in a filter
1531 foreach ($modes as $mode) {
1533 case 'normal': break; // Do not add any special lines
1534 case 'email': // Email was changed!
1535 $content['message'] = '{--MEMBER_CHANGED_EMAIL--}' . ': ' . postRequestParameter('old_email') . "\n";
1538 case 'password': // Password was changed
1539 $content['message'] = '{--MEMBER_CHANGED_PASS--}' . "\n";
1543 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown mode %s detected.", $mode));
1544 $content['message'] = '{--MEMBER_UNKNOWN_MODE--}' . ': ' . $mode . "\n\n";
1549 if (isExtensionActive('country')) {
1550 // Replace code with description
1551 $content['country'] = generateCountryInfo(postRequestParameter('country_code'));
1554 // Merge content with data from POST
1555 $content = merge_array($content, postRequestArray());
1558 $message = loadEmailTemplate('member_mydata_notify', $content, getMemberId());
1560 if (isAdminNotificationEnabled()) {
1561 // The admin needs to be notified about a profile change
1562 $message_admin = 'admin_mydata_notify';
1563 $sub_adm = '{--ADMIN_CHANGED_DATA--}';
1566 $message_admin = '';
1570 // Set subject lines
1571 $sub_mem = '{--MEMBER_CHANGED_DATA--}';
1573 // Output success message
1574 $content['message'] = '<span class="message">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1577 default: // Unsupported module!
1578 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unsupported module %s detected.", $mod));
1579 $content['message'] = '<span class="notice">{--UNKNOWN_MODULE--}</span>';
1583 // Passwords mismatch
1584 $content['message'] = '<span class="notice">{--MEMBER_PASSWORD_ERROR--}</span>';
1587 // Could not load profile
1588 $content['message'] = '<span class="notice">{--MEMBER_CANNOT_LOAD_PROFILE--}</span>';
1591 // Send email to user if required
1592 if ((!empty($sub_mem)) && (!empty($message)) && (!empty($content['userid']))) {
1594 sendEmail($content['userid'], $sub_mem, $message);
1597 // Send only if no other error has occured
1598 if ((!empty($sub_adm)) && (!empty($message_admin)) && (isAdminNotificationEnabled())) {
1600 sendAdminNotification($sub_adm, $message_admin, $content, getMemberId());
1601 } elseif (isAdminNotificationEnabled()) {
1602 // Cannot send mails to admin!
1603 $content['message'] = '{--CANNOT_SEND_ADMIN_MAILS--}';
1606 $content['message'] = '<span class="message">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1610 displayMessage($content['message']);
1613 // Generates a 'selection box' from given array
1614 function generateSelectionBoxFromArray ($options, $name, $optionValue, $optionContent = '', $extraName = '') {
1616 $OUT = '<select name="' . $name . '" size="1" class="form_select">
1617 <option value="X" disabled="disabled">{--PLEASE_SELECT--}</option>';
1619 // Walk through all options
1620 foreach ($options as $option) {
1621 // Add the <option> entry from ...
1622 if (empty($optionContent)) {
1624 $OUT .= loadTemplate('select_' . $name . $extraName . '_option', true, $option);
1626 // ... direct HTML code
1627 $OUT .= '<option value="' . $option[$optionValue] . '">' . $option[$optionContent] . '</option>';
1631 // Finish selection box
1632 $OUT .= '</select>';
1636 'selection_box' => $OUT,
1639 // Load template and return it
1640 return loadTemplate('select_' . $name . $extraName . '_box', true, $content);
1643 // Prepares the header for HTML output
1644 function loadHtmlHeader () {
1646 // 1.) pre_page_header (mainly loads the page_header template and includes
1647 // meta description)
1648 runFilterChain('pre_page_header');
1650 // Here can be something be added, but normally one of the two filters
1651 // around this line should do the job for you.
1653 // 2.) post_page_header (mainly to load stylesheet, extra JavaScripts and
1654 // to close the head-tag)
1655 // Include more header data here
1656 runFilterChain('post_page_header');
1659 // Adds page header and footer to output array element
1660 function addPageHeaderFooter () {
1664 // Add them all together. This is maybe to simple
1665 foreach (array('page_header', 'output', 'page_footer') as $pagePart) {
1666 // Add page part if set
1667 if (isset($GLOBALS[$pagePart])) $OUT .= $GLOBALS[$pagePart];
1670 // Transfer $OUT to 'output'
1671 $GLOBALS['output'] = $OUT;
1674 // Generates meta description for current module and 'what' value
1675 function generateMetaDescriptionCode () {
1676 // Only include from guest area and if sql_patches has correct version
1677 if ((getModule() == 'index') && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1678 // Construct dynamic description
1679 $DESCR = '{?MAIN_TITLE?} ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu('guest', getWhat());
1681 // Output it directly
1682 $GLOBALS['page_header'] .= '<meta name="description" content="' . $DESCR . '" />';
1686 unset($GLOBALS['ref_level']);
1689 // Generates an FQFN for template cache from the given template name
1690 function generateCacheFqfn ($template, $mode = 'html') {
1692 if (!isset($GLOBALS['template_cache_fqfn'][$template])) {
1693 // Generate the FQFN
1694 $GLOBALS['template_cache_fqfn'][$template] = sprintf(
1695 "%s_compiled/%s/%s.tpl.cache",
1703 return $GLOBALS['template_cache_fqfn'][$template];
1706 // "Fixes" null or empty string to count of dashes
1707 function fixNullEmptyToDashes ($str, $num) {
1708 // Use str as default
1712 if ((is_null($str)) || (trim($str) == '')) {
1714 $return = str_repeat('-', $num);
1717 // Return final string
1721 // Translates the "pool type" into human-readable
1722 function translatePoolType ($type) {
1723 // Return "translation"
1724 return sprintf("{--POOL_TYPE_%s--}", strtoupper($type));
1727 // Displays given message in admin_settings_saved template
1728 function displayMessage ($message, $return = false) {
1729 // Load the template
1730 return loadTemplate('admin_settings_saved', $return, $message);
1733 // Generates a selection box for (maybe) given gender
1734 function generateGenderSelectionBox ($selectedGender = '') {
1735 // Start the HTML code
1736 $out = '<select name="gender" size="1" class="form_select">';
1739 $out .= generateOptionList('/ARRAY/', array('M', 'F', 'C'), array('{--GENDER_M--}', '{--GENDER_F--}', '{--GENDER_C--}'), $selectedGender);
1742 $out .= '</select>';
1748 //-----------------------------------------------------------------------------
1749 // Template helper functions for EL
1750 //-----------------------------------------------------------------------------
1752 // Color-switch helper function
1753 function doTemplateColorSwitch ($template, $clear = false, $return = true) {
1755 if (!isset($GLOBALS['color_switch'][$template])) {
1757 initTemplateColorSwitch($template);
1758 } elseif ($clear === false) {
1759 // Switch color if called from loadTemplate()
1760 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SWITCH:' . $template);
1761 $GLOBALS['color_switch'][$template] = 3 - $GLOBALS['color_switch'][$template];
1764 // Return CSS class name
1765 if ($return === true) {
1766 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'RETURN:' . $template . '=' . $GLOBALS['color_switch'][$template]);
1767 return 'switch_sw' . $GLOBALS['color_switch'][$template];
1771 // Helper function for extension registration link
1772 function doTemplateExtensionRegistrationLink ($template, $dummy, $ext_name) {
1773 // Default is all non-productive
1774 $OUT = '<em style="cursor:help" class="notice" title="{%message,ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK_TITLE=' . $ext_name . '%}">{--ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK--}</em>';
1776 // Is the given extension non-productive?
1777 if (isExtensionProductive($ext_name)) {
1779 $OUT = '<a title="{--ADMIN_REGISTER_EXTENSION_TITLE--}" href="{%url=modules.php?module=admin&what=extensions&reg_ext=' . $ext_name . '%}">{--ADMIN_REGISTER_EXTENSION--}</a>';
1786 // Helper function to create bonus mail admin links
1787 function doTemplateAdminBonusMailLinks ($template, $bonusId) {
1788 // Call the inner function
1789 return generateAdminMailLinks('bid', $bonusId);
1792 // Helper function to create member mail admin links
1793 function doTemplateAdminMemberMailLinks ($template, $mailId) {
1794 // Call the inner function
1795 return generateAdminMailLinks('mid', $mailId);