]> git.mxchange.org Git - mailer.git/blobdiff - inc/expression-functions.php
Updated copyright year.
[mailer.git] / inc / expression-functions.php
index c8f1bfdf7698c3c1a242cf36605fc14aeb119fa2..9bd74b48cc5d8597a530457668ddb2b22641c38f 100644 (file)
  * -------------------------------------------------------------------- *
  * Kurzbeschreibung  : Expression-Callback-Funktionen                   *
  * -------------------------------------------------------------------- *
- * $Revision::                                                        $ *
- * $Date::                                                            $ *
- * $Tag:: 0.2.1-FINAL                                                 $ *
- * $Author::                                                          $ *
- * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
+ * Copyright (c) 2009 - 2016 by Mailer Developer Team                   *
  * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
@@ -43,7 +38,7 @@ if (!defined('__SECURITY')) {
 // Private function to replace the code
 function replaceExpressionCode ($data, $replacer) {
        // Replace the code
-       // @TODO is escapeQuotes() enougth for strings with single/double quotes?
+       // @TODO is escapeQuotes() enough for strings with single/double quotes?
        return str_replace($data['matches'][0][$data['key']], $replacer, escapeQuotes($data['code']));
 }
 
@@ -71,16 +66,16 @@ function isExpressionFunctionAvaiable ($data) {
                if (function_exists($functionName)) {
                        // Cache it all
                        $GLOBALS['expression_function_name'][$entry]      = $functionName;
-                       $GLOBALS['expression_function_available'][$entry] = true;
+                       $GLOBALS['expression_function_available'][$entry] = TRUE;
                } else {
                        // Not avaiable
                        logDebugMessage(__FUNCTION__, __LINE__, 'Expression function ' . $functionName . ' not found. Please consider adding it to improve execution speed.');
 
                        // And cache it
-                       $GLOBALS['expression_function_available'][$entry] = false;
+                       $GLOBALS['expression_function_available'][$entry] = FALSE;
                }
-       } elseif ($GLOBALS['expression_function_available'][$entry] == false) {
-               // Debug message
+       } elseif (($GLOBALS['expression_function_available'][$entry] == FALSE) && (isDebugModeEnabled())) {
+               // Debug message in debug mode
                logDebugMessage(__FUNCTION__, __LINE__, 'Expression function for entry ' . $entry . ' requested but does not exist.');
        }
 
@@ -91,7 +86,7 @@ function isExpressionFunctionAvaiable ($data) {
 // Getter for above expression function
 function getExpressionFunction ($data) {
        // Get the enty we need
-       $entry = $data['matches'][4][$data['key']];
+       $entry = trim($data['matches'][4][$data['key']]);
 
        // Return it
        return $GLOBALS['expression_function_name'][$entry];
@@ -106,7 +101,7 @@ function doExpressionCode ($data) {
        return $code;
 }
 
-// Expression call-back function for URLs
+// Expression call-back function for URLs (example: {%url=foo.php?bar=bar%})
 function doExpressionUrl ($data) {
        // Is there JS-mode?
        if ($data['callback'] == 'js') {
@@ -118,7 +113,7 @@ function doExpressionUrl ($data) {
        $replacer = "{DQUOTE} . encodeUrl('" . $data['matches'][4][$data['key']] . "', " . $data['output_mode'] . ') . {DQUOTE}';
 
        // Debug log
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'replacer=' . $replacer . ',callback=' . $data['callback']);
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'replacer=' . $replacer . ',callback=' . $data['callback'] . ',output_mode=' . $data['output_mode']);
 
        // Replace it
        $code = replaceExpressionCode($data, $replacer);
@@ -153,15 +148,18 @@ function doExpressionExt ($data) {
                $functionName = 'getExtension' . capitalizeUnderscoreString($data['callback']);
 
                // Construct call of the function
-               $replacer = "{DQUOTE} . call_user_func_array('" . $functionName . "', array('" . $data['matches'][4][$data['key']] . "', true)) . {DQUOTE}";
+               $replacer = "{DQUOTE} . call_user_func_array('" . $functionName . "', array('" . $data['matches'][4][$data['key']] . "', TRUE)) . {DQUOTE}";
        } // END - if
 
        // Generate replacer
-       $replacer = sprintf("&ext=%s&ver=%s&rev={?CURRENT_REPOSITORY_REVISION?}", $data['matches'][4][$data['key']], $replacer);
+       $replacer = sprintf('&ext=%s&ver=%s', $data['matches'][4][$data['key']], $replacer);
 
        // Replace it and insert parameter for GET request
        $code = replaceExpressionCode($data, $replacer);
 
+       // Debug message
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'code=' . $code . ',replacer=' . $replacer . ',key=' . $data['key'] . ',callback=' . $data['callback']);
+
        // Return replaced code
        return $code;
 }
@@ -195,7 +193,7 @@ function doExpressionPipe ($data) {
 
        // Is there a call-back? Should always be there!
        if (!empty($data['callback'])) {
-               //* DEBUG: */ if ($data['callback'] == 'getMemberId') die('<pre>'.encodeEntities(print_r($data, true)).'</pre>');
+               //* DEBUG: */ if ($data['callback'] == 'getMemberId') die('<pre>'.encodeEntities(print_r($data, TRUE)).'</pre>');
                // If the value is empty, we don't add it
                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'value[' . gettype($data['value']) . ']=' . $data['value']);
                if ((empty($data['value'])) && ($data['value'] != '0')) {
@@ -241,7 +239,7 @@ function doExpressionValidatorLinks ($data) {
        // Should we generally include validator links?
        if ((isExtensionInstalled('validator')) && (getConfig('enable_validator') == 'Y') && (!in_array(getModule(), array('admin', 'login')))) {
                // Load the validator template
-               $replacer = escapeQuotes(loadTemplate('validator_links', true));
+               $replacer = escapeQuotes(loadTemplate('validator_links', TRUE));
        } // END - if
 
        // Replace the code
@@ -257,7 +255,7 @@ function doExpressionMessage ($data) {
        //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'callback=' . $data['callback'] . ',extra_func=' . $data['extra_func'] . ',value=' . $data['value']);
 
        // Message string replacement depends on if message is masked
-       if ((isMessageMasked($data['callback'], false)) && ((!empty($data['extra_func'])) || ($data['extra_func'] == '0'))) {
+       if ((isMessageMasked($data['callback'], FALSE)) && ((!empty($data['extra_func'])) || ($data['extra_func'] == '0'))) {
                // Message should be masked
                $replacer = "{DQUOTE} . getMaskedMessage('" . $data['callback'] . "', '" . $data['extra_func'] . "') . {DQUOTE}";
        } elseif (!empty($data['value'])) {
@@ -278,7 +276,7 @@ function doExpressionMessage ($data) {
 // Expression call-back for template functions
 function doExpressionTemplate ($data) {
        // Construct call-back function name
-       $callbackFunction = 'doTemplate' . $data['callback'];
+       $callbackFunction = 'doTemplate' . ucfirst($data['callback']);
 
        // Init replacer
        $replacer = '<!-- [' . __FUNCTION__ . ':' . __LINE__.'] Call-back function ' . $callbackFunction  . ' does not exist. //-->';
@@ -296,7 +294,7 @@ function doExpressionTemplate ($data) {
        } else {
                // Do the replacement
                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'template='.$GLOBALS['current_template']);
-               $replacer = '{DQUOTE} . ' . $callbackFunction . '(' . chr(39) . $GLOBALS['current_template'] . chr(39) . ', true';
+               $replacer = '{DQUOTE} . ' . $callbackFunction . '(' . chr(39) . $GLOBALS['current_template'] . chr(39) . ', TRUE';
 
                // Is 'value' set?
                if (!empty($data['value'])) {
@@ -423,5 +421,137 @@ function doExpressionSessionPipe ($data) {
        return $code;
 }
 
+// Expression call-back for formulars
+function doExpressionForm ($data) {
+       // Default method is GET, target is _self
+       $data['__form_method'] = 'get';
+       $data['__form_target'] = '_self';
+       $data['__form_name']   = 'form';
+       $data['__form_id']     = 'form';
+       $data['__server']      = '';
+
+       // Check which method/target is set
+       foreach (array('callback', 'extra_func', 'extra_func2') as $key) {
+               // Make lower-case
+               $value = strtolower($data[$key]);
+
+               // Is formMethodPost set?
+               if ($value == 'formmethodpost') {
+                       // Use it
+                       $data['__form_method'] = 'post';
+               } elseif (($value == 'formmethodpost') && (!isSpider()) && (!isValidSession())) {
+                       // Then expand 'value' with session id
+                       if (strpos($data['value'], '?') !== FALSE) {
+                               // '?' is set
+                               $data['value'] .= '&amp';
+                       } else {
+                               // Is not set
+                               $data['value'] .= '?';
+                       }
+
+                       // Append session's name and id
+                       $data['value'] .= session_name() . '=' . session_id();
+               } elseif (substr($value, 0, 10) == 'formtarget') {
+                       // Form target is found
+                       $data['__form_target'] = substr($value, 10);
+               } elseif (substr($value, 0, 8) == 'formname') {
+                       // Form name is found
+                       $data['__form_name'] = substr($value, 8);
+               } elseif (substr($value, 0, 6) == 'formid') {
+                       // Form id found
+                       $data['__form_id'] = substr($value, 6);
+               } elseif (substr($value, 0, 6) == 'server') {
+                       // {%server,foo%} found
+                       $data['__server'] = '{%server,' . substr($value, 6) . '%}';
+               }
+       } // END - foreach
+
+       // Generate the replacement code which is the opening form tag
+       $data['__replacer'] = '<form accept-charset=\"UTF-8\"';
+       if (!empty($data['value'])) {
+               $data['__replacer'] .= ' action=\"{%url=' . $data['value'];
+               if (!empty($data['__server'])) {
+                       $data['__replacer'] .= $data['__server'];
+               } // END - if
+               $data['__replacer'] .= '%}\"';
+       } // END - if
+
+       // Add rest elements
+       foreach (array('method', 'target', 'name', 'id') as $key) {
+               $data['__replacer'] .= ' ' . $key . '=\"' . $data['__form_' . $key] . '\"';
+       } // END - foreach
+
+       // Close the tag here (don't move it below the next filter)
+       $data['__replacer'] .= '>' . PHP_EOL;
+
+       /*
+        * Call a filter chain to allow more hidden fields being added. You should
+        * not remove the > char from above line to add onsubmit="" or so. Instead
+        * you should better use jquery to accomplish the same.
+        */
+       $data = runFilterChain('open_form_fields', $data);
+
+       // Replace the code
+       $code = replaceExpressionCode($data, $data['__replacer']);
+
+       // Return the (maybe) replaced code
+       return $code;
+}
+
+// Expression call-back to close form tags
+function doExpressionFormClose ($data) {
+       // Initial replacer is really easy ...
+       $data['__replacer'] = '</form>' . PHP_EOL;
+
+       /*
+        * Call a filter chain to allow more hidden fields being added at the end
+        * of the form.
+        */
+       $data = runFilterChain('close_form_fields', $data);
+
+       // Replace the code
+       $code = replaceExpressionCode($data, $data['__replacer']);
+
+       // Return the (maybe) replaced code
+       return $code;
+}
+
+// Expression call-back to handle jquery inclusion
+function doExpressionJquery ($data) {
+       // Default is compressed
+       $jquery = 'jquery';
+       $data['output_mode'] = '';
+
+       // Is there JS-mode?
+       if ($data['callback'] == 'js') {
+               // Switch to it
+               $data['output_mode'] = ',js';
+       } // END - if
+
+       // Is there a value?
+       if ($data['callback'] == 'js') {
+               // Then load special library
+               $jquery .= '-' . $data['value'];
+       } // END - if
+
+       // Is debug mode enabled?
+       if ((isGetRequestElementSet('jquery')) || (isSessionVariableSet('jquery'))) {
+               // Then use uncompressed
+               $jquery .= '.uncompressed';
+
+               // Remember it in session
+               setSession('jquery', '1');
+       } // END - if
+
+       // Add {%url%} around it
+       $replacer = '{%url' . $data['output_mode'] . '=js/' . $jquery . '.js?dummy=1%}';
+
+       // Replace the code
+       $code = replaceExpressionCode($data, $replacer);
+
+       // Return the (maybe) replaced code
+       return $code;
+}
+
 // [EOF]
 ?>