Changed important SERVER_URL which now points to the right URL
[mailer.git] / inc / template-functions.php
index 1b9dacc836bbb2a829984d80c3d9753c61d23288..597c5be9303f8e56b1b58dbb370208e7db1fc2be 100644 (file)
@@ -16,7 +16,7 @@
  * $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 *
@@ -261,7 +261,7 @@ 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()) {
+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) . ')');
 
@@ -269,7 +269,7 @@ function loadTemplate ($template, $return = false, $content = array()) {
        $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])) {
@@ -309,18 +309,18 @@ function loadTemplate ($template, $return = false, $content = array()) {
                                        $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
@@ -331,7 +331,7 @@ function loadTemplate ($template, $return = false, $content = array()) {
        (' . $template . ')
 </div>
 <div class="para">
-       {--TEMPLATE_CONTENT--}
+       {--TEMPLATE_CONTENT--}:
        <pre>' . print_r($content, true) . '</pre>
 </div>';
                } else {
@@ -485,14 +485,14 @@ function loadEmailTemplate ($template, $content = array(), $userid = '0', $loadU
                $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>';
 
@@ -543,14 +543,14 @@ function getMenuCssClasses ($data) {
 }
 
 // Generate XHTML code for the CAPTCHA
-function generateCaptchaCode ($code, $type, $DATA, $userid) {
-       return '<img border="0" alt="Code ' . $code . '" src="{%url=mailid_top.php?userid=' . $userid . '&amp;' . $type . '=' . $DATA . '&amp;mode=img&amp;code=' . $code . '%}" />';
+function generateCaptchaCode ($code, $type, $type, $userid) {
+       return '<img border="0" alt="Code ' . $code . '" src="{%url=mailid_top.php?userid=' . $userid . '&amp;' . $type . '=' . $type . '&amp;mode=img&amp;code=' . $code . '%}" />';
 }
 
 // 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
@@ -576,9 +576,9 @@ function compileCode ($code, $simple = false, $constants = true, $full = true) {
 
 // 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
@@ -587,7 +587,9 @@ function compileRawCode ($code, $simple = false, $constants = true, $full = true
        $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);
@@ -618,7 +620,7 @@ function compileRawCode ($code, $simple = false, $constants = true, $full = true
                                // 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;
@@ -839,7 +841,9 @@ function createTimeSelections ($timestamp, $prefix = '', $display = '', $align =
        $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)));
@@ -1227,7 +1231,9 @@ function handleCodeMessage () {
                $ext = 'unknown';
 
                // Is extension given?
-               if (isGetRequestParameterSet('ext')) $ext = getRequestParameter('ext');
+               if (isGetRequestParameterSet('ext')) {
+                       $ext = getRequestParameter('ext');
+               } // END - if
 
                // Convert the 'code' parameter from URL to a human-readable message
                $message = getMessageFromErrorCode(getRequestParameter('code'));
@@ -1337,7 +1343,7 @@ function linenumberCode ($code)    {
                if ($count_lines == 1) {
                        $r .= 1;
                } else {
-                       $r .= ($line == ($count_lines - 1)) ? '' :  ($line+1);
+                       $r .= ($line == ($count_lines - 1)) ? '' : ($line+1);
                }
                $r .= '</span>|';
 
@@ -1393,7 +1399,7 @@ function determinePageTitle () {
                // 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
@@ -1460,7 +1466,7 @@ function escapeQuotes ($str, $single = false) {
                $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));
@@ -1584,7 +1590,7 @@ function sendModeMails ($mod, $modes) {
        }
 
        // Load template
-       loadTemplate('admin_settings_saved', false, $content['message']);
+       displayMessage($content['message']);
 }
 
 // Generates a 'selection box' from given array
@@ -1701,6 +1707,12 @@ function translatePoolType ($type) {
        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
 //-----------------------------------------------------------------------------
@@ -1726,18 +1738,30 @@ function doTemplateColorSwitch ($template, $clear = false, $return = true) {
 
 // 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&amp;what=extensions&amp;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&amp;what=extensions&amp;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]
 ?>