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 * Needs to be in all Files and every File needs "svn propset *
18 * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
19 * -------------------------------------------------------------------- *
20 * Copyright (c) 2003 - 2009 by Roland Haeder *
21 * Copyright (c) 2009, 2010 by Mailer Developer Team *
22 * For more information visit: http://www.mxchange.org *
24 * This program is free software; you can redistribute it and/or modify *
25 * it under the terms of the GNU General Public License as published by *
26 * the Free Software Foundation; either version 2 of the License, or *
27 * (at your option) any later version. *
29 * This program is distributed in the hope that it will be useful, *
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
32 * GNU General Public License for more details. *
34 * You should have received a copy of the GNU General Public License *
35 * along with this program; if not, write to the Free Software *
36 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
38 ************************************************************************/
40 // Some security stuff...
41 if (!defined('__SECURITY')) {
45 // Wrapper until we merged to the EL branch
46 function preCompileCode ($code, $template = '', $compiled = false, $full = true, $overwrite = false) {
47 return compileCode($code, false, true, $full);
50 // Setter for 'is_template_html'
51 function enableTemplateHtml ($enable = true) {
52 $GLOBALS['is_template_html'] = (bool) $enable;
55 // Checks wether the template is HTML or not by previously set flag
57 function isTemplateHtml () {
58 // Is the output_mode other than 0 (HTML), then no comments are enabled
59 if (!isHtmlOutputMode()) {
64 return $GLOBALS['is_template_html'];
68 // Wrapper for writing debug informations to the browser
69 function debugOutput ($message) {
70 outputHtml('<div class="debug_message">' . $message . '</div>');
73 // "Fixes" an empty string into three dashes (use for templates)
74 function fixEmptyContentToDashes ($str) {
78 // Is the string empty?
79 if (empty($str)) $str = '---';
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)) && ($cnt < 5)) {
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()) {
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() === false) && (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);
281 if (empty($GLOBALS['refid'])) $GLOBALS['refid'] = '0';
284 $basePath = sprintf("%stemplates/%s/html/", getPath(), getLanguage());
285 $extraPath = detectExtraTemplatePath($template);;
288 $FQFN = $basePath . $extraPath . $template . '.tpl';
290 // Does the special template exists?
291 if (!isFileReadable($FQFN)) {
292 // Reset to default template
293 $FQFN = $basePath . $template . '.tpl';
296 // Now does the final template exists?
297 if (isFileReadable($FQFN)) {
298 // Count the template load
299 incrementConfigEntry('num_templates');
301 // The local file does exists so we load it. :)
302 $GLOBALS['tpl_content'] = readFromFile($FQFN);
304 // Do we have to compile the code?
306 if ((strpos($GLOBALS['tpl_content'], '$') !== false) || (strpos($GLOBALS['tpl_content'], '{--') !== false) || (strpos($GLOBALS['tpl_content'], '{?') !== false) || (strpos($GLOBALS['tpl_content'], '{%') !== false)) {
307 // Normal HTML output?
308 if (isHtmlOutputMode()) {
309 // Add surrounding HTML comments to help finding bugs faster
310 $ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'] . '<!-- Template ' . $template . ' - End //-->';
312 // Prepare eval() command
313 $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileCode(escapeQuotes($ret)) . '";';
314 } elseif (substr($template, 0, 3) == 'js_') {
315 // JavaScripts don't like entities and timings
316 $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['tpl_content'])) . '");';
318 // Prepare eval() command, other output doesn't like entities, maybe
319 $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'])) . '");';
322 // Add surrounding HTML comments to help finding bugs faster
323 $ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'] . '<!-- Template ' . $template . ' - End //-->';
324 $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileRawCode(escapeQuotes($ret)) . '";';
326 } elseif ((isAdmin()) || ((isInstalling()) && (!isInstalled()))) {
327 // Only admins shall see this warning or when installation mode is active
328 $ret = '<div class="para">
329 <span class="guest_failed">{--TEMPLATE_404--}</span>
335 {--TEMPLATE_CONTENT--}
336 <pre>' . print_r($content, true) . '</pre>
340 $GLOBALS['template_eval'][$template] = '404';
345 if ((isset($GLOBALS['template_eval'][$template])) && ($GLOBALS['template_eval'][$template] != '404')) {
347 eval($GLOBALS['template_eval'][$template]);
350 // Do we have some content to output or return?
352 // Not empty so let's put it out! ;)
353 if ($return === true) {
354 // Return the HTML code
360 } elseif (isDebugModeEnabled()) {
361 // Warning, empty output!
362 return 'E:' . $template . ',content=<pre>' . print_r($content, true) . '</pre>';
366 // Detects the extra template path from given template name
367 function detectExtraTemplatePath ($template) {
372 if (!isset($GLOBALS['extra_path'][$template])) {
373 // Check for admin/guest/member/etc. templates
374 if (substr($template, 0, 6) == 'admin_') {
375 // Admin template found
376 $extraPath = 'admin/';
377 } elseif (substr($template, 0, 6) == 'guest_') {
378 // Guest template found
379 $extraPath = 'guest/';
380 } elseif (substr($template, 0, 7) == 'member_') {
381 // Member template found
382 $extraPath = 'member/';
383 } elseif (substr($template, 0, 7) == 'select_') {
384 // Selection template found
385 $extraPath = 'select/';
386 } elseif (substr($template, 0, 8) == 'install_') {
387 // Installation template found
388 $extraPath = 'install/';
389 } elseif (substr($template, 0, 4) == 'ext_') {
390 // Extension template found
392 } elseif (substr($template, 0, 3) == 'la_') {
393 // 'Logical-area' template found
395 } elseif (substr($template, 0, 3) == 'js_') {
396 // JavaScript template found
398 } elseif (substr($template, 0, 5) == 'menu_') {
399 // Menu template found
400 $extraPath = 'menu/';
402 // Test for extension
403 $test = substr($template, 0, strpos($template, '_'));
405 // Probe for valid extension name
406 if (isExtensionNameValid($test)) {
407 // Set extra path to extension's name
408 $extraPath = $test . '/';
413 $GLOBALS['extra_path'][$template] = $extraPath;
417 return $GLOBALS['extra_path'][$template];
420 // Loads an email template and compiles it
421 function loadEmailTemplate ($template, $content = array(), $userid = '0') {
424 // Make sure all template names are lowercase!
425 $template = strtolower($template);
427 // Is content an array?
428 if (is_array($content)) {
429 // Add expiration to array
430 if ((isConfigEntrySet('auto_purge')) && (getAutoPurge() == '0')) {
431 // Will never expire!
432 $content['expiration'] = '{--MAIL_WILL_NEVER_EXPIRE--}';
433 } elseif (isConfigEntrySet('auto_purge')) {
434 // Create nice date string
435 $content['expiration'] = createFancyTime(getAutoPurge());
438 $content['expiration'] = '{--MAIL_NO_CONFIG_AUTO_PURGE--}';
443 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UID={$userid},template={$template},content[]=".gettype($content));
444 if ((isValidUserId($userid)) && (is_array($content))) {
445 // If nickname extension is installed, fetch nickname as well
446 if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
447 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NICKNAME!<br />");
449 fetchUserData($userid, 'nickname');
451 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NO-NICK!<br />");
453 fetchUserData($userid);
456 // Merge data if valid
457 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - PRE<br />");
458 if (isUserDataValid()) {
459 $content = merge_array($content, getUserDataArray());
461 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - AFTER<br />");
465 $basePath = sprintf("%stemplates/%s/emails/", getPath(), getLanguage());
468 $extraPath = detectExtraTemplatePath($template);
470 // Generate full FQFN
471 $FQFN = $basePath . $extraPath . $template . '.tpl';
473 // Does the special template exists?
474 if (!isFileReadable($FQFN)) {
475 // Reset to default template
476 $FQFN = $basePath . $template . '.tpl';
479 // Now does the final template exists?
481 if (isFileReadable($FQFN)) {
482 // The local file does exists so we load it. :)
483 $GLOBALS['tpl_content'] = readFromFile($FQFN);
486 $GLOBALS['tpl_content'] = '$newContent = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'])) . '");';
487 eval($GLOBALS['tpl_content']);
488 } elseif (!empty($template)) {
489 // Template file not found!
490 $newContent = '<div class="para">
491 {--TEMPLATE_404--}: ' . $template . '
494 {--TEMPLATE_CONTENT--}
495 <pre>' . print_r($content, true) . '</pre>
497 <pre>' . print_r($DATA, true) . '</pre>
500 // Debug mode not active? Then remove the HTML tags
501 if (!isDebugModeEnabled()) $newContent = secureString($newContent);
503 // No template name supplied!
504 $newContent = '{--NO_TEMPLATE_SUPPLIED--}';
507 // Is there some content?
508 if (empty($newContent)) {
510 $newContent = "Compiler error for template " . $template . " !\nUncompiled content:\n" . $GLOBALS['tpl_content'];
512 // Add last error if the required function exists
513 if (function_exists('error_get_last')) $newContent .= "\n--------------------------------------\nDebug:\n".print_r(error_get_last(), true)."--------------------------------------\nPlease don't alter these informations!\nThanx.";
516 // Remove content and data
524 // "Getter" for menu CSS classes, mainly used in templates
525 function getMenuCssClasses ($data) {
526 // $data needs to be converted into an array
527 $content = explode('|', $data);
529 // Non-existent index 2 will happen in menu blocks
530 if (!isset($content[2])) $content[2] = '';
532 // Re-construct the array: 0=visible,1=locked,2=prefix
533 $content['visible'] = $content[0];
534 $content['locked'] = $content[1];
536 // Call our "translator" function
537 $content = translateMenuVisibleLocked($content, $content[2]);
539 // Return CSS classes
540 return ($content['visible_css'] . ' ' . $content['locked_css']);
543 // Generate XHTML code for the CAPTCHA
544 function generateCaptchaCode ($code, $type, $DATA, $userid) {
545 return '<img border="0" alt="Code ' . $code . '" src="{%url=mailid_top.php?userid=' . $userid . '&' . $type . '=' . $DATA . '&mode=img&code=' . $code . '%}" />';
548 // Compiles the given HTML/mail code
549 function compileCode ($code, $simple = false, $constants = true, $full = true) {
550 // Is the code a string?
551 if (!is_string($code)) {
552 // Silently return it
557 $startCompile = microtime(true);
560 $code = compileRawCode($code, $simple, $constants, $full);
563 $compiled = microtime(true);
565 // Add timing if enabled
566 if (isTemplateHtml()) {
567 // Add timing, this should be disabled in
568 $code .= '<!-- Compilation time: ' . (($compiled - $startCompile) * 1000). 'ms //-->';
571 // Return compiled code
575 // Compiles the code (use compileCode() only for HTML because of the comments)
576 // @TODO $simple/$constants are deprecated
577 function compileRawCode ($code, $simple = false, $constants = true, $full = true) {
578 // Is the code a string?
579 if (!is_string($code)) {
580 // Silently return it
584 // Init replacement-array with smaller set of security characters
585 $secChars = $GLOBALS['url_chars'];
587 // Select full set of chars to replace when we e.g. want to compile URLs
588 if ($full === true) $secChars = $GLOBALS['security_chars'];
590 // Compile more through a filter
591 $code = runFilterChain('compile_code', $code);
593 // Compile message strings
594 $code = str_replace('{--', '{%message,', str_replace('--}', '%}', $code));
596 // Compile QUOT and other non-HTML codes
597 foreach ($secChars['to'] as $k => $to) {
598 // Do the reversed thing as in inc/libs/security_functions.php
599 $code = str_replace($to, $secChars['from'][$k], $code);
602 // Find $content[bla][blub] entries
603 // @TODO Do only use $content and deprecate $GLOBALS and $DATA in templates
604 preg_match_all('/\$(content|GLOBALS|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
606 // Are some matches found?
607 if ((count($matches) > 0) && (count($matches[0]) > 0)) {
608 // Replace all matches
609 $matchesFound = array();
610 foreach ($matches[0] as $key => $match) {
611 // Fuzzy look has failed by default
614 // Fuzzy look on match if already found
615 foreach ($matchesFound as $found => $set) {
617 $test = substr($found, 0, strlen($match));
619 // Does this entry exist?
620 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "found={$found},match={$match},set={$set}<br />");
621 if ($test == $match) {
623 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "fuzzyFound!<br />");
630 if ($fuzzyFound === true) continue;
632 // Take all string elements
633 if ((is_string($matches[4][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key.'_' . $matches[4][$key]]))) {
634 // Replace it in the code
635 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "key={$key},match={$match}<br />");
636 $newMatch = str_replace('[', "['", str_replace(']', "']", $match));
637 $code = str_replace($match, '".' . $newMatch . '."', $code);
638 $matchesFound[$key . '_' . $matches[4][$key]] = 1;
639 $matchesFound[$match] = 1;
640 } elseif (!isset($matchesFound[$match])) {
642 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "match={$match}<br />");
643 $code = str_replace($match, '".' . $match . '."', $code);
644 $matchesFound[$match] = 1;
654 function addSelectionBox ($type, $default, $prefix = '', $id = '0', $class = 'register_select') {
658 // This is a yes/no selection only!
659 if ($id > 0) $prefix .= '[' . $id . ']';
660 $OUT .= '<select name="' . $prefix . '" class="' . $class . '" size="1">';
662 // Begin with regular selection box here
663 if (!empty($prefix)) $prefix .= '_';
665 if ($id > 0) $type2 .= '[' . $id . ']';
666 $OUT .= '<select name="' . strtolower($prefix . $type2) . '" class="' . $class . '" size="1">';
671 for ($idx = 1; $idx < 32; $idx++) {
672 $OUT .= '<option value="' . $idx . '"';
673 if ($default == $idx) $OUT .= ' selected="selected"';
674 $OUT .= '>' . $idx . '</option>';
678 case 'month': // Month
679 foreach ($GLOBALS['month_descr'] as $idx => $descr) {
680 $OUT .= '<option value="' . $idx . '"';
681 if ($default == $idx) $OUT .= ' selected="selected"';
682 $OUT .= '>' . $descr . '</option>';
690 // Use configured min age or fixed?
691 if (isExtensionInstalledAndNewer('order', '0.2.1')) {
693 $startYear = $year - getConfig('min_age');
696 $startYear = $year - 16;
699 // Calculate earliest year (100 years old people can still enter Internet???)
700 $minYear = $year - 100;
702 // Check if the default value is larger than minimum and bigger than actual year
703 if (($default > $minYear) && ($default >= $year)) {
704 for ($idx = $year; $idx < ($year + 11); $idx++) {
705 $OUT .= '<option value="' . $idx . '"';
706 if ($default == $idx) $OUT .= ' selected="selected"';
707 $OUT .= '>' . $idx . '</option>';
709 } elseif ($default == -1) {
710 // Current year minus 1
711 for ($idx = $startYear; $idx <= ($year + 1); $idx++) {
712 $OUT .= '<option value="' . $idx . '">' . $idx . '</option>';
715 // Get current year and subtract the configured minimum age
716 $OUT .= '<option value="' . ($minYear - 1) . '"><' . $minYear . '</option>';
717 // Calculate earliest year depending on extension version
718 if (isExtensionInstalledAndNewer('order', '0.2.1')) {
719 // Use configured minimum age
720 $year = getYear() - getConfig('min_age');
722 // Use fixed 16 years age
723 $year = getYear() - 16;
726 // Construct year selection list
727 for ($idx = $minYear; $idx <= $year; $idx++) {
728 $OUT .= '<option value="' . $idx . '"';
729 if ($default == $idx) $OUT .= ' selected="selected"';
730 $OUT .= '>' . $idx . '</option>';
737 for ($idx = 0; $idx < 60; $idx+=5) {
738 if (strlen($idx) == 1) $idx = '0' . $idx;
739 $OUT .= '<option value="' . $idx . '"';
740 if ($default == $idx) $OUT .= ' selected="selected"';
741 $OUT .= '>' . $idx . '</option>';
746 for ($idx = 0; $idx < 24; $idx++) {
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 $OUT .= '<option value="Y"';
756 if ($default == 'Y') $OUT .= ' selected="selected"';
757 $OUT .= '>{--YES--}</option><option value="N"';
758 if ($default != 'Y') $OUT .= ' selected="selected"';
759 $OUT .= '>{--NO--}</option>';
766 // Insert the code in $img_code into jpeg or PNG image
767 function generateImageOrCode ($img_code, $headerSent = true) {
768 // Is the code size oversized or shouldn't we display it?
769 if ((strlen($img_code) > 6) || (empty($img_code)) || (getConfig('code_length') == '0')) {
770 // Stop execution of function here because of over-sized code length
771 debug_report_bug(__FUNCTION__, __LINE__, 'img_code ' . $img_code .' has invalid length. img_code()=' . strlen($img_code) . ' code_length=' . getConfig('code_length'));
772 } elseif ($headerSent === false) {
773 // Return an HTML code here
774 return '<img src="{%url=img.php?code=' . $img_code . '%}" alt="Image" />';
778 $img = sprintf("%s/theme/%s/images/code_bg.%s",
781 getConfig('img_type')
785 if (isFileReadable($img)) {
787 switch (getConfig('img_type')) {
789 // Okay, load image and hide all errors
790 $image = imagecreatefromjpeg($img);
794 // Okay, load image and hide all errors
795 $image = imagecreatefrompng($img);
799 // Exit function here
800 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File for image type %s not found.", getConfig('img_type')));
804 // Generate text color (red/green/blue; 0 = dark, 255 = bright)
805 $text_color = imagecolorallocate($image, 0, 0, 0);
807 // Insert code into image
808 imagestring($image, 5, 14, 2, $img_code, $text_color);
811 sendHeader('Content-Type: image/' . getConfig('img_type'));
813 // Output image with matching image factory
814 switch (getConfig('img_type')) {
815 case 'jpg': imagejpeg($image); break;
816 case 'png': imagepng($image); break;
819 // Remove image from memory
820 imagedestroy($image);
822 // Create selection box or array of splitted timestamp
823 function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $return_array=false) {
824 // Do not continue if ONE_DAY is absend
825 if (!isConfigEntrySet('ONE_DAY')) {
826 // And return the timestamp itself or empty array
827 if ($return_array === true) {
834 // Calculate 2-seconds timestamp
835 $stamp = round($timestamp);
836 //* DEBUG: */ debugOutput('*' . $stamp .'/' . $timestamp . '*');
838 // Do we have a leap year?
840 $TEST = getYear() / 4;
842 $M2 = getMonth(time() + $timestamp);
844 // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
845 if ((floor($TEST) == $TEST) && ($M1 == '02') && ($M2 > '02')) $SWITCH = getConfig('ONE_DAY');
847 // First of all years...
848 $Y = abs(floor($timestamp / (31536000 + $SWITCH)));
849 //* DEBUG: */ debugOutput('Y=' . $Y);
851 $M = abs(floor($timestamp / 2628000 - $Y * 12));
852 //* DEBUG: */ debugOutput('M=' . $M);
854 $W = abs(floor($timestamp / 604800 - $Y * ((365 + $SWITCH / getConfig('ONE_DAY')) / 7) - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) / 7)));
855 //* DEBUG: */ debugOutput('W=' . $W);
857 $D = abs(floor($timestamp / 86400 - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY'))) - $W * 7));
858 //* DEBUG: */ debugOutput('D=' . $D);
860 $h = abs(floor($timestamp / 3600 - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) * 24) - $W * 7 * 24 - $D * 24));
861 //* DEBUG: */ debugOutput('h=' . $h);
863 $m = abs(floor($timestamp / 60 - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 60 - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 60) - $W * 7 * 24 * 60 - $D * 24 * 60 - $h * 60));
864 //* DEBUG: */ debugOutput('m=' . $m);
865 // And at last seconds...
866 $s = abs(floor($timestamp - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 3600 - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) * 24 * 3600) - $W * 7 * 24 * 3600 - $D * 24 * 3600 - $h * 3600 - $m * 60));
867 //* DEBUG: */ debugOutput('s=' . $s);
869 // Is seconds zero and time is < 60 seconds?
870 if (($s == '0') && ($timestamp < 60)) {
872 $s = round($timestamp);
876 // Now we convert them in seconds...
879 // Just put all data in an array for later use
891 $OUT = '<div align="' . $align . '">';
892 $OUT .= '<table border="0" cellspacing="0" cellpadding="0" class="timebox_table dashed">';
895 if (isInString('Y', $display) || (empty($display))) {
896 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_YEARS--}</strong></td>';
899 if (isInString('M', $display) || (empty($display))) {
900 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MONTHS--}</strong></td>';
903 if (isInString('W', $display) || (empty($display))) {
904 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_WEEKS--}</strong></td>';
907 if (isInString('D', $display) || (empty($display))) {
908 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_DAYS--}</strong></td>';
911 if (isInString('h', $display) || (empty($display))) {
912 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_HOURS--}</strong></td>';
915 if (isInString('m', $display) || (empty($display))) {
916 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MINUTES--}</strong></td>';
919 if (isInString('s', $display) || (empty($display))) {
920 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_SECONDS--}</strong></td>';
926 if (isInString('Y', $display) || (empty($display))) {
927 // Generate year selection
928 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ye" size="1">';
929 for ($idx = 0; $idx <= 10; $idx++) {
930 $OUT .= '<option class="mini_select" value="' . $idx . '"';
931 if ($idx == $Y) $OUT .= ' selected="selected"';
932 $OUT .= '>' . $idx . '</option>';
934 $OUT .= '</select></td>';
936 $OUT .= '<input type="hidden" name="' . $prefix . '_ye" value="0" />';
939 if (isInString('M', $display) || (empty($display))) {
940 // Generate month selection
941 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mo" size="1">';
942 for ($idx = 0; $idx <= 11; $idx++) {
943 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
944 if ($idx == $M) $OUT .= ' selected="selected"';
945 $OUT .= '>' . $idx . '</option>';
947 $OUT .= '</select></td>';
949 $OUT .= '<input type="hidden" name="' . $prefix . '_mo" value="0" />';
952 if (isInString('W', $display) || (empty($display))) {
953 // Generate week selection
954 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_we" size="1">';
955 for ($idx = 0; $idx <= 4; $idx++) {
956 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
957 if ($idx == $W) $OUT .= ' selected="selected"';
958 $OUT .= '>' . $idx . '</option>';
960 $OUT .= '</select></td>';
962 $OUT .= '<input type="hidden" name="' . $prefix . '_we" value="0" />';
965 if (isInString('D', $display) || (empty($display))) {
966 // Generate day selection
967 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_da" size="1">';
968 for ($idx = 0; $idx <= 31; $idx++) {
969 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
970 if ($idx == $D) $OUT .= ' selected="selected"';
971 $OUT .= '>' . $idx . '</option>';
973 $OUT .= '</select></td>';
975 $OUT .= '<input type="hidden" name="' . $prefix . '_da" value="0" />';
978 if (isInString('h', $display) || (empty($display))) {
979 // Generate hour selection
980 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ho" size="1">';
981 for ($idx = 0; $idx <= 23; $idx++) {
982 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
983 if ($idx == $h) $OUT .= ' selected="selected"';
984 $OUT .= '>' . $idx . '</option>';
986 $OUT .= '</select></td>';
988 $OUT .= '<input type="hidden" name="' . $prefix . '_ho" value="0" />';
991 if (isInString('m', $display) || (empty($display))) {
992 // Generate minute selection
993 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mi" size="1">';
994 for ($idx = 0; $idx <= 59; $idx++) {
995 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
996 if ($idx == $m) $OUT .= ' selected="selected"';
997 $OUT .= '>' . $idx . '</option>';
999 $OUT .= '</select></td>';
1001 $OUT .= '<input type="hidden" name="' . $prefix . '_mi" value="0" />';
1004 if (isInString('s', $display) || (empty($display))) {
1005 // Generate second selection
1006 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_se" size="1">';
1007 for ($idx = 0; $idx <= 59; $idx++) {
1008 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
1009 if ($idx == $s) $OUT .= ' selected="selected"';
1010 $OUT .= '>' . $idx . '</option>';
1012 $OUT .= '</select></td>';
1014 $OUT .= '<input type="hidden" name="' . $prefix . '_se" value="0" />';
1021 // Return generated HTML code
1025 // Generate a list of administrative links to a given userid
1026 function generateMemberAdminActionLinks ($userid) {
1027 // Make sure userid is a number
1028 if ($userid != bigintval($userid)) debug_report_bug(__FUNCTION__, __LINE__, 'userid is not a number!');
1030 // Define all main targets
1031 $targetArray = array('del_user', 'edit_user', 'lock_user', 'add_points', 'sub_points');
1034 $status = getFetchedUserData('userid', $userid, 'status');
1036 // Begin of navigation links
1039 foreach ($targetArray as $tar) {
1040 $OUT .= '<span class="admin_user_link"><a href="{%url=modules.php?module=admin&what=' . $tar . '&userid=' . $userid . '%}" title="{--ADMIN_LINK_';
1041 //* DEBUG: */ debugOutput('*' . $tar.'/' . $status.'*');
1042 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
1043 // Locked accounts shall be unlocked
1044 $OUT .= 'UNLOCK_USER';
1046 // All other status is fine
1047 $OUT .= strtoupper($tar);
1049 $OUT .= '_TITLE--}">{--ADMIN_';
1050 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
1051 // Locked accounts shall be unlocked
1052 $OUT .= 'UNLOCK_USER';
1054 // All other status is fine
1055 $OUT .= strtoupper($tar);
1057 $OUT .= '--}</a></span>|';
1060 // Finish navigation link
1061 $OUT = substr($OUT, 0, -1) . ']';
1067 // Generate an email link
1068 function generateEmailLink ($email, $table = 'admins') {
1069 // Default email link (INSECURE! Spammer can read this by harvester programs)
1070 $EMAIL = 'mailto:' . $email;
1072 // Check for several extensions
1073 if ((isExtensionActive('admins')) && ($table == 'admins')) {
1074 // Create email link for contacting admin in guest area
1075 $EMAIL = generateAdminEmailLink($email);
1076 } elseif ((isExtensionInstalledAndNewer('user', '0.3.3')) && ($table == 'user_data')) {
1077 // Create email link for contacting a member within admin area (or later in other areas, too?)
1078 $EMAIL = generateUserEmailLink($email);
1079 } elseif ((isExtensionActive('sponsor')) && ($table == 'sponsor_data')) {
1080 // Create email link to contact sponsor within admin area (or like the link above?)
1081 $EMAIL = generateSponsorEmailLink($email);
1084 // Shall I close the link when there is no admin?
1085 if ((!isAdmin()) && ($EMAIL == $email)) $EMAIL = '#'; // Closed!
1087 // Return email link
1091 // Output error messages in a fasioned way and die...
1092 function app_die ($F, $L, $message) {
1093 // Check if Script is already dieing and not let it kill itself another 1000 times
1094 if (!isset($GLOBALS['app_died'])) {
1095 // Make sure, that the script realy realy diese here and now
1096 $GLOBALS['app_died'] = true;
1098 // Set content type as text/html
1099 setContentType('text/html');
1102 loadIncludeOnce('inc/header.php');
1104 // Rewrite message for output
1105 $message = sprintf(getMessage('MAILER_HAS_DIED'), basename($F), $L, $message);
1107 // Load the message template
1108 loadTemplate('app_die_message', false, $message);
1111 loadIncludeOnce('inc/footer.php');
1113 // Script tried to kill itself twice
1114 die('['.__FUNCTION__.':'.__LINE__.']: Script wanted to kill itself more than once! Raw message=' . $message . ', file/function=' . $F . ', line=' . $L);
1118 // Display parsing time and number of SQL queries in footer
1119 function displayParsingTime () {
1120 // Is the timer started?
1121 if (!isset($GLOBALS['startTime'])) {
1127 $endTime = microtime(true);
1129 // "Explode" both times
1130 $start = explode(' ', $GLOBALS['startTime']);
1131 $end = explode(' ', $endTime);
1132 $runTime = $end[0] - $start[0];
1138 // @TODO This can be easily moved out after the merge from EL branch to this is complete
1140 'run_time' => $runTime,
1141 'sql_time' => (getConfig('sql_time') * 1000),
1144 // Load the template
1145 $GLOBALS['page_footer'] .= loadTemplate('show_timings', true, $content);
1148 // Output a debug backtrace to the user
1149 function debug_report_bug ($F, $L, $message = '', $sendEmail = true) {
1150 // Is this already called?
1151 if (isset($GLOBALS[__FUNCTION__])) {
1153 print 'Message:' . $message . '<br />Backtrace:<pre>';
1154 debug_print_backtrace();
1158 // Set this function as called
1159 $GLOBALS[__FUNCTION__] = true;
1164 // Is the optional message set?
1165 if (!empty($message)) {
1167 $debug = sprintf("Note: %s<br />\n",
1171 // @TODO Add a little more infos here
1172 logDebugMessage($F, $L, strip_tags($message));
1176 $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>';
1177 $debug .= debug_get_printable_backtrace();
1179 $debug .= '<div class="para">Request-URI: ' . getRequestUri() . '</div>';
1180 $debug .= '<div class="para">Thank you for finding bugs.</div>';
1182 // Send an email? (e.g. not wanted for evaluation errors)
1183 if (($sendEmail === true) && (!isInstallationPhase())) {
1186 'message' => trim($message),
1187 'backtrace' => trim(debug_get_mailable_backtrace())
1190 // Send email to webmaster
1191 sendAdminNotification('{--DEBUG_REPORT_BUG_SUBJECT--}', 'admin_report_bug', $content);
1195 app_die($F, $L, $debug);
1198 // Compile characters which are allowed in URLs
1199 function compileUriCode ($code, $simple = true) {
1200 // Compile constants
1201 if ($simple === false) $code = str_replace('{--', '".', str_replace('--}', '."', $code));
1203 // Compile QUOT and other non-HTML codes
1204 $code = str_replace('{DOT}', '.',
1205 str_replace('{SLASH}', '/',
1206 str_replace('{QUOT}', "'",
1207 str_replace('{DOLLAR}', '$',
1208 str_replace('{OPEN_ANCHOR}', '(',
1209 str_replace('{CLOSE_ANCHOR}', ')',
1210 str_replace('{OPEN_SQR}', '[',
1211 str_replace('{CLOSE_SQR}', ']',
1212 str_replace('{PER}', '%',
1216 // Return compiled code
1220 // Handle message codes from URL
1221 function handleCodeMessage () {
1222 if (isGetRequestParameterSet('code')) {
1223 // Default extension is 'unknown'
1226 // Is extension given?
1227 if (isGetRequestParameterSet('ext')) $ext = getRequestParameter('ext');
1229 // Convert the 'code' parameter from URL to a human-readable message
1230 $message = getMessageFromErrorCode(getRequestParameter('code'));
1232 // Load message template
1233 loadTemplate('message', false, $message);
1237 // Generates a 'extension foo inactive' message
1238 function generateExtensionInactiveMessage ($ext_name) {
1239 // Is the extension empty?
1240 if (empty($ext_name)) {
1241 // This should not happen
1242 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1246 $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_INACTIVE', $ext_name);
1248 // Is an admin logged in?
1250 // Then output admin message
1251 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE', $ext_name);
1254 // Return prepared message
1258 // Generates a 'extension foo not installed' message
1259 function generateExtensionNotInstalledMessage ($ext_name) {
1260 // Is the extension empty?
1261 if (empty($ext_name)) {
1262 // This should not happen
1263 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1267 $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
1269 // Is an admin logged in?
1271 // Then output admin message
1272 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
1275 // Return prepared message
1279 // Generates a message depending on if the extension is not installed or not
1281 function generateExtensionInactiveNotInstalledMessage ($ext_name) {
1285 // Is the extension not installed or just deactivated?
1286 switch (isExtensionInstalled($ext_name)) {
1287 case true; // Deactivated!
1288 $message = generateExtensionInactiveMessage($ext_name);
1291 case false; // Not installed!
1292 $message = generateExtensionNotInstalledMessage($ext_name);
1295 default: // Should not happen!
1296 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid state of extension %s detected.", $ext_name));
1297 $message = sprintf("Invalid state of extension %s detected.", $ext_name);
1301 // Return the message
1305 // Print code with line numbers
1306 function linenumberCode ($code) {
1307 if (!is_array($code)) $codeE = explode("\n", $code); else $codeE = $code;
1308 $count_lines = count($codeE);
1310 $r = 'Line | Code:<br />';
1311 foreach($codeE as $line => $c) {
1312 $r .= '<div class="line"><span class="linenum">';
1313 if ($count_lines == 1) {
1316 $r .= ($line == ($count_lines - 1)) ? '' : ($line+1);
1321 $r .= '<span class="linetext">' . encodeEntities($c) . '</span></div>';
1324 return '<div class="code">' . $r . '</div>';
1327 // Determines the right page title
1328 function determinePageTitle () {
1329 // Config and database connection valid?
1330 if ((isConfigLocalLoaded()) && (isConfigurationLoaded()) && (SQL_IS_LINK_UP()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1334 // Title decoration enabled?
1335 if ((isTitleDecorationEnabled()) && (getConfig('title_left') != '')) $TITLE .= trim(getConfig('title_left')) . ' ';
1337 // Do we have some extra title?
1338 if (isExtraTitleSet()) {
1340 $TITLE .= getExtraTitle() . ' by ';
1344 $TITLE .= getMainTitle();
1346 // Add title of module? (middle decoration will also be added!)
1347 if ((isModuleTitleEnabled()) || ((!isWhatSet()) && (!isActionSet())) || (getModule() == 'admin')) {
1348 $TITLE .= ' ' . trim(getConfig('title_middle')) . ' {DQUOTE} . getModuleTitle(getModule()) . {DQUOTE}';
1351 // Add title from what file
1353 if (getModule() == 'login') $mode = 'member';
1354 elseif (getModule() == 'index') $mode = 'guest';
1355 if ((!empty($mode)) && (isWhatTitleEnabled())) $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu($mode, getWhat());
1357 // Add title decorations? (right)
1358 if ((isTitleDecorationEnabled()) && (getConfig('title_right') != '')) $TITLE .= ' ' . trim(getConfig('title_right'));
1360 // Remember title in constant for the template
1361 $pageTitle = $TITLE;
1362 } elseif ((isInstalled()) && (isAdminRegistered())) {
1363 // Installed, admin registered but no ext-sql_patches
1364 $pageTitle = '[-- ' . getMainTitle() . ' - ' . getModuleTitle(getModule()) . ' --]';
1365 } elseif ((isInstalled()) && (!isAdminRegistered())) {
1366 // Installed but no admin registered
1367 $pageTitle = '{--INSTALLER_OF_MAILER_NO_ADMIN--}';
1368 } elseif ((!isInstalled()) || (!isAdminRegistered())) {
1369 // Installation mode
1370 $pageTitle = '{--INSTALLER_OF_MAILER--}';
1372 // Configuration not found!
1373 $pageTitle = '{--NO_CONFIG_FOUND_TITLE--}';
1375 // Do not add the fatal message in installation mode
1376 if ((!isInstalling()) && (!isConfigurationLoaded())) addFatalMessage(__FUNCTION__, __LINE__, '{--NO_CONFIG_FOUND--}');
1380 return decodeEntities($pageTitle);
1383 // Checks wethere there is a cache file there. This function is cached.
1384 function isTemplateCached ($template) {
1385 // Do we have cached this result?
1386 if (!isset($GLOBALS['template_cache'][$template])) {
1388 $FQFN = generateCacheFqfn($template);
1391 $GLOBALS['template_cache'][$template] = isFileReadable($FQFN);
1395 return $GLOBALS['template_cache'][$template];
1398 // Flushes non-flushed template cache to disk
1399 function flushTemplateCache ($template, $eval) {
1400 // Is this cache flushed?
1401 if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template) === false) && ($eval != '404')) {
1403 $FQFN = generateCacheFqfn($template);
1406 writeToFile($FQFN, $eval, true);
1410 // Reads a template cache
1411 function readTemplateCache ($template) {
1413 if ((isDebuggingTemplateCache()) || (!isTemplateCached($template))) {
1414 // This should not happen
1415 debug_report_bug('Wether debugging of template cache is enabled or template ' . $template . ' is not cached while expected.');
1419 if (!isset($GLOBALS['template_eval'][$template])) {
1421 $FQFN = generateCacheFqfn($template);
1424 $GLOBALS['template_eval'][$template] = readFromFile($FQFN);
1428 return $GLOBALS['template_eval'][$template];
1431 // Escapes quotes (default is only double-quotes)
1432 function escapeQuotes ($str, $single = false) {
1433 // Should we escape all?
1434 if ($single === true) {
1435 // Escape all (including null)
1436 $str = addslashes($str);
1438 // Remove escaping of single quotes
1439 $str = str_replace("\'", "'", $str);
1441 // Escape only double-quotes but prevent double-quoting
1442 $str = str_replace("\\\\", "\\", str_replace('"', "\\\"", $str));
1445 // Return the escaped string
1449 // Escapes the JavaScript code, prevents \r and \n becoming char 10/13
1450 function escapeJavaScriptQuotes ($str) {
1451 // Replace all double-quotes and secure back-ticks
1452 $str = str_replace('"', '\"', str_replace("\\", '{BACK}', $str));
1458 // Send out mails depending on the 'mod/modes' combination
1459 // @TODO Lame description for this function
1460 function sendModeMails ($mod, $modes) {
1462 if (fetchUserData(getMemberId())) {
1463 // Extract salt from cookie
1464 $salt = substr(getSession('u_hash'), 0, -40);
1466 // Now let's compare passwords
1467 $hash = encodeHashForCookie(getUserData('password'));
1469 // Does the hash match or should we change it?
1470 if (($hash == getSession('u_hash')) || (postRequestParameter('pass1') == postRequestParameter('pass2'))) {
1472 $content = getUserDataArray();
1474 // Clear/init the content variable
1475 $content['message'] = '';
1478 // @TODO Move this in a filter
1481 foreach ($modes as $mode) {
1483 case 'normal': break; // Do not add any special lines
1484 case 'email': // Email was changed!
1485 $content['message'] = '{--MEMBER_CHANGED_EMAIL--}' . ': ' . postRequestParameter('old_email') . "\n";
1488 case 'password': // Password was changed
1489 $content['message'] = '{--MEMBER_CHANGED_PASS--}' . "\n";
1493 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown mode %s detected.", $mode));
1494 $content['message'] = '{--MEMBER_UNKNOWN_MODE--}' . ': ' . $mode . "\n\n";
1499 if (isExtensionActive('country')) {
1500 // Replace code with description
1501 $content['country'] = generateCountryInfo(postRequestParameter('country_code'));
1504 // Merge content with data from POST
1505 $content = merge_array($content, postRequestArray());
1508 $message = loadEmailTemplate('member_mydata_notify', $content, getMemberId());
1510 if (isAdminNotificationEnabled()) {
1511 // The admin needs to be notified about a profile change
1512 $message_admin = 'admin_mydata_notify';
1513 $sub_adm = '{--ADMIN_CHANGED_DATA--}';
1516 $message_admin = '';
1520 // Set subject lines
1521 $sub_mem = '{--MEMBER_CHANGED_DATA--}';
1523 // Output success message
1524 $content = '<span class="member_done">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1527 default: // Unsupported module!
1528 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unsupported module %s detected.", $mod));
1529 $content = '<span class="member_failed">{--UNKNOWN_MODULE--}</span>';
1533 // Passwords mismatch
1534 $content = '<span class="member_failed">{--MEMBER_PASSWORD_ERROR--}</span>';
1537 // Could not load profile
1538 $content = '<span class="member_failed">{--MEMBER_CANNOT_LOAD_PROFILE--}</span>';
1541 // Send email to user if required
1542 if ((!empty($sub_mem)) && (!empty($message))) {
1544 sendEmail($content['email'], $sub_mem, $message);
1547 // Send only if no other error has occured
1548 if (empty($content)) {
1549 if ((!empty($sub_adm)) && (!empty($message_admin))) {
1551 sendAdminNotification($sub_adm, $message_admin, $content, getMemberId());
1552 } elseif (isAdminNotificationEnabled()) {
1553 // Cannot send mails to admin!
1554 $content = '{--CANNOT_SEND_ADMIN_MAILS--}';
1557 $content = '<span class="member_done">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1562 loadTemplate('admin_settings_saved', false, $content);
1565 // Generates a 'selection box' from given array
1566 function generateSelectionBoxFromArray ($options, $name, $optionValue, $optionContent = '', $extraName = '') {
1568 $OUT = '<select name="' . $name . '" size="1" class="admin_select">
1569 <option value="X" disabled="disabled">{--PLEASE_SELECT--}</option>';
1571 // Walk through all options
1572 foreach ($options as $option) {
1573 // Add the <option> entry
1574 if (empty($optionContent)) {
1575 // ... from template
1576 $OUT .= loadTemplate('select_' . $name . $extraName . '_option', true, $option);
1579 $OUT .= '<option value="' . $option[$optionValue] . '">' . $option[$optionContent] . '</option>';
1583 // Finish selection box
1584 $OUT .= '</select>';
1588 'selection_box' => $OUT,
1591 // Load template and return it
1592 return loadTemplate('select_' . $name . $extraName . '_box', true, $content);
1595 // Prepares the header for HTML output
1596 function loadHtmlHeader () {
1598 // 1.) pre_page_header (mainly loads the page_header template and includes
1599 // meta description)
1600 runFilterChain('pre_page_header');
1602 // Here can be something be added, but normally one of the two filters
1603 // around this line should do the job for you.
1605 // 2.) post_page_header (mainly to load stylesheet, extra JavaScripts and
1606 // to close the head-tag)
1607 // Include more header data here
1608 runFilterChain('post_page_header');
1611 // Adds page header and footer to output array element
1612 function addPageHeaderFooter () {
1616 // Add them all together. This is maybe to simple
1617 foreach (array('page_header', 'output', 'page_footer') as $pagePart) {
1618 // Add page part if set
1619 if (isset($GLOBALS[$pagePart])) $OUT .= $GLOBALS[$pagePart];
1622 // Transfer $OUT to 'output'
1623 $GLOBALS['output'] = $OUT;
1626 // Generates meta description for current module and 'what' value
1627 function generateMetaDescriptionCode () {
1628 // Only include from guest area and if sql_patches has correct version
1629 if ((getModule() == 'index') && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1630 // Construct dynamic description
1631 $DESCR = '{?MAIN_TITLE?} ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu('guest', getWhat());
1633 // Output it directly
1634 $GLOBALS['page_header'] .= '<meta name="description" content="' . $DESCR . '" />';
1638 unset($GLOBALS['ref_level']);
1641 // Generates an FQFN for template cache from the given template name
1642 function generateCacheFqfn ($template, $mode = 'html') {
1644 if (!isset($GLOBALS['template_cache_fqfn'][$template])) {
1645 // Generate the FQFN
1646 $GLOBALS['template_cache_fqfn'][$template] = sprintf(
1647 "%s_compiled/%s/%s.tpl.cache",
1655 return $GLOBALS['template_cache_fqfn'][$template];
1658 // "Fixes" null or empty string to count of dashes
1659 function fixNullEmptyToDashes ($str, $num) {
1660 // Use str as default
1664 if ((is_null($str)) || (trim($str) == '')) {
1666 $return = str_repeat('-', $num);
1669 // Return final string
1673 //-----------------------------------------------------------------------------
1674 // Template Helper Functions
1675 //-----------------------------------------------------------------------------
1677 // Color-switch helper function
1678 function doTemplateColorSwitch ($template, $clear = false, $return = true) {
1680 if (!isset($GLOBALS['color_switch'][$template])) {
1682 initTemplateColorSwitch($template);
1683 } elseif ($clear === false) {
1684 // Switch color if called from loadTemplate()
1685 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SWITCH:' . $template);
1686 $GLOBALS['color_switch'][$template] = 3 - $GLOBALS['color_switch'][$template];
1689 // Return CSS class name
1690 if ($return === true) {
1691 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'RETURN:' . $template . '=' . $GLOBALS['color_switch'][$template]);
1692 return 'switch_sw' . $GLOBALS['color_switch'][$template];
1696 // Helper function for extension registration link
1697 function doTemplateExtensionRegistrationLink ($template, $dummy, $ext_name) {
1698 // Default is all productive
1699 $OUT = '<a title="{--ADMIN_REGISTER_EXTENSION_TITLE--}" href="{%url=modules.php?module=admin&what=extensions&reg_ext=' . $ext_name . '%}">{--ADMIN_REGISTER_EXTENSION--}</a>';
1701 // Is the given extension non-productive?
1702 if (!isExtensionProductive($ext_name)) {
1703 // Non-productive code
1704 $OUT = '<em style="cursor:help" class="admin_note" title="{%message,ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK_TITLE=' . $ext_name . '%}">{--ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK--}</em>';