* $Author:: $ *
* -------------------------------------------------------------------- *
* Copyright (c) 2003 - 2009 by Roland Haeder *
- * Copyright (c) 2009, 2010 by Mailer Developer Team *
+ * Copyright (c) 2009 - 2011 by Mailer Developer Team *
* For more information visit: http://www.mxchange.org *
* *
* This program is free software; you can redistribute it and/or modify *
$str = trim($str);
// Is the string empty?
- if (empty($str)) $str = '---';
+ if (empty($str)) {
+ $str = '---';
+ } // END - if
// Return string
return $str;
enableTemplateHtml($insertComments);
// Init counter
- $cnt = 0;
+ $count = 0;
// Compile all out
- while (((strpos($code, '{--') !== false) || (strpos($code, '{DQUOTE}') !== false) || (strpos($code, '{?') !== false) || (strpos($code, '{%') !== false)) && ($cnt < 5)) {
+ while (((strpos($code, '{--') !== false) || (strpos($code, '{DQUOTE}') !== false) || (strpos($code, '{?') !== false) || (strpos($code, '{%') !== false)) && ($count < 5)) {
// Init common variables
$content = array();
$newContent = '';
$code = $newContent;
// Count round
- $cnt++;
+ $count++;
} // END - while
// Return the compiled code
}
// Load a template file and return it's content (only it's name; do not use ' or ")
-function loadTemplate ($template, $return = false, $content = array()) {
+function loadTemplate ($template, $return = false, $content = array(), $compileCode = true) {
// @TODO Remove this sanity-check if all is fine
if (!is_bool($return)) debug_report_bug(__FUNCTION__, __LINE__, 'return is not bool (' . gettype($return) . ')');
$GLOBALS['current_template'] = $template;
// Do we have cache?
- if ((isDebuggingTemplateCache() === false) && (isTemplateCached($template))) {
+ if ((!isDebuggingTemplateCache()) && (isTemplateCached($template))) {
// Evaluate the cache
eval(readTemplateCache($template));
} elseif (!isset($GLOBALS['template_eval'][$template])) {
// Base directory
$basePath = sprintf("%stemplates/%s/html/", getPath(), getLanguage());
- $extraPath = detectExtraTemplatePath($template);;
+ $extraPath = detectExtraTemplatePath($template);
// Generate FQFN
$FQFN = $basePath . $extraPath . $template . '.tpl';
$ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'][$template] . '<!-- Template ' . $template . ' - End //-->';
// Prepare eval() command
- $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileCode(escapeQuotes($ret)) . '";';
+ $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileCode(escapeQuotes($ret), false, true, true, $compileCode) . '";';
} elseif (substr($template, 0, 3) == 'js_') {
// JavaScripts don't like entities and timings
- $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['tpl_content'][$template])) . '");';
+ $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['tpl_content'][$template]), false, true, true, $compileCode) . '");';
} else {
// Prepare eval() command, other output doesn't like entities, maybe
- $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template])) . '");';
+ $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template]), false, true, true, $compileCode) . '");';
}
} else {
// Add surrounding HTML comments to help finding bugs faster
$ret = '<!-- Template ' . $template . ' - Start //-->' . $GLOBALS['tpl_content'][$template] . '<!-- Template ' . $template . ' - End //-->';
- $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileRawCode(escapeQuotes($ret)) . '";';
+ $GLOBALS['template_eval'][$template] = '$ret = "' . getColorSwitchCode($template) . compileRawCode(escapeQuotes($ret), false, true, true, $compileCode) . '";';
} // END - if
} elseif ((isAdmin()) || ((isInstalling()) && (!isInstalled()))) {
// Only admins shall see this warning or when installation mode is active
(' . $template . ')
</div>
<div class="para">
- {--TEMPLATE_CONTENT--}
+ {--TEMPLATE_CONTENT--}:
<pre>' . print_r($content, true) . '</pre>
</div>';
} else {
}
// Loads an email template and compiles it
-function loadEmailTemplate ($template, $content = array(), $userid = '0') {
+function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadUserData = true) {
global $DATA;
// Make sure all template names are lowercase!
// Merge data if valid
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - PRE<br />");
- if (isUserDataValid()) {
+ if ((isUserDataValid()) && ($loadUserData === true)) {
$content = merge_array($content, getUserDataArray());
} // END - if
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - AFTER<br />");
$GLOBALS['tpl_content'][$template] = '$newContent = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template])) . '");';
eval($GLOBALS['tpl_content'][$template]);
} elseif (!empty($template)) {
- // Template file not found!
+ // Template file not found
$newContent = '<div class="para">
{--TEMPLATE_404--}: ' . $template . '
</div>
<div class="para">
- {--TEMPLATE_CONTENT--}
+ {--TEMPLATE_CONTENT--}:
<pre>' . print_r($content, true) . '</pre>
- {--TEMPLATE_DATA--}
+ {--TEMPLATE_DATA--}:
<pre>' . print_r($DATA, true) . '</pre>
</div>';
}
// Compiles the given HTML/mail code
-function compileCode ($code, $simple = false, $constants = true, $full = true) {
- // Is the code a string?
- if (!is_string($code)) {
+function compileCode ($code, $simple = false, $constants = true, $full = true, $compileCode = true) {
+ // Is the code a string or should we not compile?
+ if ((!is_string($code)) || ($compileCode === false)) {
// Silently return it
return $code;
} // END - if
// Compiles the code (use compileCode() only for HTML because of the comments)
// @TODO $simple/$constants are deprecated
-function compileRawCode ($code, $simple = false, $constants = true, $full = true) {
- // Is the code a string?
- if (!is_string($code)) {
+function compileRawCode ($code, $simple = false, $constants = true, $full = true, $compileCode = true) {
+ // Is the code a string or shall we not compile?
+ if ((!is_string($code)) || ($compileCode === false)) {
// Silently return it
return $code;
} // END - if
$secChars = $GLOBALS['url_chars'];
// Select full set of chars to replace when we e.g. want to compile URLs
- if ($full === true) $secChars = $GLOBALS['security_chars'];
+ if ($full === true) {
+ $secChars = $GLOBALS['security_chars'];
+ } // END - if
// Compile more through a filter
$code = runFilterChain('compile_code', $code);
$code = str_replace('{--', '{%message,', str_replace('--}', '%}', $code));
// Compile QUOT and other non-HTML codes
- foreach ($secChars['to'] as $k => $to) {
- // Do the reversed thing as in inc/libs/security_functions.php
- $code = str_replace($to, $secChars['from'][$k], $code);
- } // END - foreach
+ $code = str_replace($secChars['to'], $secChars['from'], $code);
// Find $content[bla][blub] entries
// @TODO Do only use $content and deprecate $GLOBALS and $DATA in templates
// Does this entry exist?
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "found={$found},match={$match},set={$set}<br />");
if ($test == $match) {
- // Match found!
+ // Match found
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "fuzzyFound!<br />");
$fuzzyFound = true;
break;
$M2 = getMonth(time() + $timestamp);
// If so and if current time is before 02/29 and estimated time is after 02/29 then add 86400 seconds (one day)
- if ((floor($TEST) == $TEST) && ($M1 == '02') && ($M2 > '02')) $SWITCH = getOneDay();
+ if ((floor($TEST) == $TEST) && ($M1 == '02') && ($M2 > '02')) {
+ $SWITCH = getOneDay();
+ } // END - switch
// First of all years...
$Y = abs(floor($timestamp / (31536000 + $SWITCH)));
} // END - if
}
+// Generates a 'extension foo out-dated' message
+function generateExtensionOutdatedMessage ($ext_name, $ext_ver) {
+ // Is the extension empty?
+ if (empty($ext_name)) {
+ // This should not happen
+ debug_report_bug(__FUNCTION__, __LINE__, 'Parameter ext is empty. This should not happen.');
+ } // END - if
+
+ // Default message
+ $message = getMaskedMessage('EXTENSION_PROBLEM_EXTENSION_OUTDATED', $ext_name);
+
+ // Is an admin logged in?
+ if (isAdmin()) {
+ // Then output admin message
+ $message = sprintf(getMessage('ADMIN_EXTENSION_PROBLEM_EXTENSION_INACTIVE'), $ext_name, $ext_name, $ext_ver);
+ } // END - if
+
+ // Return prepared message
+ return $message;
+}
+
// Generates a 'extension foo inactive' message
function generateExtensionInactiveMessage ($ext_name) {
// Is the extension empty?
$count_lines = count($codeE);
$r = 'Line | Code:<br />';
- foreach($codeE as $line => $c) {
+ foreach ($codeE as $line => $c) {
$r .= '<div class="line"><span class="linenum">';
if ($count_lines == 1) {
$r .= 1;
// Installation mode
$pageTitle = '{--INSTALLER_OF_MAILER--}';
} else {
- // Configuration not found!
+ // Configuration not found
$pageTitle = '{--NO_CONFIG_FOUND_TITLE--}';
// Do not add the fatal message in installation mode
$str = addslashes($str);
} else {
// Remove escaping of single quotes
- $str = str_replace("\'", "'", $str);
+ $str = str_replace("\\'", "'", $str);
// Escape only double-quotes but prevent double-quoting
$str = str_replace("\\\\", "\\", str_replace('"', "\\\"", $str));
}
// Load template
- loadTemplate('admin_settings_saved', false, $content['message']);
+ displayMessage($content['message']);
}
// Generates a 'selection box' from given array
return sprintf("{--POOL_TYPE_%s--}", strtoupper($type));
}
+// Displays given message in admin_settings_saved template
+function displayMessage ($message, $return = false) {
+ // Load the template
+ return loadTemplate('admin_settings_saved', $return, $message);
+}
+
//-----------------------------------------------------------------------------
// Template helper functions for EL
//-----------------------------------------------------------------------------
// Helper function for extension registration link
function doTemplateExtensionRegistrationLink ($template, $dummy, $ext_name) {
- // Default is all productive
- $OUT = '<a title="{--ADMIN_REGISTER_EXTENSION_TITLE--}" href="{%url=modules.php?module=admin&what=extensions&reg_ext=' . $ext_name . '%}">{--ADMIN_REGISTER_EXTENSION--}</a>';
+ // Default is all non-productive
+ $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>';
// Is the given extension non-productive?
- if (!isExtensionProductive($ext_name)) {
- // Non-productive code
- $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>';
+ if (isExtensionProductive($ext_name)) {
+ // Productive code
+ $OUT = '<a title="{--ADMIN_REGISTER_EXTENSION_TITLE--}" href="{%url=modules.php?module=admin&what=extensions&reg_ext=' . $ext_name . '%}">{--ADMIN_REGISTER_EXTENSION--}</a>';
} // END - if
// Return code
return $OUT;
}
+// Helper function to create bonus mail admin links
+function doTemplateAdminBonusMailLinks ($template, $bonusId) {
+ // Call the inner function
+ return generateAdminMailLinks('bid', $bonusId);
+}
+
+// Helper function to create member mail admin links
+function doTemplateAdminMemberMailLinks ($template, $mailId) {
+ // Call the inner function
+ return generateAdminMailLinks('mid', $mailId);
+}
+
// [EOF]
?>