X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Ftemplate-functions.php;h=00642e5d25dca5bddb080862334ac6b5caa5a286;hp=6e2e4730660d0f0e803575ab0fc29e97f4435cb1;hb=8fad776382e63b3f73f8dbe289f229d79cfc2c22;hpb=ed3a88c0334600c7d7246480008c79716aa3f80b
diff --git a/inc/template-functions.php b/inc/template-functions.php
index 6e2e473066..00642e5d25 100644
--- a/inc/template-functions.php
+++ b/inc/template-functions.php
@@ -16,8 +16,8 @@
* $Author:: $ *
* -------------------------------------------------------------------- *
* Copyright (c) 2003 - 2009 by Roland Haeder *
- * Copyright (c) 2009 - 2011 by Mailer Developer Team *
- * For more information visit: http://www.mxchange.org *
+ * Copyright (c) 2009 - 2012 by Mailer Developer Team *
+ * For more information visit: http://mxchange.org *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
@@ -50,7 +50,7 @@ function enableTemplateHtml ($enable = true) {
$GLOBALS['is_template_html'] = (bool) $enable;
}
-// Checks wether the template is HTML or not by previously set flag
+// Checks whether the template is HTML or not by previously set flag
// Default: true
function isTemplateHtml () {
// Is the output_mode other than 0 (HTML), then no comments are enabled
@@ -70,13 +70,8 @@ function debugOutput ($message) {
// "Fixes" an empty string into three dashes (use for templates)
function fixEmptyContentToDashes ($str) {
- // Trim the string
- $str = trim($str);
-
- // Is the string empty?
- if (empty($str)) {
- $str = '---';
- } // END - if
+ // Call inner function
+ $str = fixNullEmptyToDashes($str, 3);
// Return string
return $str;
@@ -100,51 +95,62 @@ function getColorSwitchCode ($template) {
// Output HTML code directly or 'render' it. You addionally switch the new-line character off
function outputHtml ($htmlCode, $newLine = true) {
// Init output
- if (!isset($GLOBALS['output'])) {
- $GLOBALS['output'] = '';
+ if (!isset($GLOBALS['__output'])) {
+ $GLOBALS['__output'] = '';
} // END - if
- // Do we have HTML-Code here?
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getOutputMode()=' . getOutputMode() . ',htmlCode(length)=' . strlen($htmlCode) . ',output(length)=' . strlen($GLOBALS['__output']));
+ // Is there HTML-Code here?
if (!empty($htmlCode)) {
// Yes, so we handle it as you have configured
switch (getOutputMode()) {
case 'render':
- // That's why you don't need any \n at the end of your HTML code... :-)
+ // But if PHP is caching, then we don't need to do that
if (getPhpCaching() == 'on') {
// Output into PHP's internal buffer
outputRawCode($htmlCode);
// That's why you don't need any \n at the end of your HTML code... :-)
- if ($newLine === true) print("\n");
+ if ($newLine === true) {
+ outputRawCode(chr(10));
+ } // END - if
} else {
// Render mode for old or lame servers...
- $GLOBALS['output'] .= $htmlCode;
+ $GLOBALS['__output'] .= $htmlCode;
// That's why you don't need any \n at the end of your HTML code... :-)
- if ($newLine === true) $GLOBALS['output'] .= "\n";
+ if ($newLine === true) {
+ $GLOBALS['__output'] .= chr(10);
+ } // END - if
}
break;
case 'direct':
- // If we are switching from render to direct output rendered code
- if ((!empty($GLOBALS['output'])) && (getPhpCaching() != 'on')) { outputRawCode($GLOBALS['output']); $GLOBALS['output'] = ''; }
+ // If we are switching from 'render' to 'direct' mode, all data in '__output' must be flushed and cleared
+ if ((!empty($GLOBALS['__output'])) && (getPhpCaching() != 'on')) {
+ outputRawCode($GLOBALS['__output']);
+ $GLOBALS['__output'] = '';
+ } // END - if
// The same as above... ^
outputRawCode($htmlCode);
- if ($newLine === true) print("\n");
+ if ($newLine === true) {
+ outputRawCode(chr(10));
+ } // END - if
break;
default:
// Huh, something goes wrong or maybe you have edited config.php ???
- debug_report_bug(__FUNCTION__, __LINE__, '{--FATAL_ERROR--}: {--NO_RENDER_DIRECT--}');
+ reportBug(__FUNCTION__, __LINE__, '{--FATAL_ERROR--}: {--NO_RENDER_DIRECT--}');
break;
} // END - switch
- } elseif ((getPhpCaching() == 'on') && ((!isset($GLOBALS['header'])) || (count($GLOBALS['header']) == 0))) {
+ } elseif ((getPhpCaching() == 'on') && ((!isset($GLOBALS['http_header'])) || (count($GLOBALS['http_header']) == 0)) && (!isRawOutputMode())) {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'getPhpCaching()=' . getPhpCaching() . ',isset(http_header)=' . intval(isset($GLOBALS['http_header'])) . ',getScriptOutputMode()=' . getScriptOutputMode() . '');
// Output cached HTML code
- $GLOBALS['output'] = ob_get_contents();
+ $GLOBALS['__output'] = ob_get_contents();
// Clear output buffer for later output if output is found
- if (!empty($GLOBALS['output'])) {
+ if (!empty($GLOBALS['__output'])) {
clearOutputBuffer();
} // END - if
@@ -155,8 +161,8 @@ function outputHtml ($htmlCode, $newLine = true) {
compileFinalOutput();
// Output code here, DO NOT REMOVE! ;-)
- outputRawCode($GLOBALS['output']);
- } elseif ((getOutputMode() == 'render') && (!empty($GLOBALS['output']))) {
+ outputRawCode($GLOBALS['__output']);
+ } elseif ((getOutputMode() == 'render') && (!empty($GLOBALS['__output'])) && (!isRawOutputMode())) {
// Send all HTTP headers
sendHttpHeaders();
@@ -164,49 +170,51 @@ function outputHtml ($htmlCode, $newLine = true) {
compileFinalOutput();
// Output code here, DO NOT REMOVE! ;-)
- outputRawCode($GLOBALS['output']);
+ outputRawCode($GLOBALS['__output']);
} else {
// And flush all headers
- flushHeaders();
+ flushHttpHeaders();
}
}
// Compiles the final output
function compileFinalOutput () {
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '__output(length)=' . strlen($GLOBALS['__output']) . ',getScriptOutputMode()=' . getScriptOutputMode() . ' - ENTERED!');
// Add page header and footer
addPageHeaderFooter();
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, '__output(length)=' . strlen($GLOBALS['__output']) . ' - After addPageHeaderFooter() call.');
// Do the final compilation
- $GLOBALS['output'] = doFinalCompilation($GLOBALS['output']);
+ $GLOBALS['__output'] = compileUriCode(doFinalCompilation($GLOBALS['__output']));
// Extension 'rewrite' installed?
if ((isExtensionActive('rewrite')) && (!isCssOutputMode())) {
- $GLOBALS['output'] = rewriteLinksInCode($GLOBALS['output']);
+ $GLOBALS['__output'] = rewriteLinksInCode($GLOBALS['__output']);
} // END - if
// Compress it?
/**
* @TODO On some pages this is buggy
- if (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('gzip', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
+ if (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (isInStringIgnoreCase('gzip', $_SERVER['HTTP_ACCEPT_ENCODING']))) {
// Compress it for HTTP gzip
- $GLOBALS['output'] = gzencode($GLOBALS['output'], 9);
+ $GLOBALS['__output'] = gzencode($GLOBALS['__output'], 9);
// Add header
- sendHeader('Content-Encoding: gzip');
- } elseif (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('deflate', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
+ addHttpHeader('Content-Encoding: gzip');
+ } elseif (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (isInStringIgnoreCase('deflate', $_SERVER['HTTP_ACCEPT_ENCODING']))) {
// Compress it for HTTP deflate
- $GLOBALS['output'] = gzcompress($GLOBALS['output'], 9);
+ $GLOBALS['__output'] = gzcompress($GLOBALS['__output'], 9);
// Add header
- sendHeader('Content-Encoding: deflate');
+ addHttpHeader('Content-Encoding: deflate');
}
*/
// Add final length
- sendHeader('Content-Length: ' . strlen($GLOBALS['output']));
+ addHttpHeader('Content-Length: ' . strlen($GLOBALS['__output']));
// Flush all headers
- flushHeaders();
+ flushHttpHeaders();
}
// Main compilation loop
@@ -218,7 +226,7 @@ function doFinalCompilation ($code, $insertComments = true, $enableCodes = true)
$count = 0;
// Compile all out
- while (((strpos($code, '{--') !== false) || (strpos($code, '{DQUOTE}') !== false) || (strpos($code, '{?') !== false) || (strpos($code, '{%') !== false)) && ($count < 7)) {
+ while (((isInString('{--', $code)) || (isInString('{DQUOTE}', $code)) || (isInString('{?', $code)) || (isInString('{%', $code) !== false)) && ($count < 7)) {
// Init common variables
$content = array();
$newContent = '';
@@ -234,7 +242,7 @@ function doFinalCompilation ($code, $insertComments = true, $enableCodes = true)
// Was that eval okay?
if (empty($newContent)) {
// Something went wrong!
- debug_report_bug(__FUNCTION__, __LINE__, 'Evaluation error:
');
eval($GLOBALS['template_eval'][$template]);
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'template=' . $template . ' - AFTER EVAL');
} // END - if
- // Do we have some content to output or return?
+ // Is there some content to output or return?
if (!empty($ret)) {
// Not empty so let's put it out! ;)
if ($return === true) {
@@ -387,7 +399,7 @@ function detectExtraTemplatePath ($template) {
// Default is empty
$extraPath = '';
- // Do we have cache?
+ // Is there cache?
if (!isset($GLOBALS['extra_path'][$template])) {
// Check for admin/guest/member/etc. templates
if (substr($template, 0, 6) == 'admin_') {
@@ -438,12 +450,12 @@ function detectExtraTemplatePath ($template) {
// Loads an email template and compiles it
function loadEmailTemplate ($template, $content = array(), $userid = NULL, $loadUserData = true) {
- // @TODO $DATA is deprecated and should be avoided and replaced with $content
- global $DATA;
-
// Make sure all template names are lowercase!
$template = strtolower($template);
+ // Set current template
+ $GLOBALS['current_template'] = $template;
+
// Is content an array?
if (is_array($content)) {
// Add expiration to array
@@ -459,36 +471,6 @@ function loadEmailTemplate ($template, $content = array(), $userid = NULL, $load
}
} // END - if
- // Load user's data
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'UID=' . $userid . ',template=' . $template . ',content[]=' . gettype($content));
- if ((isValidUserId($userid)) && (is_array($content))) {
- // If nickname extension is installed, fetch nickname as well
- if ((isExtensionActive('nickname')) && (isNicknameUsed($userid))) {
- // Load by nickname
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - NICKNAME!');
- fetchUserData($userid, 'nickname');
- } elseif (isNicknameUsed($userid)) {
- // Non-number characters entered but no ext-nickname found
- debug_report_bug(__FUNCTION__, __LINE__, 'userid=' . $userid . ': is no id number and ext-nickname is gone.');
- } else {
- // Load by userid
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - USERID!');
- fetchUserData($userid);
- }
-
- // Merge data if valid
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'content()=' . count($content) . ' - PRE!');
- if ((isUserDataValid()) && ($loadUserData === true)) {
- // It is valid
- $content = merge_array($content, getUserDataArray());
-
- // But we don't like hashed passwords be mailed
- unset($content['password']);
- } // END - if
-
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'content()=' . count($content) . ' - AFTER!');
- } // END - if
-
// Base directory
$basePath = sprintf("%stemplates/%s/emails/", getPath(), getLanguage());
@@ -521,8 +503,6 @@ function loadEmailTemplate ($template, $content = array(), $userid = NULL, $load
{--TEMPLATE_CONTENT--}:
' . print_r($content, true) . '
- {--TEMPLATE_DATA--}:
-
' . print_r($DATA, true) . '
';
// Debug mode not active? Then remove the HTML tags
@@ -535,18 +515,20 @@ function loadEmailTemplate ($template, $content = array(), $userid = NULL, $load
$newContent = '{--NO_TEMPLATE_SUPPLIED--}';
}
- // Is there some content?
+ // Are there some content?
if (empty($newContent)) {
// Compiling failed
$newContent = "Compiler error for template " . $template . " !\nUncompiled content:\n" . $GLOBALS['tpl_content'][$template];
// Add last error if the required function exists
- if (function_exists('error_get_last')) $newContent .= "\n--------------------------------------\nDebug:\n".print_r(error_get_last(), true)."--------------------------------------\nPlease don't alter these informations!\nThanx.";
+ if (function_exists('error_get_last')) {
+ // Add last error and some lines for better overview
+ $newContent .= "\n--------------------------------------\nDebug:\n".print_r(error_get_last(), true)."--------------------------------------\nPlease don't alter these informations!\nThanx.";
+ } // END - if
} // END - if
// Remove content and data
unset($content);
- unset($DATA);
// Return content
return $newContent;
@@ -554,26 +536,36 @@ function loadEmailTemplate ($template, $content = array(), $userid = NULL, $load
// "Getter" for menu CSS classes, mainly used in templates
function getMenuCssClasses ($data) {
- // $data needs to be converted into an array
- $content = explode('|', $data);
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'data=' . $data);
+
+ // Is there cache?
+ if (!isset($GLOBALS[__FUNCTION__][$data])) {
+ // $data needs to be converted into an array
+ $content = explode('|', $data);
- // Non-existent index 2 will happen in menu blocks
- if (!isset($content[2])) $content[2] = '';
+ // Non-existent index 2 will happen in menu blocks
+ if (!isset($content[2])) {
+ $content[2] = '';
+ } // END - if
- // Re-construct the array: 0=visible,1=locked,2=prefix
- $content['visible'] = $content[0];
- $content['locked'] = $content[1];
+ // Re-construct the array: 0=visible,1=locked,2=prefix
+ $content['visible'] = $content[0];
+ $content['locked'] = $content[1];
- // Call our "translator" function
- $content = translateMenuVisibleLocked($content, $content[2]);
+ // Call our "translator" function
+ $content = translateMenuVisibleLocked($content, $content[2]);
+
+ // Set it in cache
+ $GLOBALS[__FUNCTION__][$data] = ($content['visible_css'] . ' ' . $content['locked_css']);
+ } // END - if
- // Return CSS classes
- return ($content['visible_css'] . ' ' . $content['locked_css']);
+ // Return cache
+ return $GLOBALS[__FUNCTION__][$data];
}
// Generate XHTML code for the CAPTCHA
-function generateCaptchaCode ($code, $type, $type, $userid) {
- return '';
+function generateCaptchaCode ($code, $type, $urlId, $userid) {
+ return '';
}
// Compiles the given HTML/mail code
@@ -591,19 +583,19 @@ function compileCode ($code, $simple = false, $constants = true, $full = true, $
$code = compileRawCode($code, $simple, $constants, $full);
// Get timing
- $compiled = microtime(true);
+ $compilationTime = $startCompile - microtime(true);
// Add timing if enabled
if (isTemplateHtml()) {
// Add timing, this should be disabled in
- $code .= '';
+ $code .= '';
} // END - if
// Return compiled code
return $code;
}
-// Compiles the code (use compileCode() only for HTML because of the comments)
+// Compiles the code
// @TODO $simple/$constants are deprecated
function compileRawCode ($code, $simple = false, $constants = true, $full = true, $compileCode = true) {
// Is the code a string or shall we not compile?
@@ -623,15 +615,16 @@ function compileRawCode ($code, $simple = false, $constants = true, $full = true
// Compile more through a filter
$code = runFilterChain('compile_code', $code);
- // Compile message strings
- $code = str_replace('{--', '{%message,', str_replace('--}', '%}', $code));
+ // First compile these chars
+ array_unshift($secChars['to'] , '{--' , '--}');
+ array_unshift($secChars['from'], '{%message,', '%}' );
// Compile QUOT and other non-HTML codes
$code = str_replace($secChars['to'], $secChars['from'], $code);
// Find $content[bla][blub] entries
- // @TODO Do only use $content and deprecate $DATA in templates
- preg_match_all('/\$(content|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
+ preg_match_all('/\$content((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
+ //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Second regex gave ' . count($matches[0]) . ' matches.');
// Are some matches found?
if ((count($matches) > 0) && (count($matches[0]) > 0)) {
@@ -647,10 +640,10 @@ function compileRawCode ($code, $simple = false, $constants = true, $full = true
$test = substr($found, 0, strlen($match));
// Does this entry exist?
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'found=' . $found . ',match=' . $match . ',set=' . $set);
+ //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'found=' . $found . ',match=' . $match . ',set=' . $set);
if ($test == $match) {
// Match found
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'fuzzyFound!');
+ //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'fuzzyFound!');
$fuzzyFound = true;
break;
} // END - if
@@ -662,16 +655,16 @@ function compileRawCode ($code, $simple = false, $constants = true, $full = true
} // END - if
// Take all string elements
- if ((is_string($matches[4][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key.'_' . $matches[4][$key]]))) {
- // Replace it in the code
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key . ',match=' . $match);
- $newMatch = str_replace('[', "['", str_replace(']', "']", $match));
+ if ((is_string($matches[3][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key.'_' . $matches[3][$key]]))) {
+ // Replace it in the code, replace dollar sign so it won't be detected by next regex (see there)
+ //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key . ',match=' . $match);
+ $newMatch = str_replace(array('[', ']', '$'), array("['", "']", '{COMPILE_DOLLAR}'), $match);
$code = str_replace($match, '".' . $newMatch . '."', $code);
- $matchesFound[$key . '_' . $matches[4][$key]] = 1;
+ $matchesFound[$key . '_' . $matches[3][$key]] = 1;
$matchesFound[$match] = true;
} elseif (!isset($matchesFound[$match])) {
// Not yet replaced!
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'match=' . $match);
+ //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'match=' . $match);
$code = str_replace($match, '".' . $match . '."', $code);
$matchesFound[$match] = 1;
} else {
@@ -681,7 +674,42 @@ function compileRawCode ($code, $simple = false, $constants = true, $full = true
} // END - foreach
} // END - if
- // Return it
+ /*
+ * Find $foobar, $foo_bar and $fooBar entries. This regex would also find
+ * $content[foo_bar] which would result in {DOLLAR}content[foo_bar] and
+ * therefore the variable's value won't be inserted. This is why
+ * {COMPILE_DOLLAR} is being used in above loop and at the end of this
+ * function being replace with the original dollar sign again.
+ */
+ preg_match_all('/\$([a-z_A-Z\[\]]){0,}/', $code, $matches);
+
+ // Are some matches found?
+ if ((count($matches) > 0) && (count($matches[0]) > 0)) {
+ // Scan all matches for not $content
+ foreach ($matches[0] as $match) {
+ // Trim match
+ $match = trim($match);
+
+ // Debug message
+ //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'match=' . $match);
+
+ // Is the first part not $content/$userid and not empty?
+ // @TODO $userid is deprecated and should be removed from loadEmailTemplate() and replaced with $content[userid] in all templates
+ if ((!empty($match)) && (substr($match, 0, 8) != '$content') && ($match != '$userid')) {
+ //* NOISY-DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'match=' . $match . ' - SECURED!');
+ // Then replace $ with {DOLLAR}
+ $matchSecured = str_replace('$', '{DOLLAR}', $match);
+
+ // And in $code as well
+ $code = str_replace($match, $matchSecured, $code);
+ } // END - if
+ } // END - if
+ } // END - if
+
+ // Replace {COMPILE_DOLLAR} back to dollar sign
+ $code = str_replace('{COMPILE_DOLLAR}', '$', $code);
+
+ // Finally return it
return $code;
}
@@ -770,7 +798,7 @@ function addSelectionBox ($type, $default, $prefix = '', $id = '0', $class = 'fo
case 'sec':
case 'min':
for ($idx = 0; $idx < 60; $idx+=5) {
- if (strlen($idx) == 1) $idx = '0' . $idx;
+ if (strlen($idx) == 1) $idx = 0 . $idx;
$OUT .= '