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, 2010 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?
77 if (empty($str)) $str = '---';
84 function initTemplateColorSwitch ($template) {
85 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'INIT:' . $template);
86 $GLOBALS['color_switch'][$template] = 2;
89 // "Getter" for color switch code
90 function getColorSwitchCode ($template) {
92 $code = "{DQUOTE} . doTemplateColorSwitch('" . $template . "', false, false) . {DQUOTE}";
98 // Output HTML code directly or 'render' it. You addionally switch the new-line character off
99 function outputHtml ($htmlCode, $newLine = true) {
101 if (!isset($GLOBALS['output'])) {
102 $GLOBALS['output'] = '';
105 // Do we have HTML-Code here?
106 if (!empty($htmlCode)) {
107 // Yes, so we handle it as you have configured
108 switch (getOutputMode()) {
110 // That's why you don't need any \n at the end of your HTML code... :-)
111 if (getPhpCaching() == 'on') {
112 // Output into PHP's internal buffer
113 outputRawCode($htmlCode);
115 // That's why you don't need any \n at the end of your HTML code... :-)
116 if ($newLine === true) print("\n");
118 // Render mode for old or lame servers...
119 $GLOBALS['output'] .= $htmlCode;
121 // That's why you don't need any \n at the end of your HTML code... :-)
122 if ($newLine === true) $GLOBALS['output'] .= "\n";
127 // If we are switching from render to direct output rendered code
128 if ((!empty($GLOBALS['output'])) && (getPhpCaching() != 'on')) { outputRawCode($GLOBALS['output']); $GLOBALS['output'] = ''; }
130 // The same as above... ^
131 outputRawCode($htmlCode);
132 if ($newLine === true) print("\n");
136 // Huh, something goes wrong or maybe you have edited config.php ???
137 debug_report_bug(__FUNCTION__, __LINE__, '<strong>{--FATAL_ERROR--}:</strong> {--NO_RENDER_DIRECT--}');
140 } elseif ((getPhpCaching() == 'on') && ((!isset($GLOBALS['header'])) || (count($GLOBALS['header']) == 0))) {
141 // Output cached HTML code
142 $GLOBALS['output'] = ob_get_contents();
144 // Clear output buffer for later output if output is found
145 if (!empty($GLOBALS['output'])) {
149 // Send all HTTP headers
152 // Compile and run finished rendered HTML code
153 compileFinalOutput();
155 // Output code here, DO NOT REMOVE! ;-)
156 outputRawCode($GLOBALS['output']);
157 } elseif ((getOutputMode() == 'render') && (!empty($GLOBALS['output']))) {
158 // Send all HTTP headers
161 // Compile and run finished rendered HTML code
162 compileFinalOutput();
164 // Output code here, DO NOT REMOVE! ;-)
165 outputRawCode($GLOBALS['output']);
167 // And flush all headers
172 // Compiles the final output
173 function compileFinalOutput () {
174 // Add page header and footer
175 addPageHeaderFooter();
177 // Do the final compilation
178 $GLOBALS['output'] = doFinalCompilation($GLOBALS['output']);
180 // Extension 'rewrite' installed?
181 if ((isExtensionActive('rewrite')) && (!isCssOutputMode())) {
182 $GLOBALS['output'] = rewriteLinksInCode($GLOBALS['output']);
187 * @TODO On some pages this is buggy
188 if (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('gzip', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
189 // Compress it for HTTP gzip
190 $GLOBALS['output'] = gzencode($GLOBALS['output'], 9);
193 sendHeader('Content-Encoding: gzip');
194 } elseif (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('deflate', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
195 // Compress it for HTTP deflate
196 $GLOBALS['output'] = gzcompress($GLOBALS['output'], 9);
199 sendHeader('Content-Encoding: deflate');
204 sendHeader('Content-Length: ' . strlen($GLOBALS['output']));
210 // Main compilation loop
211 function doFinalCompilation ($code, $insertComments = true, $enableCodes = true) {
212 // Insert comments? (Only valid with HTML templates, of course)
213 enableTemplateHtml($insertComments);
219 while (((strpos($code, '{--') !== false) || (strpos($code, '{DQUOTE}') !== false) || (strpos($code, '{?') !== false) || (strpos($code, '{%') !== false)) && ($cnt < 5)) {
220 // Init common variables
225 //* DEBUG: */ debugOutput('<pre>'.linenumberCode($code).'</pre>');
226 $eval = '$newContent = "' . str_replace('{DQUOTE}', '"', compileCode(escapeQuotes($code), false, true, $enableCodes)) . '";';
227 //* DEBUG: */ if (!$insertComments) print('EVAL=<pre>'.linenumberCode($eval).'</pre>');
229 //* DEBUG: */ if (!$insertComments) print('NEW=<pre>'.linenumberCode($newContent).'</pre>');
230 //* DEBUG: */ die('<pre>'.encodeEntities($newContent).'</pre>');
232 // Was that eval okay?
233 if (empty($newContent)) {
234 // Something went wrong!
235 debug_report_bug(__FUNCTION__, __LINE__, 'Evaluation error:<pre>' . linenumberCode($eval) . '</pre>', false);
245 // Return the compiled code
249 // Output the raw HTML code
250 function outputRawCode ($htmlCode) {
251 // Output stripped HTML code to avoid broken JavaScript code, etc.
252 print(str_replace('{BACK}', "\\", $htmlCode));
254 // Flush the output if only getPhpCaching() is not 'on'
255 if (getPhpCaching() != 'on') {
261 // Load a template file and return it's content (only it's name; do not use ' or ")
262 function loadTemplate ($template, $return = false, $content = array()) {
263 // @TODO Remove this sanity-check if all is fine
264 if (!is_bool($return)) debug_report_bug(__FUNCTION__, __LINE__, 'return is not bool (' . gettype($return) . ')');
266 // Set current template
267 $GLOBALS['current_template'] = $template;
270 if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template))) {
271 // Evaluate the cache
272 eval(readTemplateCache($template));
273 } elseif (!isset($GLOBALS['template_eval'][$template])) {
274 // Make all template names lowercase
275 $template = strtolower($template);
279 if (empty($GLOBALS['refid'])) $GLOBALS['refid'] = '0';
282 $basePath = sprintf("%stemplates/%s/html/", getPath(), getLanguage());
283 $extraPath = detectExtraTemplatePath($template);;
286 $FQFN = $basePath . $extraPath . $template . '.tpl';
288 // Does the special template exists?
289 if (!isFileReadable($FQFN)) {
290 // Reset to default template
291 $FQFN = $basePath . $template . '.tpl';
294 // Now does the final template exists?
295 if (isFileReadable($FQFN)) {
296 // Count the template load
297 incrementConfigEntry('num_templates');
299 // The local file does exists so we load it. :)
300 $GLOBALS['tpl_content'][$template] = readFromFile($FQFN);
302 // Do we have to compile the code?
304 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)) {
305 // Normal HTML output?
306 if (isHtmlOutputMode()) {
307 // Add surrounding HTML comments to help finding bugs faster
308 $ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'][$template] . '<!-- Template ' . $template . ' - End //-->';
310 // Prepare eval() command
311 $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileCode(escapeQuotes($ret)) . '";';
312 } elseif (substr($template, 0, 3) == 'js_') {
313 // JavaScripts don't like entities and timings
314 $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['tpl_content'][$template])) . '");';
316 // Prepare eval() command, other output doesn't like entities, maybe
317 $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template])) . '");';
320 // Add surrounding HTML comments to help finding bugs faster
321 $ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'][$template] . '<!-- Template ' . $template . ' - End //-->';
322 $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileRawCode(escapeQuotes($ret)) . '";';
324 } elseif ((isAdmin()) || ((isInstalling()) && (!isInstalled()))) {
325 // Only admins shall see this warning or when installation mode is active
326 $ret = '<div class="para">
327 <span class="notice">{--TEMPLATE_404--}</span>
333 {--TEMPLATE_CONTENT--}
334 <pre>' . print_r($content, true) . '</pre>
338 $GLOBALS['template_eval'][$template] = '404';
343 if ((isset($GLOBALS['template_eval'][$template])) && ($GLOBALS['template_eval'][$template] != '404')) {
345 eval($GLOBALS['template_eval'][$template]);
348 // Do we have some content to output or return?
350 // Not empty so let's put it out! ;)
351 if ($return === true) {
352 // Return the HTML code
358 } elseif (isDebugModeEnabled()) {
359 // Warning, empty output!
360 return 'E:' . $template . ',content=<pre>' . print_r($content, true) . '</pre>';
364 // Detects the extra template path from given template name
365 function detectExtraTemplatePath ($template) {
370 if (!isset($GLOBALS['extra_path'][$template])) {
371 // Check for admin/guest/member/etc. templates
372 if (substr($template, 0, 6) == 'admin_') {
373 // Admin template found
374 $extraPath = 'admin/';
375 } elseif (substr($template, 0, 6) == 'guest_') {
376 // Guest template found
377 $extraPath = 'guest/';
378 } elseif (substr($template, 0, 7) == 'member_') {
379 // Member template found
380 $extraPath = 'member/';
381 } elseif (substr($template, 0, 7) == 'select_') {
382 // Selection template found
383 $extraPath = 'select/';
384 } elseif (substr($template, 0, 8) == 'install_') {
385 // Installation template found
386 $extraPath = 'install/';
387 } elseif (substr($template, 0, 4) == 'ext_') {
388 // Extension template found
390 } elseif (substr($template, 0, 3) == 'la_') {
391 // 'Logical-area' template found
393 } elseif (substr($template, 0, 3) == 'js_') {
394 // JavaScript template found
396 } elseif (substr($template, 0, 5) == 'menu_') {
397 // Menu template found
398 $extraPath = 'menu/';
400 // Test for extension
401 $test = substr($template, 0, strpos($template, '_'));
403 // Probe for valid extension name
404 if (isExtensionNameValid($test)) {
405 // Set extra path to extension's name
406 $extraPath = $test . '/';
411 $GLOBALS['extra_path'][$template] = $extraPath;
415 return $GLOBALS['extra_path'][$template];
418 // Loads an email template and compiles it
419 function loadEmailTemplate ($template, $content = array(), $userid = '0') {
422 // Make sure all template names are lowercase!
423 $template = strtolower($template);
425 // Is content an array?
426 if (is_array($content)) {
427 // Add expiration to array
428 if ((isConfigEntrySet('auto_purge')) && (getAutoPurge() == '0')) {
429 // Will never expire!
430 $content['expiration'] = '{--MAIL_WILL_NEVER_EXPIRE--}';
431 } elseif (isConfigEntrySet('auto_purge')) {
432 // Create nice date string
433 $content['expiration'] = createFancyTime(getAutoPurge());
436 $content['expiration'] = '{--MAIL_NO_CONFIG_AUTO_PURGE--}';
441 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UID={$userid},template={$template},content[]=".gettype($content));
442 if ((isValidUserId($userid)) && (is_array($content))) {
443 // If nickname extension is installed, fetch nickname as well
444 if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
445 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NICKNAME!<br />");
447 fetchUserData($userid, 'nickname');
449 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NO-NICK!<br />");
451 fetchUserData($userid);
454 // Merge data if valid
455 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - PRE<br />");
456 if (isUserDataValid()) {
457 $content = merge_array($content, getUserDataArray());
459 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - AFTER<br />");
463 $basePath = sprintf("%stemplates/%s/emails/", getPath(), getLanguage());
466 $extraPath = detectExtraTemplatePath($template);
468 // Generate full FQFN
469 $FQFN = $basePath . $extraPath . $template . '.tpl';
471 // Does the special template exists?
472 if (!isFileReadable($FQFN)) {
473 // Reset to default template
474 $FQFN = $basePath . $template . '.tpl';
477 // Now does the final template exists?
479 if (isFileReadable($FQFN)) {
480 // The local file does exists so we load it. :)
481 $GLOBALS['tpl_content'][$template] = readFromFile($FQFN);
484 $GLOBALS['tpl_content'][$template] = '$newContent = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template])) . '");';
485 eval($GLOBALS['tpl_content'][$template]);
486 } elseif (!empty($template)) {
487 // Template file not found!
488 $newContent = '<div class="para">
489 {--TEMPLATE_404--}: ' . $template . '
492 {--TEMPLATE_CONTENT--}
493 <pre>' . print_r($content, true) . '</pre>
495 <pre>' . print_r($DATA, true) . '</pre>
498 // Debug mode not active? Then remove the HTML tags
499 if (!isDebugModeEnabled()) {
501 $newContent = secureString($newContent);
504 // No template name supplied!
505 $newContent = '{--NO_TEMPLATE_SUPPLIED--}';
508 // Is there some content?
509 if (empty($newContent)) {
511 $newContent = "Compiler error for template " . $template . " !\nUncompiled content:\n" . $GLOBALS['tpl_content'][$template];
513 // Add last error if the required function exists
514 if (function_exists('error_get_last')) $newContent .= "\n--------------------------------------\nDebug:\n".print_r(error_get_last(), true)."--------------------------------------\nPlease don't alter these informations!\nThanx.";
517 // Remove content and data
525 // "Getter" for menu CSS classes, mainly used in templates
526 function getMenuCssClasses ($data) {
527 // $data needs to be converted into an array
528 $content = explode('|', $data);
530 // Non-existent index 2 will happen in menu blocks
531 if (!isset($content[2])) $content[2] = '';
533 // Re-construct the array: 0=visible,1=locked,2=prefix
534 $content['visible'] = $content[0];
535 $content['locked'] = $content[1];
537 // Call our "translator" function
538 $content = translateMenuVisibleLocked($content, $content[2]);
540 // Return CSS classes
541 return ($content['visible_css'] . ' ' . $content['locked_css']);
544 // Generate XHTML code for the CAPTCHA
545 function generateCaptchaCode ($code, $type, $DATA, $userid) {
546 return '<img border="0" alt="Code ' . $code . '" src="{%url=mailid_top.php?userid=' . $userid . '&' . $type . '=' . $DATA . '&mode=img&code=' . $code . '%}" />';
549 // Compiles the given HTML/mail code
550 function compileCode ($code, $simple = false, $constants = true, $full = true) {
551 // Is the code a string?
552 if (!is_string($code)) {
553 // Silently return it
558 $startCompile = microtime(true);
561 $code = compileRawCode($code, $simple, $constants, $full);
564 $compiled = microtime(true);
566 // Add timing if enabled
567 if (isTemplateHtml()) {
568 // Add timing, this should be disabled in
569 $code .= '<!-- Compilation time: ' . (($compiled - $startCompile) * 1000). 'ms //-->';
572 // Return compiled code
576 // Compiles the code (use compileCode() only for HTML because of the comments)
577 // @TODO $simple/$constants are deprecated
578 function compileRawCode ($code, $simple = false, $constants = true, $full = true) {
579 // Is the code a string?
580 if (!is_string($code)) {
581 // Silently return it
585 // Init replacement-array with smaller set of security characters
586 $secChars = $GLOBALS['url_chars'];
588 // Select full set of chars to replace when we e.g. want to compile URLs
589 if ($full === true) $secChars = $GLOBALS['security_chars'];
591 // Compile more through a filter
592 $code = runFilterChain('compile_code', $code);
594 // Compile message strings
595 $code = str_replace('{--', '{%message,', str_replace('--}', '%}', $code));
597 // Compile QUOT and other non-HTML codes
598 foreach ($secChars['to'] as $k => $to) {
599 // Do the reversed thing as in inc/libs/security_functions.php
600 $code = str_replace($to, $secChars['from'][$k], $code);
603 // Find $content[bla][blub] entries
604 // @TODO Do only use $content and deprecate $GLOBALS and $DATA in templates
605 preg_match_all('/\$(content|GLOBALS|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
607 // Are some matches found?
608 if ((count($matches) > 0) && (count($matches[0]) > 0)) {
609 // Replace all matches
610 $matchesFound = array();
611 foreach ($matches[0] as $key => $match) {
612 // Fuzzy look has failed by default
615 // Fuzzy look on match if already found
616 foreach ($matchesFound as $found => $set) {
618 $test = substr($found, 0, strlen($match));
620 // Does this entry exist?
621 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "found={$found},match={$match},set={$set}<br />");
622 if ($test == $match) {
624 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "fuzzyFound!<br />");
631 if ($fuzzyFound === true) continue;
633 // Take all string elements
634 if ((is_string($matches[4][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key.'_' . $matches[4][$key]]))) {
635 // Replace it in the code
636 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "key={$key},match={$match}<br />");
637 $newMatch = str_replace('[', "['", str_replace(']', "']", $match));
638 $code = str_replace($match, '".' . $newMatch . '."', $code);
639 $matchesFound[$key . '_' . $matches[4][$key]] = 1;
640 $matchesFound[$match] = 1;
641 } elseif (!isset($matchesFound[$match])) {
643 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "match={$match}<br />");
644 $code = str_replace($match, '".' . $match . '."', $code);
645 $matchesFound[$match] = 1;
655 function addSelectionBox ($type, $default, $prefix = '', $id = '0', $class = 'form_select') {
659 // This is a yes/no selection only!
660 if ($id > 0) $prefix .= '[' . $id . ']';
661 $OUT .= '<select name="' . $prefix . '" class="' . $class . '" size="1">';
663 // Begin with regular selection box here
664 if (!empty($prefix)) $prefix .= '_';
666 if ($id > 0) $type2 .= '[' . $id . ']';
667 $OUT .= '<select name="' . strtolower($prefix . $type2) . '" class="' . $class . '" size="1">';
672 for ($idx = 1; $idx < 32; $idx++) {
673 $OUT .= '<option value="' . $idx . '"';
674 if ($default == $idx) $OUT .= ' selected="selected"';
675 $OUT .= '>' . $idx . '</option>';
679 case 'month': // Month
680 foreach ($GLOBALS['month_descr'] as $idx => $descr) {
681 $OUT .= '<option value="' . $idx . '"';
682 if ($default == $idx) $OUT .= ' selected="selected"';
683 $OUT .= '>' . $descr . '</option>';
691 // Use configured min age or fixed?
692 if (isExtensionInstalledAndNewer('order', '0.2.1')) {
694 $startYear = $year - getConfig('min_age');
697 $startYear = $year - 16;
700 // Calculate earliest year (100 years old people can still enter Internet???)
701 $minYear = $year - 100;
703 // Check if the default value is larger than minimum and bigger than actual year
704 if (($default > $minYear) && ($default >= $year)) {
705 for ($idx = $year; $idx < ($year + 11); $idx++) {
706 $OUT .= '<option value="' . $idx . '"';
707 if ($default == $idx) $OUT .= ' selected="selected"';
708 $OUT .= '>' . $idx . '</option>';
710 } elseif ($default == -1) {
711 // Current year minus 1
712 for ($idx = $startYear; $idx <= ($year + 1); $idx++) {
713 $OUT .= '<option value="' . $idx . '">' . $idx . '</option>';
716 // Get current year and subtract the configured minimum age
717 $OUT .= '<option value="' . ($minYear - 1) . '"><' . $minYear . '</option>';
718 // Calculate earliest year depending on extension version
719 if (isExtensionInstalledAndNewer('order', '0.2.1')) {
720 // Use configured minimum age
721 $year = getYear() - getConfig('min_age');
723 // Use fixed 16 years age
724 $year = getYear() - 16;
727 // Construct year selection list
728 for ($idx = $minYear; $idx <= $year; $idx++) {
729 $OUT .= '<option value="' . $idx . '"';
730 if ($default == $idx) $OUT .= ' selected="selected"';
731 $OUT .= '>' . $idx . '</option>';
738 for ($idx = 0; $idx < 60; $idx+=5) {
739 if (strlen($idx) == 1) $idx = '0' . $idx;
740 $OUT .= '<option value="' . $idx . '"';
741 if ($default == $idx) $OUT .= ' selected="selected"';
742 $OUT .= '>' . $idx . '</option>';
747 for ($idx = 0; $idx < 24; $idx++) {
748 if (strlen($idx) == 1) $idx = '0' . $idx;
749 $OUT .= '<option value="' . $idx . '"';
750 if ($default == $idx) $OUT .= ' selected="selected"';
751 $OUT .= '>' . $idx . '</option>';
756 $OUT .= '<option value="Y"';
757 if ($default == 'Y') $OUT .= ' selected="selected"';
758 $OUT .= '>{--YES--}</option><option value="N"';
759 if ($default != 'Y') $OUT .= ' selected="selected"';
760 $OUT .= '>{--NO--}</option>';
767 // Insert the code in $img_code into jpeg or PNG image
768 function generateImageOrCode ($img_code, $headerSent = true) {
769 // Is the code size oversized or shouldn't we display it?
770 if ((strlen($img_code) > 6) || (empty($img_code)) || (getConfig('code_length') == '0')) {
771 // Stop execution of function here because of over-sized code length
772 debug_report_bug(__FUNCTION__, __LINE__, 'img_code ' . $img_code .' has invalid length. img_code()=' . strlen($img_code) . ' code_length=' . getConfig('code_length'));
773 } elseif ($headerSent === false) {
774 // Return an HTML code here
775 return '<img src="{%url=img.php?code=' . $img_code . '%}" alt="Image" />';
779 $img = sprintf("%s/theme/%s/images/code_bg.%s",
782 getConfig('img_type')
786 if (isFileReadable($img)) {
788 switch (getConfig('img_type')) {
790 // Okay, load image and hide all errors
791 $image = imagecreatefromjpeg($img);
795 // Okay, load image and hide all errors
796 $image = imagecreatefrompng($img);
800 // Exit function here
801 logDebugMessage(__FUNCTION__, __LINE__, sprintf("File for image type %s not found.", getConfig('img_type')));
805 // Generate text color (red/green/blue; 0 = dark, 255 = bright)
806 $text_color = imagecolorallocate($image, 0, 0, 0);
808 // Insert code into image
809 imagestring($image, 5, 14, 2, $img_code, $text_color);
812 sendHeader('Content-Type: image/' . getConfig('img_type'));
814 // Output image with matching image factory
815 switch (getConfig('img_type')) {
816 case 'jpg': imagejpeg($image); break;
817 case 'png': imagepng($image); break;
820 // Remove image from memory
821 imagedestroy($image);
823 // Create selection box or array of splitted timestamp
824 function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $return_array=false) {
825 // Do not continue if ONE_DAY is absend
826 if (!isConfigEntrySet('ONE_DAY')) {
827 // And return the timestamp itself or empty array
828 if ($return_array === true) {
835 // Calculate 2-seconds timestamp
836 $stamp = round($timestamp);
837 //* DEBUG: */ debugOutput('*' . $stamp .'/' . $timestamp . '*');
839 // Do we have a leap year?
841 $TEST = getYear() / 4;
843 $M2 = getMonth(time() + $timestamp);
845 // If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
846 if ((floor($TEST) == $TEST) && ($M1 == '02') && ($M2 > '02')) $SWITCH = getConfig('ONE_DAY');
848 // First of all years...
849 $Y = abs(floor($timestamp / (31536000 + $SWITCH)));
850 //* DEBUG: */ debugOutput('Y=' . $Y);
852 $M = abs(floor($timestamp / 2628000 - $Y * 12));
853 //* DEBUG: */ debugOutput('M=' . $M);
855 $W = abs(floor($timestamp / 604800 - $Y * ((365 + $SWITCH / getConfig('ONE_DAY')) / 7) - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY')) / 7)));
856 //* DEBUG: */ debugOutput('W=' . $W);
858 $D = abs(floor($timestamp / 86400 - $Y * (365 + $SWITCH / getConfig('ONE_DAY')) - ($M / 12 * (365 + $SWITCH / getConfig('ONE_DAY'))) - $W * 7));
859 //* DEBUG: */ debugOutput('D=' . $D);
861 $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));
862 //* DEBUG: */ debugOutput('h=' . $h);
864 $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));
865 //* DEBUG: */ debugOutput('m=' . $m);
866 // And at last seconds...
867 $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));
868 //* DEBUG: */ debugOutput('s=' . $s);
870 // Is seconds zero and time is < 60 seconds?
871 if (($s == '0') && ($timestamp < 60)) {
873 $s = round($timestamp);
877 // Now we convert them in seconds...
880 // Just put all data in an array for later use
892 $OUT = '<div align="' . $align . '">';
893 $OUT .= '<table border="0" cellspacing="0" cellpadding="0" class="timebox_table dashed">';
896 if (isInString('Y', $display) || (empty($display))) {
897 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_YEARS--}</strong></td>';
900 if (isInString('M', $display) || (empty($display))) {
901 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MONTHS--}</strong></td>';
904 if (isInString('W', $display) || (empty($display))) {
905 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_WEEKS--}</strong></td>';
908 if (isInString('D', $display) || (empty($display))) {
909 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_DAYS--}</strong></td>';
912 if (isInString('h', $display) || (empty($display))) {
913 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_HOURS--}</strong></td>';
916 if (isInString('m', $display) || (empty($display))) {
917 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_MINUTES--}</strong></td>';
920 if (isInString('s', $display) || (empty($display))) {
921 $OUT .= '<td align="center" class="timebox_column bottom"><div class="tiny">{--_SECONDS--}</strong></td>';
927 if (isInString('Y', $display) || (empty($display))) {
928 // Generate year selection
929 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ye" size="1">';
930 for ($idx = 0; $idx <= 10; $idx++) {
931 $OUT .= '<option class="mini_select" value="' . $idx . '"';
932 if ($idx == $Y) $OUT .= ' selected="selected"';
933 $OUT .= '>' . $idx . '</option>';
935 $OUT .= '</select></td>';
937 $OUT .= '<input type="hidden" name="' . $prefix . '_ye" value="0" />';
940 if (isInString('M', $display) || (empty($display))) {
941 // Generate month selection
942 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mo" size="1">';
943 for ($idx = 0; $idx <= 11; $idx++) {
944 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
945 if ($idx == $M) $OUT .= ' selected="selected"';
946 $OUT .= '>' . $idx . '</option>';
948 $OUT .= '</select></td>';
950 $OUT .= '<input type="hidden" name="' . $prefix . '_mo" value="0" />';
953 if (isInString('W', $display) || (empty($display))) {
954 // Generate week selection
955 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_we" size="1">';
956 for ($idx = 0; $idx <= 4; $idx++) {
957 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
958 if ($idx == $W) $OUT .= ' selected="selected"';
959 $OUT .= '>' . $idx . '</option>';
961 $OUT .= '</select></td>';
963 $OUT .= '<input type="hidden" name="' . $prefix . '_we" value="0" />';
966 if (isInString('D', $display) || (empty($display))) {
967 // Generate day selection
968 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_da" size="1">';
969 for ($idx = 0; $idx <= 31; $idx++) {
970 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
971 if ($idx == $D) $OUT .= ' selected="selected"';
972 $OUT .= '>' . $idx . '</option>';
974 $OUT .= '</select></td>';
976 $OUT .= '<input type="hidden" name="' . $prefix . '_da" value="0" />';
979 if (isInString('h', $display) || (empty($display))) {
980 // Generate hour selection
981 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_ho" size="1">';
982 for ($idx = 0; $idx <= 23; $idx++) {
983 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
984 if ($idx == $h) $OUT .= ' selected="selected"';
985 $OUT .= '>' . $idx . '</option>';
987 $OUT .= '</select></td>';
989 $OUT .= '<input type="hidden" name="' . $prefix . '_ho" value="0" />';
992 if (isInString('m', $display) || (empty($display))) {
993 // Generate minute selection
994 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_mi" size="1">';
995 for ($idx = 0; $idx <= 59; $idx++) {
996 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
997 if ($idx == $m) $OUT .= ' selected="selected"';
998 $OUT .= '>' . $idx . '</option>';
1000 $OUT .= '</select></td>';
1002 $OUT .= '<input type="hidden" name="' . $prefix . '_mi" value="0" />';
1005 if (isInString('s', $display) || (empty($display))) {
1006 // Generate second selection
1007 $OUT .= '<td align="center"><select class="mini_select" name="' . $prefix . '_se" size="1">';
1008 for ($idx = 0; $idx <= 59; $idx++) {
1009 $OUT .= ' <option class="mini_select" value="' . $idx . '"';
1010 if ($idx == $s) $OUT .= ' selected="selected"';
1011 $OUT .= '>' . $idx . '</option>';
1013 $OUT .= '</select></td>';
1015 $OUT .= '<input type="hidden" name="' . $prefix . '_se" value="0" />';
1022 // Return generated HTML code
1026 // Generate a list of administrative links to a given userid
1027 function generateMemberAdminActionLinks ($userid) {
1028 // Make sure userid is a number
1029 if ($userid != bigintval($userid)) debug_report_bug(__FUNCTION__, __LINE__, 'userid is not a number!');
1031 // Define all main targets
1032 $targetArray = array('del_user', 'edit_user', 'lock_user', 'add_points', 'sub_points');
1035 $status = getFetchedUserData('userid', $userid, 'status');
1037 // Begin of navigation links
1040 foreach ($targetArray as $tar) {
1041 $OUT .= '<span class="admin_user_link"><a href="{%url=modules.php?module=admin&what=' . $tar . '&userid=' . $userid . '%}" title="{--ADMIN_USER_ACTION_LINK_';
1042 //* DEBUG: */ debugOutput('*' . $tar.'/' . $status.'*');
1043 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
1044 // Locked accounts shall be unlocked
1045 $OUT .= 'UNLOCK_USER';
1047 // All other status is fine
1048 $OUT .= strtoupper($tar);
1050 $OUT .= '_TITLE--}">{--ADMIN_USER_ACTION_LINK_';
1051 if (($tar == 'lock_user') && ($status == 'LOCKED')) {
1052 // Locked accounts shall be unlocked
1053 $OUT .= 'UNLOCK_USER';
1055 // All other status is fine
1056 $OUT .= strtoupper($tar);
1058 $OUT .= '--}</a></span>|';
1061 // Finish navigation link
1062 $OUT = substr($OUT, 0, -1) . ']';
1068 // Generate an email link
1069 function generateEmailLink ($email, $table = 'admins') {
1070 // Default email link (INSECURE! Spammer can read this by harvester programs)
1071 $EMAIL = 'mailto:' . $email;
1073 // Check for several extensions
1074 if ((isExtensionActive('admins')) && ($table == 'admins')) {
1075 // Create email link for contacting admin in guest area
1076 $EMAIL = generateAdminEmailLink($email);
1077 } elseif ((isExtensionInstalledAndNewer('user', '0.3.3')) && ($table == 'user_data')) {
1078 // Create email link for contacting a member within admin area (or later in other areas, too?)
1079 $EMAIL = generateUserEmailLink($email);
1080 } elseif ((isExtensionActive('sponsor')) && ($table == 'sponsor_data')) {
1081 // Create email link to contact sponsor within admin area (or like the link above?)
1082 $EMAIL = generateSponsorEmailLink($email);
1085 // Shall I close the link when there is no admin?
1086 if ((!isAdmin()) && ($EMAIL == $email)) $EMAIL = '#'; // Closed!
1088 // Return email link
1092 // Output error messages in a fasioned way and die...
1093 function app_die ($F, $L, $message) {
1094 // Check if Script is already dieing and not let it kill itself another 1000 times
1095 if (!isset($GLOBALS['app_died'])) {
1096 // Make sure, that the script realy realy diese here and now
1097 $GLOBALS['app_died'] = true;
1099 // Set content type as text/html
1100 setContentType('text/html');
1103 loadIncludeOnce('inc/header.php');
1105 // Rewrite message for output
1106 $message = sprintf(getMessage('MAILER_HAS_DIED'), basename($F), $L, $message);
1108 // Load the message template
1109 loadTemplate('app_die_message', false, $message);
1112 loadIncludeOnce('inc/footer.php');
1114 // Script tried to kill itself twice
1115 die('['.__FUNCTION__.':'.__LINE__.']: Script wanted to kill itself more than once! Raw message=' . $message . ', file/function=' . $F . ', line=' . $L);
1119 // Display parsing time and number of SQL queries in footer
1120 function displayParsingTime () {
1121 // Is the timer started?
1122 if (!isset($GLOBALS['startTime'])) {
1128 $endTime = microtime(true);
1130 // "Explode" both times
1131 $start = explode(' ', $GLOBALS['startTime']);
1132 $end = explode(' ', $endTime);
1133 $runTime = $end[0] - $start[0];
1139 // @TODO This can be easily moved out after the merge from EL branch to this is complete
1141 'run_time' => $runTime,
1142 'sql_time' => (getConfig('sql_time') * 1000),
1145 // Load the template
1146 $GLOBALS['page_footer'] .= loadTemplate('show_timings', true, $content);
1149 // Output a debug backtrace to the user
1150 function debug_report_bug ($F, $L, $message = '', $sendEmail = true) {
1151 // Is this already called?
1152 if (isset($GLOBALS[__FUNCTION__])) {
1154 print 'Message:' . $message . '<br />Backtrace:<pre>';
1155 debug_print_backtrace();
1159 // Set this function as called
1160 $GLOBALS[__FUNCTION__] = true;
1165 // Is the optional message set?
1166 if (!empty($message)) {
1168 $debug = sprintf("Note: %s<br />\n",
1172 // @TODO Add a little more infos here
1173 logDebugMessage($F, $L, strip_tags($message));
1177 $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>';
1178 $debug .= debug_get_printable_backtrace();
1180 $debug .= '<div class="para">Request-URI: ' . getRequestUri() . '</div>';
1181 $debug .= '<div class="para">Thank you for finding bugs.</div>';
1183 // Send an email? (e.g. not wanted for evaluation errors)
1184 if (($sendEmail === true) && (!isInstallationPhase())) {
1187 'message' => trim($message),
1188 'backtrace' => trim(debug_get_mailable_backtrace())
1191 // Send email to webmaster
1192 sendAdminNotification('{--DEBUG_REPORT_BUG_SUBJECT--}', 'admin_report_bug', $content);
1196 app_die($F, $L, $debug);
1199 // Compile characters which are allowed in URLs
1200 function compileUriCode ($code, $simple = true) {
1201 // Compile constants
1202 if ($simple === false) $code = str_replace('{--', '".', str_replace('--}', '."', $code));
1204 // Compile QUOT and other non-HTML codes
1205 $code = str_replace('{DOT}', '.',
1206 str_replace('{SLASH}', '/',
1207 str_replace('{QUOT}', "'",
1208 str_replace('{DOLLAR}', '$',
1209 str_replace('{OPEN_ANCHOR}', '(',
1210 str_replace('{CLOSE_ANCHOR}', ')',
1211 str_replace('{OPEN_SQR}', '[',
1212 str_replace('{CLOSE_SQR}', ']',
1213 str_replace('{PER}', '%',
1217 // Return compiled code
1221 // Handle message codes from URL
1222 function handleCodeMessage () {
1223 if (isGetRequestParameterSet('code')) {
1224 // Default extension is 'unknown'
1227 // Is extension given?
1228 if (isGetRequestParameterSet('ext')) $ext = getRequestParameter('ext');
1230 // Convert the 'code' parameter from URL to a human-readable message
1231 $message = getMessageFromErrorCode(getRequestParameter('code'));
1233 // Load message template
1234 loadTemplate('message', false, $message);
1238 // Generates a 'extension foo inactive' message
1239 function generateExtensionInactiveMessage ($ext_name) {
1240 // Is the extension empty?
1241 if (empty($ext_name)) {
1242 // This should not happen
1243 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1247 $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_INACTIVE', $ext_name);
1249 // Is an admin logged in?
1251 // Then output admin message
1252 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE', $ext_name);
1255 // Return prepared message
1259 // Generates a 'extension foo not installed' message
1260 function generateExtensionNotInstalledMessage ($ext_name) {
1261 // Is the extension empty?
1262 if (empty($ext_name)) {
1263 // This should not happen
1264 debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
1268 $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
1270 // Is an admin logged in?
1272 // Then output admin message
1273 $message = getMaskedMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_NOT_INSTALLED', $ext_name);
1276 // Return prepared message
1280 // Generates a message depending on if the extension is not installed or not
1282 function generateExtensionInactiveNotInstalledMessage ($ext_name) {
1286 // Is the extension not installed or just deactivated?
1287 switch (isExtensionInstalled($ext_name)) {
1288 case true; // Deactivated!
1289 $message = generateExtensionInactiveMessage($ext_name);
1292 case false; // Not installed!
1293 $message = generateExtensionNotInstalledMessage($ext_name);
1296 default: // Should not happen!
1297 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Invalid state of extension %s detected.", $ext_name));
1298 $message = sprintf("Invalid state of extension %s detected.", $ext_name);
1302 // Return the message
1306 // Print code with line numbers
1307 function linenumberCode ($code) {
1308 if (!is_array($code)) $codeE = explode("\n", $code); else $codeE = $code;
1309 $count_lines = count($codeE);
1311 $r = 'Line | Code:<br />';
1312 foreach($codeE as $line => $c) {
1313 $r .= '<div class="line"><span class="linenum">';
1314 if ($count_lines == 1) {
1317 $r .= ($line == ($count_lines - 1)) ? '' : ($line+1);
1322 $r .= '<span class="linetext">' . encodeEntities($c) . '</span></div>';
1325 return '<div class="code">' . $r . '</div>';
1328 // Determines the right page title
1329 function determinePageTitle () {
1330 // Config and database connection valid?
1331 if ((isConfigLocalLoaded()) && (isConfigurationLoaded()) && (SQL_IS_LINK_UP()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1335 // Title decoration enabled?
1336 if ((isTitleDecorationEnabled()) && (getConfig('title_left') != '')) $TITLE .= trim(getConfig('title_left')) . ' ';
1338 // Do we have some extra title?
1339 if (isExtraTitleSet()) {
1341 $TITLE .= getExtraTitle() . ' by ';
1345 $TITLE .= getMainTitle();
1347 // Add title of module? (middle decoration will also be added!)
1348 if ((isModuleTitleEnabled()) || ((!isWhatSet()) && (!isActionSet())) || (getModule() == 'admin')) {
1349 $TITLE .= ' ' . trim(getConfig('title_middle')) . ' {DQUOTE} . getModuleTitle(getModule()) . {DQUOTE}';
1352 // Add title from what file
1354 if (getModule() == 'login') $mode = 'member';
1355 elseif (getModule() == 'index') $mode = 'guest';
1356 if ((!empty($mode)) && (isWhatTitleEnabled())) $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu($mode, getWhat());
1358 // Add title decorations? (right)
1359 if ((isTitleDecorationEnabled()) && (getConfig('title_right') != '')) $TITLE .= ' ' . trim(getConfig('title_right'));
1361 // Remember title in constant for the template
1362 $pageTitle = $TITLE;
1363 } elseif ((isInstalled()) && (isAdminRegistered())) {
1364 // Installed, admin registered but no ext-sql_patches
1365 $pageTitle = '[-- ' . getMainTitle() . ' - ' . getModuleTitle(getModule()) . ' --]';
1366 } elseif ((isInstalled()) && (!isAdminRegistered())) {
1367 // Installed but no admin registered
1368 $pageTitle = '{--INSTALLER_OF_MAILER_NO_ADMIN--}';
1369 } elseif ((!isInstalled()) || (!isAdminRegistered())) {
1370 // Installation mode
1371 $pageTitle = '{--INSTALLER_OF_MAILER--}';
1373 // Configuration not found!
1374 $pageTitle = '{--NO_CONFIG_FOUND_TITLE--}';
1376 // Do not add the fatal message in installation mode
1377 if ((!isInstalling()) && (!isConfigurationLoaded())) addFatalMessage(__FUNCTION__, __LINE__, '{--NO_CONFIG_FOUND--}');
1381 return decodeEntities($pageTitle);
1384 // Checks wethere there is a cache file there. This function is cached.
1385 function isTemplateCached ($template) {
1386 // Do we have cached this result?
1387 if (!isset($GLOBALS['template_cache'][$template])) {
1389 $FQFN = generateCacheFqfn($template);
1392 $GLOBALS['template_cache'][$template] = isFileReadable($FQFN);
1396 return $GLOBALS['template_cache'][$template];
1399 // Flushes non-flushed template cache to disk
1400 function flushTemplateCache ($template, $eval) {
1401 // Is this cache flushed?
1402 if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template) === false) && ($eval != '404')) {
1404 $FQFN = generateCacheFqfn($template);
1407 writeToFile($FQFN, $eval, true);
1411 // Reads a template cache
1412 function readTemplateCache ($template) {
1414 if ((isDebuggingTemplateCache()) || (!isTemplateCached($template))) {
1415 // This should not happen
1416 debug_report_bug('Wether debugging of template cache is enabled or template ' . $template . ' is not cached while expected.');
1420 if (!isset($GLOBALS['template_eval'][$template])) {
1422 $FQFN = generateCacheFqfn($template);
1425 $GLOBALS['template_eval'][$template] = readFromFile($FQFN);
1429 return $GLOBALS['template_eval'][$template];
1432 // Escapes quotes (default is only double-quotes)
1433 function escapeQuotes ($str, $single = false) {
1434 // Should we escape all?
1435 if ($single === true) {
1436 // Escape all (including null)
1437 $str = addslashes($str);
1439 // Remove escaping of single quotes
1440 $str = str_replace("\'", "'", $str);
1442 // Escape only double-quotes but prevent double-quoting
1443 $str = str_replace("\\\\", "\\", str_replace('"', "\\\"", $str));
1446 // Return the escaped string
1450 // Escapes the JavaScript code, prevents \r and \n becoming char 10/13
1451 function escapeJavaScriptQuotes ($str) {
1452 // Replace all double-quotes and secure back-ticks
1453 $str = str_replace('"', '\"', str_replace("\\", '{BACK}', $str));
1459 // Send out mails depending on the 'mod/modes' combination
1460 // @TODO Lame description for this function
1461 function sendModeMails ($mod, $modes) {
1463 if (fetchUserData(getMemberId())) {
1464 // Extract salt from cookie
1465 $salt = substr(getSession('u_hash'), 0, -40);
1467 // Now let's compare passwords
1468 $hash = encodeHashForCookie(getUserData('password'));
1470 // Does the hash match or should we change it?
1471 if (($hash == getSession('u_hash')) || (postRequestParameter('pass1') == postRequestParameter('pass2'))) {
1473 $content = getUserDataArray();
1475 // Clear/init the content variable
1476 $content['message'] = '';
1479 // @TODO Move this in a filter
1482 foreach ($modes as $mode) {
1484 case 'normal': break; // Do not add any special lines
1485 case 'email': // Email was changed!
1486 $content['message'] = '{--MEMBER_CHANGED_EMAIL--}' . ': ' . postRequestParameter('old_email') . "\n";
1489 case 'password': // Password was changed
1490 $content['message'] = '{--MEMBER_CHANGED_PASS--}' . "\n";
1494 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unknown mode %s detected.", $mode));
1495 $content['message'] = '{--MEMBER_UNKNOWN_MODE--}' . ': ' . $mode . "\n\n";
1500 if (isExtensionActive('country')) {
1501 // Replace code with description
1502 $content['country'] = generateCountryInfo(postRequestParameter('country_code'));
1505 // Merge content with data from POST
1506 $content = merge_array($content, postRequestArray());
1509 $message = loadEmailTemplate('member_mydata_notify', $content, getMemberId());
1511 if (isAdminNotificationEnabled()) {
1512 // The admin needs to be notified about a profile change
1513 $message_admin = 'admin_mydata_notify';
1514 $sub_adm = '{--ADMIN_CHANGED_DATA--}';
1517 $message_admin = '';
1521 // Set subject lines
1522 $sub_mem = '{--MEMBER_CHANGED_DATA--}';
1524 // Output success message
1525 $content = '<span class="message">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1528 default: // Unsupported module!
1529 logDebugMessage(__FUNCTION__, __LINE__, sprintf("Unsupported module %s detected.", $mod));
1530 $content = '<span class="notice">{--UNKNOWN_MODULE--}</span>';
1534 // Passwords mismatch
1535 $content = '<span class="notice">{--MEMBER_PASSWORD_ERROR--}</span>';
1538 // Could not load profile
1539 $content = '<span class="notice">{--MEMBER_CANNOT_LOAD_PROFILE--}</span>';
1542 // Send email to user if required
1543 if ((!empty($sub_mem)) && (!empty($message))) {
1545 sendEmail($content['email'], $sub_mem, $message);
1548 // Send only if no other error has occured
1549 if (empty($content)) {
1550 if ((!empty($sub_adm)) && (!empty($message_admin))) {
1552 sendAdminNotification($sub_adm, $message_admin, $content, getMemberId());
1553 } elseif (isAdminNotificationEnabled()) {
1554 // Cannot send mails to admin!
1555 $content = '{--CANNOT_SEND_ADMIN_MAILS--}';
1558 $content = '<span class="message">{--MEMBER_MYDATA_MAIL_SENT--}</span>';
1563 loadTemplate('admin_settings_saved', false, $content);
1566 // Generates a 'selection box' from given array
1567 function generateSelectionBoxFromArray ($options, $name, $optionValue, $optionContent = '', $extraName = '') {
1569 $OUT = '<select name="' . $name . '" size="1" class="form_select">
1570 <option value="X" disabled="disabled">{--PLEASE_SELECT--}</option>';
1572 // Walk through all options
1573 foreach ($options as $option) {
1574 // Add the <option> entry
1575 if (empty($optionContent)) {
1576 // ... from template
1577 $OUT .= loadTemplate('select_' . $name . $extraName . '_option', true, $option);
1580 $OUT .= '<option value="' . $option[$optionValue] . '">' . $option[$optionContent] . '</option>';
1584 // Finish selection box
1585 $OUT .= '</select>';
1589 'selection_box' => $OUT,
1592 // Load template and return it
1593 return loadTemplate('select_' . $name . $extraName . '_box', true, $content);
1596 // Prepares the header for HTML output
1597 function loadHtmlHeader () {
1599 // 1.) pre_page_header (mainly loads the page_header template and includes
1600 // meta description)
1601 runFilterChain('pre_page_header');
1603 // Here can be something be added, but normally one of the two filters
1604 // around this line should do the job for you.
1606 // 2.) post_page_header (mainly to load stylesheet, extra JavaScripts and
1607 // to close the head-tag)
1608 // Include more header data here
1609 runFilterChain('post_page_header');
1612 // Adds page header and footer to output array element
1613 function addPageHeaderFooter () {
1617 // Add them all together. This is maybe to simple
1618 foreach (array('page_header', 'output', 'page_footer') as $pagePart) {
1619 // Add page part if set
1620 if (isset($GLOBALS[$pagePart])) $OUT .= $GLOBALS[$pagePart];
1623 // Transfer $OUT to 'output'
1624 $GLOBALS['output'] = $OUT;
1627 // Generates meta description for current module and 'what' value
1628 function generateMetaDescriptionCode () {
1629 // Only include from guest area and if sql_patches has correct version
1630 if ((getModule() == 'index') && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
1631 // Construct dynamic description
1632 $DESCR = '{?MAIN_TITLE?} ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu('guest', getWhat());
1634 // Output it directly
1635 $GLOBALS['page_header'] .= '<meta name="description" content="' . $DESCR . '" />';
1639 unset($GLOBALS['ref_level']);
1642 // Generates an FQFN for template cache from the given template name
1643 function generateCacheFqfn ($template, $mode = 'html') {
1645 if (!isset($GLOBALS['template_cache_fqfn'][$template])) {
1646 // Generate the FQFN
1647 $GLOBALS['template_cache_fqfn'][$template] = sprintf(
1648 "%s_compiled/%s/%s.tpl.cache",
1656 return $GLOBALS['template_cache_fqfn'][$template];
1659 // "Fixes" null or empty string to count of dashes
1660 function fixNullEmptyToDashes ($str, $num) {
1661 // Use str as default
1665 if ((is_null($str)) || (trim($str) == '')) {
1667 $return = str_repeat('-', $num);
1670 // Return final string
1674 //-----------------------------------------------------------------------------
1675 // Template Helper Functions
1676 //-----------------------------------------------------------------------------
1678 // Color-switch helper function
1679 function doTemplateColorSwitch ($template, $clear = false, $return = true) {
1681 if (!isset($GLOBALS['color_switch'][$template])) {
1683 initTemplateColorSwitch($template);
1684 } elseif ($clear === false) {
1685 // Switch color if called from loadTemplate()
1686 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'SWITCH:' . $template);
1687 $GLOBALS['color_switch'][$template] = 3 - $GLOBALS['color_switch'][$template];
1690 // Return CSS class name
1691 if ($return === true) {
1692 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'RETURN:' . $template . '=' . $GLOBALS['color_switch'][$template]);
1693 return 'switch_sw' . $GLOBALS['color_switch'][$template];
1697 // Helper function for extension registration link
1698 function doTemplateExtensionRegistrationLink ($template, $dummy, $ext_name) {
1699 // Default is all productive
1700 $OUT = '<a title="{--ADMIN_REGISTER_EXTENSION_TITLE--}" href="{%url=modules.php?module=admin&what=extensions&reg_ext=' . $ext_name . '%}">{--ADMIN_REGISTER_EXTENSION--}</a>';
1702 // Is the given extension non-productive?
1703 if (!isExtensionProductive($ext_name)) {
1704 // Non-productive code
1705 $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>';