X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=inline;f=inc%2Ftemplate-functions.php;h=62fecd0386f86a5c54187892e77648dfd6a00e7a;hb=96979cf66a4fc49fda5842e59f475af377821cf9;hp=10e1240b1d6c25c9c4a29ada1be7d95a2a7e5fd7;hpb=2e613a3df528029df9b10f2b5bbf0089c405cc7f;p=mailer.git
diff --git a/inc/template-functions.php b/inc/template-functions.php
index 10e1240b1d..62fecd0386 100644
--- a/inc/template-functions.php
+++ b/inc/template-functions.php
@@ -17,7 +17,7 @@
* -------------------------------------------------------------------- *
* Copyright (c) 2003 - 2009 by Roland Haeder *
* Copyright (c) 2009 - 2011 by Mailer Developer Team *
- * For more information visit: http://www.mxchange.org *
+ * 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 *
@@ -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;
@@ -187,13 +182,13 @@ function compileFinalOutput () {
// 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);
// Add header
sendHeader('Content-Encoding: gzip');
- } elseif (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (strpos('deflate', $_SERVER['HTTP_ACCEPT_ENCODING']) !== null)) {
+ } elseif (!empty($_SERVER['HTTP_ACCEPT_ENCODING']) && (isInStringIgnoreCase('deflate', $_SERVER['HTTP_ACCEPT_ENCODING']))) {
// Compress it for HTTP deflate
$GLOBALS['output'] = gzcompress($GLOBALS['output'], 9);
@@ -217,11 +212,8 @@ function doFinalCompilation ($code, $insertComments = true, $enableCodes = true)
// Init counter
$count = 0;
- // Compile the raw code
- $code = compileRawCode($code);
-
// 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 = '';
@@ -243,10 +235,22 @@ function doFinalCompilation ($code, $insertComments = true, $enableCodes = true)
// Use it again
$code = $newContent;
+ // Compile the final code if insertComments is true
+ if ($insertComments == true) {
+ // ... because SQL queries shall keep OPEN_CONFIG and such in
+ $code = compileRawCode($code);
+ } // END - if
+
// Count round
$count++;
} // END - while
+ // Add debugging data in HTML code, if mode is enabled
+ if ((isDebugModeEnabled()) && ($insertComments === true)) {
+ // Add loop count
+ $code .= '';
+ } // END - if
+
// Return the compiled code
return $code;
}
@@ -310,7 +314,7 @@ function loadTemplate ($template, $return = false, $content = array(), $compileC
// Do we have to compile the code?
$ret = '';
- 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)) {
+ if ((isInString('$', $GLOBALS['tpl_content'][$template])) || (isInString('{--', $GLOBALS['tpl_content'][$template])) || (isInString('{?', $GLOBALS['tpl_content'][$template])) || (isInString('{%', $GLOBALS['tpl_content'][$template]))) {
// Normal HTML output?
if (isHtmlOutputMode()) {
// Add surrounding HTML comments to help finding bugs faster
@@ -428,9 +432,7 @@ function detectExtraTemplatePath ($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);
@@ -511,8 +513,6 @@ function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadU
{--TEMPLATE_CONTENT--}:
' . print_r($content, true) . '
- {--TEMPLATE_DATA--}:
-
' . print_r($DATA, true) . '
';
// Debug mode not active? Then remove the HTML tags
@@ -536,7 +536,6 @@ function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadU
// Remove content and data
unset($content);
- unset($DATA);
// Return content
return $newContent;
@@ -548,7 +547,9 @@ function getMenuCssClasses ($data) {
$content = explode('|', $data);
// Non-existent index 2 will happen in menu blocks
- if (!isset($content[2])) $content[2] = '';
+ if (!isset($content[2])) {
+ $content[2] = '';
+ } // END - if
// Re-construct the array: 0=visible,1=locked,2=prefix
$content['visible'] = $content[0];
@@ -593,7 +594,7 @@ function compileCode ($code, $simple = false, $constants = true, $full = true, $
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?
@@ -620,8 +621,7 @@ function compileRawCode ($code, $simple = false, $constants = true, $full = true
$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
- preg_match_all('/\$(content|GLOBALS|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
+ preg_match_all('/\$content((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
// Are some matches found?
if ((count($matches) > 0) && (count($matches[0]) > 0)) {
@@ -647,21 +647,26 @@ function compileRawCode ($code, $simple = false, $constants = true, $full = true
} // END - foreach
// Skip this entry?
- if ($fuzzyFound === true) continue;
+ if ($fuzzyFound === true) {
+ continue;
+ } // END - if
// Take all string elements
- if ((is_string($matches[4][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key.'_' . $matches[4][$key]]))) {
+ if ((is_string($matches[3][$key])) && (!isset($matchesFound[$match])) && (!isset($matchesFound[$key.'_' . $matches[3][$key]]))) {
// Replace it in the code
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'key=' . $key . ',match=' . $match);
$newMatch = str_replace('[', "['", str_replace(']', "']", $match));
$code = str_replace($match, '".' . $newMatch . '."', $code);
- $matchesFound[$key . '_' . $matches[4][$key]] = 1;
- $matchesFound[$match] = 1;
+ $matchesFound[$key . '_' . $matches[3][$key]] = 1;
+ $matchesFound[$match] = true;
} elseif (!isset($matchesFound[$match])) {
// Not yet replaced!
//* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'match=' . $match);
$code = str_replace($match, '".' . $match . '."', $code);
$matchesFound[$match] = 1;
+ } else {
+ // Everthing else should be a least logged
+ logDebugMessage(__FUNCTION__, __LINE__, 'match=' . $match . ',key=' . $key);
}
} // END - foreach
} // END - if
@@ -839,15 +844,11 @@ function generateImageOrCode ($img_code, $headerSent = true) {
}
// Create selection box or array of splitted timestamp
-function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $return_array=false) {
+function createTimeSelections ($timestamp, $prefix = '', $display = '', $align = 'center', $asArray = false) {
// Do not continue if ONE_DAY is absend
if (!isConfigEntrySet('ONE_DAY')) {
- // And return the timestamp itself or empty array
- if ($return_array === true) {
- return array();
- } else {
- return $timestamp;
- }
+ // Abort here
+ debug_report_bug(__FUNCTION__, __LINE__, 'Configuration entry ONE_DAY is absend. timestamp=' . $timestamp . ',prefix=' . $prefix . ',align=' . $align . ',asArray=' . intval($asArray));
} // END - if
// Calculate 2-seconds timestamp
@@ -896,7 +897,7 @@ function createTimeSelections ($timestamp, $prefix = '', $display = '', $align =
//
// Now we convert them in seconds...
//
- if ($return_array) {
+ if ($asArray === true) {
// Just put all data in an array for later use
$OUT = array(
'YEARS' => $Y,
@@ -1116,9 +1117,6 @@ function generateEmailLink ($email, $table = 'admins') {
$EMAIL = generateSponsorEmailLink($email);
}
- // Shall I close the link when there is no admin?
- if ((!isAdmin()) && ($EMAIL == $email)) $EMAIL = '#'; // Closed!
-
// Return email link
return $EMAIL;
}
@@ -1233,7 +1231,9 @@ function debug_report_bug ($F, $L, $message = '', $sendEmail = true) {
// Compile characters which are allowed in URLs
function compileUriCode ($code, $simple = true) {
// Compile constants
- if ($simple === false) $code = str_replace('{--', '".', str_replace('--}', '."', $code));
+ if ($simple === false) {
+ $code = str_replace('{--', '".', str_replace('--}', '."', $code));
+ } // END - if
// Compile QUOT and other non-HTML codes
$code = str_replace('{DOT}', '.',
@@ -1254,17 +1254,18 @@ function compileUriCode ($code, $simple = true) {
// Handle message codes from URL
function handleCodeMessage () {
- if (isGetRequestParameterSet('code')) {
+ // Is 'code' set?
+ if (isGetRequestElementSet('code')) {
// Default extension is 'unknown'
$ext = 'unknown';
// Is extension given?
- if (isGetRequestParameterSet('ext')) {
- $ext = getRequestParameter('ext');
+ if (isGetRequestElementSet('ext')) {
+ $ext = getRequestElement('ext');
} // END - if
// Convert the 'code' parameter from URL to a human-readable message
- $message = getMessageFromErrorCode(getRequestParameter('code'));
+ $message = getMessageFromErrorCode(getRequestElement('code'));
// Load message template
loadTemplate('message', false, $message);
@@ -1384,42 +1385,54 @@ function linenumberCode ($code) {
// Determines the right page title
function determinePageTitle () {
+ // Init page title
+ $pageTitle = '';
+
// Config and database connection valid?
if ((isConfigLocalLoaded()) && (isConfigurationLoaded()) && (SQL_IS_LINK_UP()) && (isExtensionInstalledAndNewer('sql_patches', '0.1.6'))) {
- // Init title
- $TITLE = '';
-
// Title decoration enabled?
- if ((isTitleDecorationEnabled()) && (getConfig('title_left') != '')) $TITLE .= trim(getConfig('title_left')) . ' ';
+ if ((isTitleDecorationEnabled()) && (getConfig('title_left') != '')) {
+ $pageTitle .= '{%config,trim=title_left%} ';
+ } // END - if
// Do we have some extra title?
if (isExtraTitleSet()) {
- // Then prepent it
- $TITLE .= getExtraTitle() . ' by ';
+ // Then prepend it
+ $pageTitle .= '{%pipe,getExtraTitle%} by ';
} // END - if
// Add main title
- $TITLE .= getMainTitle();
+ $pageTitle .= '{?MAIN_TITLE?}';
// Add title of module? (middle decoration will also be added!)
if ((isModuleTitleEnabled()) || ((!isWhatSet()) && (!isActionSet())) || (getModule() == 'admin')) {
- $TITLE .= ' ' . trim(getConfig('title_middle')) . ' {DQUOTE} . getModuleTitle(getModule()) . {DQUOTE}';
+ $pageTitle .= ' {%config,trim=title_middle%} {DQUOTE} . getModuleTitle(getModule()) . {DQUOTE}';
} // END - if
// Add title from what file
$mode = '';
- if (getModule() == 'login') $mode = 'member';
- elseif (getModule() == 'index') $mode = 'guest';
- if ((!empty($mode)) && (isWhatTitleEnabled())) $TITLE .= ' ' . trim(getConfig('title_middle')) . ' ' . getTitleFromMenu($mode, getWhat());
+ if (getModule() == 'login') {
+ $mode = 'member';
+ } elseif (getModule() == 'index') {
+ $mode = 'guest';
+ } elseif (getModule() == 'admin') {
+ $mode = 'admin';
+ } elseif (getModule() == 'sponsor') {
+ $mode = 'sponsor';
+ }
- // Add title decorations? (right)
- if ((isTitleDecorationEnabled()) && (getConfig('title_right') != '')) $TITLE .= ' ' . trim(getConfig('title_right'));
+ // Add middle part (always in admin area!)
+ if ((!empty($mode)) && ((isWhatTitleEnabled()) || ($mode == 'admin'))) {
+ $pageTitle .= ' {%config,trim=title_middle%} ' . getTitleFromMenu($mode, getWhat());
+ } // END - if
- // Remember title in constant for the template
- $pageTitle = $TITLE;
+ // Add title decorations? (right)
+ if ((isTitleDecorationEnabled()) && (getConfig('title_right') != '')) {
+ $pageTitle .= ' {%config,trim=title_right%}';
+ } // END - if
} elseif ((isInstalled()) && (isAdminRegistered())) {
// Installed, admin registered but no ext-sql_patches
- $pageTitle = '[-- ' . getMainTitle() . ' - ' . getModuleTitle(getModule()) . ' --]';
+ $pageTitle = '[-- {?MAIN_TITLE?} - {%pipe,getModule,getModuleTitle%} --]';
} elseif ((isInstalled()) && (!isAdminRegistered())) {
// Installed but no admin registered
$pageTitle = '{--INSTALLER_OF_MAILER_NO_ADMIN--}';
@@ -1531,7 +1544,7 @@ function sendModeMails ($mod, $modes) {
$hash = encodeHashForCookie(getUserData('password'));
// Does the hash match or should we change it?
- if (($hash == getSession('u_hash')) || (postRequestParameter('pass1') == postRequestParameter('pass2'))) {
+ if (($hash == getSession('u_hash')) || (postRequestElement('pass1') == postRequestElement('pass2'))) {
// Load the data
$content = getUserDataArray();
@@ -1546,7 +1559,7 @@ function sendModeMails ($mod, $modes) {
switch ($mode) {
case 'normal': break; // Do not add any special lines
case 'email': // Email was changed!
- $content['message'] = '{--MEMBER_CHANGED_EMAIL--}' . ': ' . postRequestParameter('old_email') . "\n";
+ $content['message'] = '{--MEMBER_CHANGED_EMAIL--}' . ': ' . postRequestElement('old_email') . "\n";
break;
case 'password': // Password was changed
@@ -1562,7 +1575,7 @@ function sendModeMails ($mod, $modes) {
if (isExtensionActive('country')) {
// Replace code with description
- $content['country'] = generateCountryInfo(postRequestParameter('country_code'));
+ $content['country'] = generateCountryInfo(postRequestElement('country_code'));
} // END - if
// Merge content with data from POST
@@ -1760,7 +1773,7 @@ function generateGenderSelectionBox ($selectedGender = '') {
}
//-----------------------------------------------------------------------------
-// Template helper functions for EL
+// Template helper functions for EL code
//-----------------------------------------------------------------------------
// Color-switch helper function
@@ -1783,7 +1796,7 @@ function doTemplateColorSwitch ($template, $clear = false, $return = true) {
}
// Helper function for extension registration link
-function doTemplateExtensionRegistrationLink ($template, $dummy, $ext_name) {
+function doTemplateExtensionRegistrationLink ($template, $clear, $ext_name) {
// Default is all non-productive
$OUT = '{--ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK--}';
@@ -1798,16 +1811,77 @@ function doTemplateExtensionRegistrationLink ($template, $dummy, $ext_name) {
}
// Helper function to create bonus mail admin links
-function doTemplateAdminBonusMailLinks ($template, $dummy, $bonusId) {
+function doTemplateAdminBonusMailLinks ($template, $clear, $bonusId) {
// Call the inner function
return generateAdminMailLinks('bid', $bonusId);
}
// Helper function to create member mail admin links
-function doTemplateAdminMemberMailLinks ($template, $dummy, $mailId) {
+function doTemplateAdminMemberMailLinks ($template, $clear, $mailId) {
// Call the inner function
return generateAdminMailLinks('mid', $mailId);
}
+// Helper function to create a selection box for YES/NO configuration entries
+function doTemplateConfigurationYesNoSelectionBox ($template, $clear, $configEntry) {
+ // Default is a "missing entry" warning
+ $OUT = '!' . $configEntry . '!';
+
+ // Generate the HTML code
+ if (isConfigEntrySet($configEntry)) {
+ // Configuration entry is found
+ $OUT = '';
+ } // END - if
+
+ // Return it
+ return $OUT;
+}
+
+// Helper function to create a selection box for YES/NO form fields
+function doTemplateYesNoSelectionBox ($template, $clear, $formField) {
+ // Generate the HTML code
+ $OUT = '';
+
+ // Return it
+ return $OUT;
+}
+
+// Helper function to create a selection box for YES/NO form fields, by NO is default
+function doTemplateNoYesSelectionBox ($template, $clear, $formField) {
+ // Generate the HTML code
+ $OUT = '';
+
+ // Return it
+ return $OUT;
+}
+
+// Helper function to add extra content for member area (module=login)
+function doTemplateMemberFooterExtras ($template, $clear) {
+ // Is a member logged in?
+ if (!isMember()) {
+ // This shall not happen
+ debug_report_bug(__FUNCTION__, __LINE__, 'Please use this template helper only for logged-in members.');
+ } // END - if
+
+ // Init filter data
+ $filterData = array(
+ 'userid' => getMemberId(),
+ 'template' => $template,
+ 'output' => '',
+ );
+
+ // Run the filter chain
+ $filterData = runFilterChain('member_footer_extras', $filterData);
+
+ // Return output
+ return $filterData['output'];
+}
+
// [EOF]
?>