X-Git-Url: https://git.mxchange.org/?p=mailer.git;a=blobdiff_plain;f=inc%2Ftemplate-functions.php;h=9c7192ab1a5d40132d25ab1f45c122e2a11e93cf;hp=a768c907f726fb7e2dcc399806d124cb1304648b;hb=6560179e7c8dc565485503f374d4e31f333ffd0e;hpb=5261b522112c11417fc87bb0b14ca078bfa398e3
diff --git a/inc/template-functions.php b/inc/template-functions.php
index a768c907f7..9c7192ab1a 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 < 5)) {
+ while (((isInString('{--', $code)) || (isInString('{DQUOTE}', $code)) || (isInString('{?', $code)) || (isInString('{%', $code) !== false)) && ($count < 7)) {
// Init common variables
$content = array();
$newContent = '';
@@ -234,16 +242,28 @@ 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']['html'][$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) {
@@ -363,12 +395,12 @@ function loadTemplate ($template, $return = false, $content = array(), $compileC
}
// Detects the extra template path from given template name
-function detectExtraTemplatePath ($template) {
+function detectExtraTemplatePath ($prefix, $template) {
// Default is empty
$extraPath = '';
- // Do we have cache?
- if (!isset($GLOBALS['extra_path'][$template])) {
+ // Is there cache?
+ if (!isset($GLOBALS['extra_path'][$prefix][$template])) {
// Check for admin/guest/member/etc. templates
if (substr($template, 0, 6) == 'admin_') {
// Admin template found
@@ -409,20 +441,21 @@ function detectExtraTemplatePath ($template) {
}
// Store it in cache
- $GLOBALS['extra_path'][$template] = $extraPath;
+ $GLOBALS['extra_path'][$prefix][$template] = $extraPath;
} // END - if
// Return result
- return $GLOBALS['extra_path'][$template];
+ return $GLOBALS['extra_path'][$prefix][$template];
}
// Loads an email template and compiles it
-function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadUserData = true) {
- global $DATA;
-
+function loadEmailTemplate ($template, $content = array(), $userid = NULL, $loadUserData = true) {
// 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
@@ -431,93 +464,89 @@ function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadU
$content['expiration'] = '{--MAIL_WILL_NEVER_EXPIRE--}';
} elseif (isConfigEntrySet('auto_purge')) {
// Create nice date string
- $content['expiration'] = '{%pipe,getAutoPurge,createFancyTime%}';
+ $content['expiration'] = '{%config,createFancyTime=auto_purge%}';
} else {
// Missing entry
$content['expiration'] = '{--MAIL_NO_CONFIG_AUTO_PURGE--}';
}
} // 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))) {
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NICKNAME! ");
- // Load by nickname
- fetchUserData($userid, 'nickname');
- } else {
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "NO-NICK! ");
- /// Load by userid
- fetchUserData($userid);
- }
-
- // Merge data if valid
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - PRE ");
- if ((isUserDataValid()) && ($loadUserData === true)) {
- $content = merge_array($content, getUserDataArray());
- } // END - if
- //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - AFTER ");
- } // END - if
+ // Is there cache?
+ if ((!isDebuggingTemplateCache()) && (isTemplateCached('email', $template))) {
+ // Evaluate the cache
+ eval(readTemplateCache('email', $template));
+ } elseif (!isset($GLOBALS['template_eval']['email'][$template])) {
+ // Base directory
+ $basePath = sprintf("%stemplates/%s/emails/", getPath(), getLanguage());
- // Base directory
- $basePath = sprintf("%stemplates/%s/emails/", getPath(), getLanguage());
+ // Detect extra path
+ $extraPath = detectExtraTemplatePath('email', $template);
- // Detect extra path
- $extraPath = detectExtraTemplatePath($template);
+ // Generate full FQFN
+ $FQFN = $basePath . $extraPath . $template . '.tpl';
- // Generate full FQFN
- $FQFN = $basePath . $extraPath . $template . '.tpl';
+ // Does the special template exists?
+ if (!isFileReadable($FQFN)) {
+ // Reset to default template
+ $FQFN = $basePath . $template . '.tpl';
+ } // END - if
- // Does the special template exists?
- if (!isFileReadable($FQFN)) {
- // Reset to default template
- $FQFN = $basePath . $template . '.tpl';
- } // END - if
+ // Now does the final template exists?
+ $newContent = '';
+ if (isFileReadable($FQFN)) {
+ // The local file does exists so we load it. :)
+ $GLOBALS['template_content']['email'][$template] = readFromFile($FQFN);
- // Now does the final template exists?
- $newContent = '';
- if (isFileReadable($FQFN)) {
- // The local file does exists so we load it. :)
- $GLOBALS['tpl_content'][$template] = readFromFile($FQFN);
-
- // Run code
- $GLOBALS['tpl_content'][$template] = '$newContent = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template])) . '");';
- eval($GLOBALS['tpl_content'][$template]);
- } elseif (!empty($template)) {
- // Template file not found
- $newContent = '
+ // Run code
+ $GLOBALS['template_eval']['email'][$template] = '$newContent = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['template_content']['email'][$template])) . '");';
+ } elseif (!empty($template)) {
+ // Template file not found
+ $newContent = '
{--TEMPLATE_404--}: ' . $template . '
{--TEMPLATE_CONTENT--}:
' . print_r($content, true) . '
- {--TEMPLATE_DATA--}:
-
' . print_r($DATA, true) . '
';
- // Debug mode not active? Then remove the HTML tags
- if (!isDebugModeEnabled()) {
- // Remove HTML tags
- $newContent = secureString($newContent);
- } // END - if
- } else {
- // No template name supplied!
- $newContent = '{--NO_TEMPLATE_SUPPLIED--}';
+ // Don't cache this, as there is no template to cache
+ $GLOBALS['template_eval']['email'][$template] = '404';
+
+ // Debug mode not active? Then remove the HTML tags
+ if (!isDebugModeEnabled()) {
+ // Remove HTML tags
+ $newContent = secureString($newContent);
+ } // END - if
+ } else {
+ // No template name supplied!
+ $newContent = '{--NO_TEMPLATE_SUPPLIED--}';
+ $GLOBALS['template_eval']['email'][$template] = '404';
+ }
}
- // Is there some content?
+ // Is there something to eval?
+ if ((isset($GLOBALS['template_eval']['email'][$template])) && ($GLOBALS['template_eval']['email'][$template] != '404')) {
+ // Eval the code
+ //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'template=' . $template . ' - BEFORE EVAL');
+ ///* DEBUG: */ print('