Merge branch 'release/4.5.6' into support/4

version bump
Fixed escaping of array/object keys in debug_print_var
2026-08-06 13:34:11 +02:00 · 2025-08-26 10:37:46 +02:00 · 2025-08-26 10:37:44 +02:00 · 2025-08-26 10:37:17 +02:00 · 2025-03-17 09:18:09 +01:00 · 2025-03-17 09:15:32 +01:00
11 changed files with 183 additions and 39 deletions
@@ -6,9 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

 ## [Unreleased]

-## [4.5.5] - 2024-11-21
+## [4.5.6] - 2025-08-26
+- Fixed that modifiers called like function would be compiled to modifier name instead of calling the registered callback [#1100](https://github.com/smarty-php/smarty/issues/1100)
+- Replace SMARTY_VERSION constant with $smarty.version in debug.tpl [#1073](https://github.com/smarty-php/smarty/issues/1073)


+- Fixed escaping of array/object keys in debug_print_var
+
+## [4.5.5] - 2024-11-21
+
 - Support the deprecations introduced in PHP 8.4 and added tests for PHP 8.4 [#1084](https://github.com/smarty-php/smarty/pull/1084)

 ## [4.5.4] - 2024-08-14
@@ -12,10 +12,12 @@ These parameters follow the modifier name and are separated by a `:`

 - [capitalize](language-modifier-capitalize.md)
 - [cat](language-modifier-cat.md)
+- [count](language-modifier-count.md)
 - [count_characters](language-modifier-count-characters.md)
 - [count_paragraphs](language-modifier-count-paragraphs.md)
 - [count_sentences](language-modifier-count-sentences.md)
 - [count_words](language-modifier-count-words.md)
+- [debug_print_var](language-modifier-debug-print-var.md)
 - [date_format](language-modifier-date-format.md)
 - [default](language-modifier-default.md)
 - [escape](language-modifier-escape.md)
@@ -0,0 +1,21 @@
+# count
+
+Returns the number of elements in an array (or Countable object). Will return 0 for null.
+Returns 1 for any other type (such as a string).
+
+If the optional mode parameter is set to 1, count() will recursively count the array. 
+This is particularly useful for counting all the elements of a multidimensional array.
+
+## Basic usage
+```smarty
+{if $myVar|count > 3}4 or more{/if}
+{if count($myVar) > 3}4 or more{/if}
+```
+
+
+## Parameters
+
+| Parameter | Type | Required | Description                                            |
+|-----------|------|----------|--------------------------------------------------------|
+| 1         | int  | No       | If set to 1, count() will recursively count the array. |
+
@@ -0,0 +1,26 @@
+# debug_print_var
+
+
+
+Returns the value of the given variable in a human-readable format in HTML. 
+Used in the [debug console](../chapter-debugging-console.md), but you can also use it in your template
+while developing to see what is going on under the hood.
+
+> **Note**
+>
+> Use for debugging only! Since you may accidentally reveal sensitive information or introduce vulnerabilities such as XSS using this
+method never use it in production.
+
+## Basic usage
+```smarty
+{$myVar|debug_print_var}
+```
+
+
+## Parameters
+
+| Parameter | Type | Required | Description                                                            |
+|-----------|------|----------|------------------------------------------------------------------------|
+| 1         | int  | No       | maximum recursion depth if $var is an array or object (defaults to 10) |
+| 2         | int  | No       | maximum string length if $var is a string (defaults to 40)             |
+
@@ -107,7 +107,7 @@ class Smarty extends Smarty_Internal_TemplateBase
    /**
     * smarty version
     */
-    const SMARTY_VERSION = '4.5.5';
+    const SMARTY_VERSION = '4.5.6';
    /**
     * define variable scopes
     */
@@ -108,7 +108,7 @@
    </head>
    <body>

-    <h1>Smarty {Smarty::SMARTY_VERSION} Debug Console
+    <h1>Smarty {$smarty.version} Debug Console
        -  {if isset($template_name)}{$template_name|debug_print_var nofilter} {/if}{if !empty($template_data)}Total Time {$execution_time|string_format:"%.5f"}{/if}</h1>

    {if !empty($template_data)}
@@ -144,6 +144,7 @@
                        {$vars['attributes']|debug_print_var nofilter}
                    {/if}
                </td>
+            </tr>
         {/foreach}
    </table>

@@ -31,7 +31,7 @@ function smarty_modifier_debug_print_var($var, $max = 10, $length = 40, $depth =
                break;
            }
            foreach ($var as $curr_key => $curr_val) {
-                $results .= '<br>' . str_repeat('&nbsp;', $depth * 2) . '<b>' . strtr($curr_key, $_replace) .
+                $results .= '<br>' . str_repeat('&nbsp;', $depth * 2) . '<b>' . htmlspecialchars(strtr($curr_key, $_replace)) .
                            '</b> =&gt; ' .
                            smarty_modifier_debug_print_var($curr_val, $max, $length, ++$depth, $objects);
                $depth--;
@@ -49,7 +49,7 @@ function smarty_modifier_debug_print_var($var, $max = 10, $length = 40, $depth =
            }
            $objects[] = $var;
            foreach ($object_vars as $curr_key => $curr_val) {
-                $results .= '<br>' . str_repeat('&nbsp;', $depth * 2) . '<b> -&gt;' . strtr($curr_key, $_replace) .
+                $results .= '<br>' . str_repeat('&nbsp;', $depth * 2) . '<b> -&gt;' . htmlspecialchars(strtr($curr_key, $_replace)) .
                            '</b> = ' . smarty_modifier_debug_print_var($curr_val, $max, $length, ++$depth, $objects);
                $depth--;
            }
@@ -455,28 +455,28 @@ abstract class Smarty_Internal_TemplateCompilerBase
            $this->smarty->_current_file = $this->template->source->filepath;
            // get template source
            if (!empty($this->template->source->components)) {
-				$_compiled_code = '<?php $_smarty_tpl->_loadInheritance(); $_smarty_tpl->inheritance->init($_smarty_tpl, true); ?>';
+                $_compiled_code = '<?php $_smarty_tpl->_loadInheritance(); $_smarty_tpl->inheritance->init($_smarty_tpl, true); ?>';

-				$i = 0;
-				$reversed_components = array_reverse($this->template->getSource()->components);
-				foreach ($reversed_components as $source) {
-					$i++;
-					if ($i === count($reversed_components)) {
-						$_compiled_code .= '<?php $_smarty_tpl->inheritance->endChild($_smarty_tpl); ?>';
-					}
-					$_compiled_code .= $this->compileTag(
-						'include',
-						[
-							var_export($source->resource, true),
-							['scope' => 'parent'],
-						]
-					);
-				}
-				$_compiled_code = $this->postFilter($_compiled_code, $this->template);
+                $i = 0;
+                $reversed_components = array_reverse($this->template->getSource()->components);
+                foreach ($reversed_components as $source) {
+                    $i++;
+                    if ($i === count($reversed_components)) {
+                        $_compiled_code .= '<?php $_smarty_tpl->inheritance->endChild($_smarty_tpl); ?>';
+                    }
+                    $_compiled_code .= $this->compileTag(
+                        'include',
+                        [
+                            var_export($source->resource, true),
+                            ['scope' => 'parent'],
+                        ]
+                    );
+                }
+                $_compiled_code = $this->postFilter($_compiled_code, $this->template);
            } else {
                // get template source
                $_content = $this->template->source->getContent();
-				$_compiled_code = $this->postFilter($this->doCompile($this->preFilter($_content), true));
+                $_compiled_code = $this->postFilter($this->doCompile($this->preFilter($_content), true));
            }
            if (!empty($this->required_plugins[ 'compiled' ]) || !empty($this->required_plugins[ 'nocache' ])) {
                $_compiled_code = '<?php ' . $this->compileRequiredPlugins() . "?>\n" . $_compiled_code;
@@ -617,7 +617,8 @@ abstract class Smarty_Internal_TemplateCompilerBase
    {
        if (!$this->smarty->security_policy || $this->smarty->security_policy->isTrustedPhpFunction($name, $this)) {
            if (strcasecmp($name, 'isset') === 0 || strcasecmp($name, 'empty') === 0
-                || strcasecmp($name, 'array') === 0 || is_callable($name)
+                || strcasecmp($name, 'array') === 0
+                || (is_callable($name) && !isset($this->smarty->registered_plugins[Smarty::PLUGIN_MODIFIER][$name]))
            ) {
                $func_name = smarty_strtolower_ascii($name);

@@ -649,28 +650,42 @@ abstract class Smarty_Internal_TemplateCompilerBase
                    }
                    if ($func_name === 'empty') {
                        return $func_name . '(' .
-                               str_replace("')->value", "',null,true,false)->value", $parameter[ 0 ]) . ')';
+                            str_replace("')->value", "',null,true,false)->value", $parameter[0]) . ')';
                    } else {
-                        return $func_name . '(' . $parameter[ 0 ] . ')';
+                        return $func_name . '(' . $parameter[0] . ')';
                    }
                } else {

-					if (
-						!$this->smarty->loadPlugin('smarty_modifiercompiler_' . $name)
-						&& !isset($this->smarty->registered_plugins[Smarty::PLUGIN_MODIFIER][$name])
-						&& !in_array($name, ['time', 'join', 'is_array', 'in_array', 'count'])
-					) {
-						trigger_error('Using unregistered function "' . $name . '" in a template is deprecated and will be ' .
-							'removed in a future release. Use Smarty::registerPlugin to explicitly register ' .
-							'a custom modifier.', E_USER_DEPRECATED);
-					}
+                    if (
+                        !$this->smarty->loadPlugin('smarty_modifiercompiler_' . $name)
+                        && !isset($this->smarty->registered_plugins[Smarty::PLUGIN_MODIFIER][$name])
+                        && !in_array($name, ['time', 'join', 'is_array', 'in_array', 'count'])
+                    ) {
+                        trigger_error('Using unregistered function "' . $name . '" in a template is deprecated and will be ' .
+                            'removed in a future release. Use Smarty::registerPlugin to explicitly register ' .
+                            'a custom modifier.', E_USER_DEPRECATED);
+                    }

-					return $name . '(' . implode(',', $parameter) . ')';
+                    return $name . '(' . implode(',', $parameter) . ')';
                }
-            } else {
-                $this->trigger_template_error("unknown function '{$name}'");
+
            }
        }
+
+        if (isset($this->smarty->registered_plugins[Smarty::PLUGIN_MODIFIER][$name])) {
+            if ($name === $this->smarty->registered_plugins[Smarty::PLUGIN_MODIFIER][$name][0]) {
+                return $name . '(' . implode(',', $parameter) . ')';
+            }
+
+            return sprintf(
+                'call_user_func_array($_smarty_tpl->registered_plugins[ \'%s\' ][ %s ][ 0 ], array( %s ))',
+                Smarty::PLUGIN_MODIFIER,
+                var_export($name, true),
+                implode(',', $parameter)
+            );
+        }
+
+        $this->trigger_template_error("unknown function '{$name}'");
    }

    /**
@@ -49,10 +49,12 @@ nav:
        - 'Introduction': 'designers/language-modifiers/index.md'
        - 'capitalize': 'designers/language-modifiers/language-modifier-capitalize.md'
        - 'cat': 'designers/language-modifiers/language-modifier-cat.md'
+        - 'count': 'designers/language-modifiers/language-modifier-count.md'
        - 'count_characters': 'designers/language-modifiers/language-modifier-count-characters.md'
        - 'count_paragraphs': 'designers/language-modifiers/language-modifier-count-paragraphs.md'
        - 'count_sentences': 'designers/language-modifiers/language-modifier-count-sentences.md'
        - 'count_words': 'designers/language-modifiers/language-modifier-count-words.md'
+        - 'debug_print_var': 'designers/language-modifiers/language-modifier-debug-print-var.md'
        - 'date_format': 'designers/language-modifiers/language-modifier-date-format.md'
        - 'default': 'designers/language-modifiers/language-modifier-default.md'
        - 'escape': 'designers/language-modifiers/language-modifier-escape.md'
@@ -122,4 +124,4 @@ nav:
      - 'programmers/caching.md'
      - 'programmers/resources.md'
      - 'programmers/advanced-features.md'
-      - 'programmers/plugins.md'
+      - 'programmers/plugins.md'
@@ -0,0 +1,55 @@
+<?php
+// first class callables where introduced in PHP 8.1
+if (PHP_VERSION_ID >= 80100) {
+
+	/**
+	 * class for register modifier with (first class) callables tests
+	 *
+	 * @runTestsInSeparateProcess
+	 * @preserveGlobalState disabled
+	 * @backupStaticAttributes enabled
+	 */
+	class RegisterModifierFirstClassCallablesTest extends PHPUnit_Smarty
+	{
+		public function setUp(): void
+		{
+			$this->setUpSmarty(__DIR__);
+		}
+
+
+		public function testInit()
+		{
+			$this->cleanDirs();
+		}
+
+		public function testRegisterFirstClassCallable()
+		{
+			$this->smarty->registerPlugin(Smarty::PLUGIN_MODIFIER, 'testmodifier', eval('return strrev(...);'));
+			$this->assertEquals('mosredna', $this->smarty->fetch('string:{"andersom"|testmodifier}'));
+		}
+
+		public function testRegisterFirstClassCallableSameName()
+		{
+			$this->smarty->registerPlugin(Smarty::PLUGIN_MODIFIER, 'mymodifier', eval('return strrev(...);'));
+			$this->assertEquals('mosredna', $this->smarty->fetch('string:{"andersom"|mymodifier}'));
+		}
+
+		public function testRegisterFirstClassCallableAsFunc()
+		{
+			$this->smarty->registerPlugin(Smarty::PLUGIN_MODIFIER, 'kprint_r_out', eval('return strrev(...);'));
+			$this->smarty->assign('myVar', 'andersom');
+			$this->assertEquals('mosredna', $this->smarty->fetch('string:{kprint_r_out($myVar)}'));
+		}
+
+		public function testRegisterFirstClassCallableSameNameAsPhpFunc()
+		{
+			$this->smarty->registerPlugin(Smarty::PLUGIN_MODIFIER, 'mymodifierfcc', eval('return strrev(...);'));
+			$this->assertEquals('mosredna', $this->smarty->fetch('string:{mymodifierfcc("andersom")}'));
+		}
+
+	}
+}
+function mymodifierfcc($a, $b, $c)
+{
+	return "$a function $b $c";
+}
@@ -88,6 +88,22 @@ class RegisterModifierTest extends PHPUnit_Smarty
        $this->smarty->unregisterPlugin(Smarty::PLUGIN_MODIFIER, 'testmodifier');
        $this->assertTrue(isset($this->smarty->registered_plugins[Smarty::PLUGIN_BLOCK]['testmodifier']));
    }
+
+
+    public function testRegisterNativePhpFuncAsString()
+    {
+        $this->smarty->registerPlugin(Smarty::PLUGIN_MODIFIER, 'strrev', 'strrev');
+        $this->smarty->assign('myVar', 'andersom');
+        $this->assertEquals('mosredna', $this->smarty->fetch('string:{strrev($myVar)}'));
+    }
+
+    public function testRegisterNativePhpFuncUnderDifferentName()
+    {
+        $this->smarty->registerPlugin(Smarty::PLUGIN_MODIFIER, 'k_xyz_a', 'strrev');
+        $this->smarty->assign('myVar', 'andersom');
+        $this->assertEquals('mosredna', $this->smarty->fetch('string:{k_xyz_a($myVar)}'));
+    }
+
 }

 function mymodifier($a, $b, $c)
Author	SHA1	Message	Date
Simon Wisselink	a8d77c8666	Merge branch 'release/4.5.6' into support/4	2025-08-26 10:37:46 +02:00
Simon Wisselink	7721e5d786	version bump	2025-08-26 10:37:44 +02:00
Simon Wisselink	3e6a478e93	Fixed escaping of array/object keys in debug_print_var	2025-08-26 10:37:17 +02:00
Shad	c438c79d7d	add count and debug_print_var modifier doc (#1116 )	2025-03-17 09:18:09 +01:00
Shad	e1ef353ccf	add missing closing tr tag (#1117 ) Add missing end tag for 'assigned template variables' section. backport of `d6153d4`	2025-03-17 09:15:32 +01:00
Simon Wisselink	5cb412d040	Bugfix/1100 modifier called like a function compiled to modifier name not callback (#1101 ) * Fixed that modifiers called like function would be compiled to modifier name instead of calling the registered callback	2025-02-13 23:21:21 +01:00
Simon Wisselink	272a407e9d	change SMARTY_VERSION to $smarty.version. Fixes #1073	2024-12-28 17:39:36 +01:00