]> git.mxchange.org Git - mailer.git/blobdiff - inc/template-functions.php
A lot has been rewritten, ext-teams added, ext-forced continued:
[mailer.git] / inc / template-functions.php
index eeba4db76cad0d6327f1c39de93eae5f23938e0b..73e88c6ce05cef02ac10234a892621d043043ae8 100644 (file)
@@ -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;
@@ -240,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 .= '<!-- Total compilation loop=' . $count . ' //-->';
+       } // END - if
+
        // Return the compiled code
        return $code;
 }
@@ -262,8 +269,13 @@ function outputRawCode ($htmlCode) {
 
 // Load a template file and return it's content (only it's name; do not use ' or ")
 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) . ')');
+       if (!is_bool($return)) {
+               // @TODO Remove this sanity-check if all is fine
+               debug_report_bug(__FUNCTION__, __LINE__, 'return[] is not bool (' . gettype($return) . ')');
+       } elseif (!is_string($template)) {
+               // $template has to be string
+               debug_report_bug(__FUNCTION__, __LINE__, 'template[] is not string (' . gettype($template) . ')');
+       }
 
        // Set current template
        $GLOBALS['current_template'] = $template;
@@ -317,10 +329,13 @@ function loadTemplate ($template, $return = false, $content = array(), $compileC
                                        // Prepare eval() command, other output doesn't like entities, maybe
                                        $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeQuotes($GLOBALS['tpl_content'][$template]), false, true, true, $compileCode) . '");';
                                }
-                       } else {
+                       } elseif (isHtmlOutputMode()) {
                                // 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), false, true, true, $compileCode) . '";';
+                       } else {
+                               // JavaScript again
+                               $GLOBALS['template_eval'][$template] = '$ret = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($GLOBALS['tpl_content'][$template]), false, true, true, $compileCode) . '");';
                        } // END - if
                } elseif ((isAdmin()) || ((isInstalling()) && (!isInstalled()))) {
                        // Only admins shall see this warning or when installation mode is active
@@ -417,7 +432,8 @@ function detectExtraTemplatePath ($template) {
 }
 
 // Loads an email template and compiles it
-function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadUserData = true) {
+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!
@@ -439,24 +455,24 @@ function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadU
        } // END - if
 
        // Load user's data
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "UID={$userid},template={$template},content[]=".gettype($content));
+       //* 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__, "NICKNAME!<br />");
+                       //* 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__, "NO-NICK!<br />");
+                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'userid=' . $userid . ' - USERID!');
                        fetchUserData($userid);
                }
 
                // Merge data if valid
-               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - PRE<br />");
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'content()=' . count($content) . ' - PRE!');
                if ((isUserDataValid()) && ($loadUserData === true)) {
                        // It is valid
                        $content = merge_array($content, getUserDataArray());
@@ -465,7 +481,7 @@ function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadU
                        unset($content['password']);
                } // END - if
 
-               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "content()=".count($content)." - AFTER<br />");
+               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'content()=' . count($content) . ' - AFTER!');
        } // END - if
 
        // Base directory
@@ -609,8 +625,8 @@ 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);
+       // @TODO Do only use $content and deprecate $DATA in templates
+       preg_match_all('/\$(content|DATA)((\[([a-zA-Z0-9-_]+)\])*)/', $code, $matches);
 
        // Are some matches found?
        if ((count($matches) > 0) && (count($matches[0]) > 0)) {
@@ -626,31 +642,36 @@ 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}<br />");
+                               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'found=' . $found . ',match=' . $match . ',set=' . $set);
                                if ($test == $match) {
                                        // Match found
-                                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "fuzzyFound!<br />");
+                                       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'fuzzyFound!');
                                        $fuzzyFound = true;
                                        break;
                                } // END - if
                        } // 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]]))) {
                                // Replace it in the code
-                               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "key={$key},match={$match}<br />");
+                               //* 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[$match] = true;
                        } elseif (!isset($matchesFound[$match])) {
                                // Not yet replaced!
-                               //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, "match={$match}<br />");
+                               //* 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
@@ -828,15 +849,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
@@ -885,7 +902,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,
@@ -1105,9 +1122,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;
 }
@@ -1373,42 +1387,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--}';
@@ -1420,7 +1446,10 @@ function determinePageTitle () {
                $pageTitle = '{--NO_CONFIG_FOUND_TITLE--}';
 
                // Do not add the fatal message in installation mode
-               if ((!isInstalling()) && (!isConfigurationLoaded())) addFatalMessage(__FUNCTION__, __LINE__, '{--NO_CONFIG_FOUND--}');
+               if ((!isInstalling()) && (!isConfigurationLoaded())) {
+                       // Please report this
+                       debug_report_bug(__FUNCTION__, __LINE__, 'No configuration data found!');
+               } // END - if
        }
 
        // Return title
@@ -1682,8 +1711,8 @@ function generateMetaDescriptionCode () {
                $GLOBALS['page_header'] .= '<meta name="description" content="' . $DESCR . '" />';
        } // END - if
 
-       // Remove depth
-       unset($GLOBALS['ref_level']);
+       // Initialize referal system
+       initReferalSystem();
 }
 
 // Generates an FQFN for template cache from the given template name
@@ -1746,7 +1775,7 @@ function generateGenderSelectionBox ($selectedGender = '') {
 }
 
 //-----------------------------------------------------------------------------
-//                      Template helper functions for EL
+//                     Template helper functions for EL code
 //-----------------------------------------------------------------------------
 
 // Color-switch helper function
@@ -1769,7 +1798,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 = '<em style="cursor:help" class="notice" title="{%message,ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK_TITLE=' . $ext_name . '%}">{--ADMIN_EXTENSION_IS_NON_PRODUCTIVE_LINK--}</em>';
 
@@ -1784,16 +1813,55 @@ function doTemplateExtensionRegistrationLink ($template, $dummy, $ext_name) {
 }
 
 // Helper function to create bonus mail admin links
-function doTemplateAdminBonusMailLinks ($template, $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, $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 = '<em style="cursor:help" class="notice" title="{%message,ADMIN_CONFIG_ENTRY_MISSING=' . $configEntry . '%}">!' . $configEntry . '!</em>';
+
+       // Generate the HTML code
+       if (isConfigEntrySet($configEntry)) {
+               // Configuration entry is found
+               $OUT = '<select name="' . $configEntry . '" class="form_select" size="1">
+{%config,generateYesNoOptionList=' . $configEntry . '%}
+</select>';
+       } // 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 = '<select name="' . $formField . '" class="form_select" size="1">
+{%pipe,generateYesNoOptionList%}
+</select>';
+
+       // 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 = '<select name="' . $formField . '" class="form_select" size="1">
+{%pipe,generateYesNoOptionList=N%}
+</select>';
+
+       // Return it
+       return $OUT;
+}
+
 // [EOF]
 ?>