Deprecate stream variables

Fixes #878

.github/workflows/ci.yml

@@ -31,6 +31,7 @@ jobs:
           - "8.0"
           - "8.1"
           - "8.2"
+          - "8.3"
 
         compiler:
           - default
@@ -45,6 +46,9 @@ jobs:
           - os: ubuntu-latest
             php-version: "8.2"
             compiler: jit
+          - os: ubuntu-latest
+            php-version: "8.3"
+            compiler: jit
 
     steps:
     - name: Checkout

CHANGELOG.md

@@ -6,9 +6,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- PHP8.3 support [#925](https://github.com/smarty-php/smarty/issues/925)
+- Backlink to GitHub in docs
+- Explain how to do escaping and set-up auto-escaping in docs [#865](https://github.com/smarty-php/smarty/issues/865)
+- Link to variable scope page in the documentation for the assign tag [#878](https://github.com/smarty-php/smarty/issues/878)
+
+### Fixed
+- The {debug} tag was broken in v5 [#922](https://github.com/smarty-php/smarty/issues/922)
+- Documentation on `{if $x is even by $y}` syntax
+
+## [5.0.0-rc2] - 2023-11-11
+
 ### Fixed
 - Registered output filters wouldn't run [#899](https://github.com/smarty-php/smarty/issues/899)
 - Use of negative numbers in {math} equations [#895](https://github.com/smarty-php/smarty/issues/895)
+- Do not auto-html-escape custom function results [#906](https://github.com/smarty-php/smarty/issues/906)
 - Fix case-sensitive tag names [#907](https://github.com/smarty-php/smarty/issues/907)
 
 ### Removed
@@ -36,7 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   multibyte extension for optimal performance.
 - Smarty no longer calls `mb_internal_encoding()` and doesn't check for deprecated `mbstring.func_overload` ini directive [#480](https://github.com/smarty-php/smarty/issues/480)
 - Generated `<script>` tags lo longer have deprecated `type="text/javascript"` or `language="Javascript"` attributes [#815](https://github.com/smarty-php/smarty/issues/815)
-- Smarty will throw a compiler exception insteadd of silently ignoring a modifier on a function call, like this: `{include|dot:"x-template-id" file="included.dot.tpl"}` [#526](https://github.com/smarty-php/smarty/issues/526) 
+- Smarty will throw a compiler exception instead of silently ignoring a modifier on a function call, like this: `{include|dot:"x-template-id" file="included.dot.tpl"}` [#526](https://github.com/smarty-php/smarty/issues/526) 
 - The documentation was largely rewritten
 
 ### Deprecated
@@ -68,6 +81,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removed constants such as SMARTY_DIR to prevent global side effects.
 - Removed direct access to `$smarty->template_dir`. Use `$smarty->setTemplateDir()`.
 - Removed direct access to `$smarty->cache_dir`. Use `$smarty->setCacheDir()`.
+- Removed direct access to `$smarty->compile_dir`. Use `$smarty->setCompileDir()`.
 - Removed `$smarty->loadPlugin()`, use `$smarty->registerPlugin()` instead.
 - Removed `$smarty->appendByRef()` and `$smarty->assignByRef()`.
 - Removed `$smarty->_current_file`

README.md

@@ -7,7 +7,7 @@ Smarty is a template engine for PHP, facilitating the separation of presentation
 Read the [documentation](https://smarty-php.github.io/smarty/) to find out how to use it. 
 
 ## Requirements
-Smarty v5 can be run with PHP 7.2 to PHP 8.2.
+Smarty v5 can be run with PHP 7.2 to PHP 8.3.
 
 ## Installation
 Smarty versions 3.1.11 or later can be installed with [Composer](https://getcomposer.org/).

changelog/930.md

@@ -0,0 +1 @@
+- Fix incorrect compilation of expressions when escape_html=true [#930](https://github.com/smarty-php/smarty/pull/930)

docker-compose.yml

@@ -37,7 +37,11 @@ services:
       service: base
     build:
       dockerfile: ./utilities/testrunners/php82/Dockerfile
-
+  php83:
+    extends:
+      service: base
+    build:
+      dockerfile: ./utilities/testrunners/php83/Dockerfile
 volumes:
   smarty-code:
 

docs/api/basics.md

@@ -89,4 +89,5 @@ Run this, and you will see:
 ```
 
 Note how the [escape modifier](../designers/language-modifiers/language-modifier-escape.md) 
-translated the `&` character into the proper HTML syntax `&`.
+translated the `&` character into the proper HTML syntax `&`.
+Read more about auto-escaping in the [next section](./configuring.md).

docs/api/configuring.md

@@ -122,6 +122,24 @@ $smarty->setCacheDir('/data/caches');
 $cacheDir = $smarty->getCacheDir();
 ```
 
+## Enabling auto-escaping
+By default, Smarty does not escape anything you render in your templates. If you use
+Smarty to render a HTML-page, this means that you will have to make sure that you do
+not render any characters that have a special meaning in HTML, such as `&`, `<` and `>`,
+or apply the [escape modifier](../designers/language-modifiers/language-modifier-escape.md) 
+to anything you want to render.
+
+If you forget to do so, you may break your HTML page, or even create a vulnerability for 
+attacks known as [XSS or Cross Site Scripting](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html).
+
+Luckily, you can tell Smarty to automatically apply the escape modifier to any dynamic part of your template.
+It's like Smarty magically adds `|escape` to every variable you use on a web page.
+
+Enable auto-escaping for HTML as follows:
+```php
+$smarty->setEscapeHtml(true);
+```
+
 ## Disabling compile check
 By default, Smarty tests to see if the
 current template has changed since the last time

docs/api/variables/streams.md

@@ -10,4 +10,7 @@ template.
 {$foo:bar}
 ```
 
+NB. Support for using streams to call variables is deprecated since Smarty v5.1 and will be removed
+in a future version. 
+
 See also [`Template Resources`](../resources.md)

docs/designers/language-builtin-functions/language-function-assign.md

@@ -8,12 +8,12 @@ execution of a template**.
 |----------------|------------|-----------------------------------------------------------------------|
 | var            |            | The name of the variable being assigned                               | 
 | value          |            | The value being assigned                                              |                             
-| scope          | (optional) | The scope of the assigned variable: \'parent\',\'root\' or \'global\' | 
+| scope          | (optional) | The scope of the assigned variable: 'parent','root' or 'global' | 
 
 ## Attributes of the {$var=...} syntax
 | Attribute Name | Required   | Description                                                           |
 |----------------|------------|-----------------------------------------------------------------------|
-| scope          | (optional) | The scope of the assigned variable: \'parent\',\'root\' or \'global\' | 
+| scope          | (optional) | The scope of the assigned variable: 'parent','root' or 'global' | 
 
 ## Option Flags
 | Name    | Description                                       |
@@ -102,6 +102,8 @@ A global variable is seen by all templates.
 {$foo="bar" scope="global"}
 ```
  
+For more information on variable scope, please read the page on [variable scopes](../language-variables/language-variable-scopes.md).
+
 To access `{assign}` variables from a php script use
 [`getTemplateVars()`](../../programmers/api-functions/api-get-template-vars.md). 
 Here's the template that creates the variable `$foo`.

docs/designers/language-builtin-functions/language-function-foreach.md

@@ -252,7 +252,7 @@ iteration.
 
 ```smarty
  {foreach $myNames as $name}
-   {if $name@iteration is even by 3}
+   {if $name@index is even by 3}
      <span style="color: #000">{$name}</span>
    {else}
      <span style="color: #eee">{$name}</span>

docs/designers/language-builtin-functions/language-function-section.md

@@ -478,13 +478,13 @@ header block every five rows.
 </table>
 ```
 
-An example that uses the `iteration` property to alternate a text color every
+An example that uses the `index` property to alternate a text color every
 third row.
 
 ```smarty
 <table>
   {section name=co loop=$contacts}
-    {if $smarty.section.co.iteration is even by 3}
+    {if $smarty.section.co.index is even by 3}
       <span style="color: #ffffff">{$contacts[co].name}</span>
     {else}
       <span style="color: #dddddd">{$contacts[co].name}</span>

docs/features.md

@@ -134,8 +134,8 @@ that would be needed otherwise? Does the codebase or framework you plan
 on using have the features you need for the presentation component?
 
 ## Sites using Smarty
-Many well-known PHP projects make use of Smarty such as XOOPS CMS, CMS Made Simple, Tiki
-CMS/Groupware and X-Cart to name a few.
+Many well-known PHP projects make use of Smarty such as XOOPS CMS, CMS Made Simple, 
+Tiki Wiki CMS Groupware and X-Cart to name a few.
 
 ## Summary
 Whether you are using Smarty for a small website or massive enterprise

docs/getting-started.md

@@ -1,7 +1,7 @@
 # Getting started
 
 ## Requirements
-Smarty can be run with PHP 7.2 to PHP 8.2.
+Smarty can be run with PHP 7.2 to PHP 8.3.
 
 ## Installation
 Smarty can be installed with [Composer](https://getcomposer.org/).
@@ -16,9 +16,9 @@ To get the latest, unreleased version, use:
 composer require smarty/smarty:dev-master
 ```
 
-To get the previous stable version of Smarty, Smarty 3, use:
+To get the previous stable version of Smarty, Smarty 4, use:
 ```shell
-composer require smarty/smarty:^3
+composer require smarty/smarty:^4
 ```
 
 Here's how you create an instance of Smarty in your PHP scripts:
@@ -86,7 +86,7 @@ needs to be located in the [`$template_dir`](./programmers/api-variables/variabl
 
 ```smarty
 {* Smarty *}
-Hello {$name}, welcome to Smarty!
+<h1>Hello {$name|escape}, welcome to Smarty!</h1>
 ```
 
 > **Note**
@@ -132,6 +132,20 @@ Now, run your PHP file. You should see *"Hello Ned, welcome to Smarty!"*
 
 You have completed the basic setup for Smarty!
 
+## Escaping
+You may have noticed that the example template above renders the `$name` variable using
+the [escape modifier](./designers/language-modifiers/language-modifier-escape.md).  This 
+modifier makes string 'safe' to use in the context of an HTML page.
+
+If you are primarily using Smarty for HTML-pages, it is recommended to enable automatic
+escaping. This way, you don't have to add `|escape` to every variable you use on a web page. 
+Smarty will handle it automatically for you!
+
+Enable auto-escaping for HTML as follows:
+```php
+$smarty->setEscapeHtml(true);
+```
+
 ## Extended Setup
 
 This is a continuation of the [basic installation](#installation), please read that first!
@@ -156,6 +170,8 @@ class My_GuestBook extends Smarty {
         $this->setCompileDir('/web/www.example.com/guestbook/templates_c/');
         $this->setConfigDir('/web/www.example.com/guestbook/configs/');
         $this->setCacheDir('/web/www.example.com/guestbook/cache/');
+        
+        $this->setEscapeHtml(true);
 
         $this->caching = Smarty::CACHING_LIFETIME_CURRENT;
         $this->assign('app_name', 'Guest Book');

docs/index.md

@@ -26,5 +26,10 @@ and 480 for $height, the result is:
 - [Features](./features.md) - or "Why do I want Smarty?"
 
 ## Help
+- [Search or create an issue](https://github.com/smarty-php/smarty/issues)
+- [Upgrading from an older version](upgrading.md)
 - [Some random tips & tricks](./appendixes/tips.md)
 - [Troubleshooting](./appendixes/troubleshooting.md)
+
+## Source code
+- [Smarty repository at GitHub](https://github.com/smarty-php/smarty)

docs/upgrading.md

@@ -0,0 +1,156 @@
+# Upgrading from an older version
+
+## Upgrading from v4 to v5
+
+Smarty 5 adds support for PHP8.2 and drops support for PHP7.1. Smarty also adds support for new features
+such as the ternary operator (`{$test ? $a : $b}` and `{$var ?: $value_if_falsy}`), the null coalescing operator (`{$var ?? $value_if_null}`) 
+and positional parameters for custom tags.
+Smarty 5 also has a brand-new extension architecture that allows you to write neat extension packs.
+
+### Namespaces
+All Smarty code has been moved into the `\Smarty` namespace. This reduces
+the chance of conflicts with other (your) code.
+
+For simple use-cases, you only need to add `use Smarty\Smarty;` to your script and everything will work. 
+
+```php
+<?php
+use Smarty\Smarty;
+$smarty = new Smarty();
+
+$smarty->display('homepage.tpl');
+```
+For more information, see [getting started](getting-started.md).
+
+If you extend Smarty or use Smarty plug-ins, please review your code to see if they assume specific class or method names.
+E.g.: `Smarty_Internal_Template` is now `\Smarty\Template\`, `SmartyException` is now `\Smarty\Exception`.
+
+### Variable scope bubbling
+Template variable scope bubbling has been simplified and made more consistent. The global scope now equals the Smarty 
+scope in order to avoid global state side effects. Please read the [documentation on language variable scope](designers/language-variables/language-variable-scopes.md)
+for more details.
+
+Also, `{config_load}` no longer has a `scope` parameter, which means you can no longer load config
+from inside your template into the global scope (again, to avoid global state side effects). If you 
+need to set global config, use the [configLoad API method](api/variables/config-files.md) from your PHP code.
+
+### Using native PHP-functions or userland functions in your templates
+You can no longer use native PHP-functions or userland functions in your templates without registering them. 
+If you need a function in your templates, register it first.
+
+The easiest way to do so is as follows:
+```php
+// native PHP functions used as modifiers need to be registered
+$smarty->registerPlugin('modifier', 'substr', 'substr');
+
+// userland PHP functions used as modifiers need to be registered
+$smarty->registerPlugin('modifier', 'my_special_func', 'my_special_func');
+```
+
+But you may want to consider writing a proper [extension](api/extending/extensions.md).
+
+### Removed undocumented tags
+
+Smarty 4 still supported some tags that have been carried over from previous version, but have never been documented.
+
+- `{block_parent}` should be replaced with `{$smarty.block.parent}`
+- `{parent}` should be replaced with `{$smarty.block.parent}`
+- `{block_child}` should be replaced with `{$smarty.block.child}`
+- `{child}` should be replaced with `{$smarty.block.child}`
+
+- `{make_nocache}` is no longer supported
+- `{insert}` is no longer supported
+
+### Removed Smarty API properties
+
+In Smarty 4, you could make many configuration changes by directly accessing public properties on the Smarty object in PHP.
+In many cases, these properties have been made private, and you should now use the appropriate setter method:
+
+- `$smarty->left_delimiter` should be replaced with `$smarty->getLeftDelimiter()`/`$smarty->setLeftDelimiter()`
+- `$smarty->right_delimiter` should be replaced with `$smarty->getRightDelimiter()`/`$smarty->setRightDelimiter()`
+- `$smarty->autoload_filters` should be replaced with `$smarty->registerFilter()`
+- `$smarty->template_dir` should be replaced with `$smarty->setTemplateDir()`
+- `$smarty->cache_dir` should be replaced with `$smarty->setCacheDir()`
+- `$smarty->compile_dir` should be replaced with `$smarty->setCompileDir()`
+
+Other public properties have been removed altogether, and you should no longer access them:
+
+- `$smarty->_current_file`
+- `$smarty->allow_ambiguous_resources` (ambiguous resources handlers should still work)
+- `$smarty->registered_filters`
+- `$smarty->direct_access_security`
+- `$smarty->trusted_dir`
+- `$smarty->allow_php_templates`
+- `$smarty->php_functions`
+- `$smarty->php_modifiers`
+
+### Backwards incompatible changes to custom plugins
+
+We have dropped support for `$smarty->plugins_dir` and `$smarty->use_include_path`.
+Use `$smarty->addPluginsDir()` or consider writing a proper [extension](api/extending/extensions.md).
+
+The 'insert' plugin type is no longer supported.
+
+The `$cache_attrs` parameter for registered plugins is no longer supported.
+
+### Removed Smarty API methods
+
+Search your code for the following changes:
+
+- `$smarty->getTags()` is no longer supported
+- `$smarty->appendByRef()` should be replaced with `$smarty->append()`
+- `$smarty->assignByRef()` should be replaced with `$smarty->assign()`
+- `$smarty->loadPlugin()` should be replaced with `$smarty->registerPlugin()`
+
+### Removed PHP constants
+
+The following constants have been removed to prevent global side effects.
+
+- `SMARTY_DIR`
+- `SMARTY_SYSPLUGINS_DIR`
+- `SMARTY_PLUGINS_DIR`
+- `SMARTY_MBSTRING`
+- `SMARTY_HELPER_FUNCTIONS_LOADED`
+
+### Other changes
+
+- Smarty now always runs in multibyte mode. Make sure you use the [PHP multibyte extension](https://www.php.net/manual/en/book.mbstring.php) in production for optimal performance.
+- Generated `<script>` tags lo longer have deprecated `type="text/javascript"` or `language="Javascript"` attributes
+- Smarty will throw a compiler exception instead of silently ignoring a modifier on a function call, like this: `{include|dot:"x-template-id" file="included.dot.tpl"}`
+
+## Upgrading from v3 to v4
+
+Smarty 4 is mostly identical to Smarty 3. Most notably, it adds support for PHP8 and drops support for PHP7.0 and below.
+Additionally, some deprecated features that have long been discouraged have been dropped from the language.
+
+### Muting PHP8 warnings
+If you simultaneously upgrade Smarty to v4 van PHP to v8, you may notice your error logs filling up with warnings about undefined or null template vars 
+due to a change in how PHP handles these. This may be helpful to spot errors, but if you find this annoying, you can use
+`$smarty->muteUndefinedOrNullWarnings()` to make Smarty convert these warnings into notices.
+
+### ASP tags
+You can no longer user ASP-style tags like `<% %>` and `<%= %>` in your templates.
+Replace them with `{...}` tags.
+
+### SmartyBC
+Check your codebase for `SmartyBC`.
+We have dropped deprecated API calls that where only accessible through the SmartyBC class.
+
+### No more embedded PHP
+We have completely dropped support for `{php}` and `{include_php}` tags and embedded PHP in templates.
+Check your templates for this, and rewrite any embedded PHP blocks, by moving logic to your PHP files or by
+creating a [custom tag](./api/extending/tags.md). 
+
+### Other changes
+
+Search your code for the following changes: 
+
+- `SMARTY_RESOURCE_CHAR_SET` and `SMARTY_RESOURCE_DATE_FORMAT` constants have been removed
+- `Smarty::muteExpectedErrors` and `Smarty::unmuteExpectedErrors` API methods have been removed
+- `Smarty::getVariable` method has been removed. Use [Smarty::getTemplateVars](designers/language-builtin-functions/language-function-assign.md) instead.
+- [Smarty::registerResource](api/resources.md) no longer accepts an array of callback functions
+
+
+
+
+

make-release.sh

@@ -8,8 +8,9 @@ else
 fi
 
 git checkout -b "release/$1"
-sed -i "s/## \\[Unreleased\\]/## \\[Unreleased\\]\\n\\n## \\[$1\\] - $(date +%Y-%m-%d)/" CHANGELOG.md
-sed -i "s/const SMARTY_VERSION = '[^']\+';/const SMARTY_VERSION = '$1';/" src/Smarty.php
+
+php utilities/update-changelog.php $1
+php utilities/update-smarty-version-number.php $1
 
 git add CHANGELOG.md src/Smarty.php
 git commit -m "version bump"

mkdocs.yml

@@ -26,7 +26,9 @@ markdown_extensions:
 
 nav:
   - Home: 'index.md'
-  - 'Getting started': 'getting-started.md'
+  - 'Getting started':
+    - Introduction: 'getting-started.md'
+    - 'Upgrading from an older version': 'upgrading.md'
   - 'Language reference':
     - 'Basic Syntax':
         - Introduction: 'designers/language-basic-syntax/index.md'

run-tests-for-all-php-versions.sh

@@ -13,3 +13,4 @@ $COMPOSE_CMD run --rm php74 ./run-tests.sh $@ && \
 $COMPOSE_CMD run --rm php80 ./run-tests.sh $@ && \
 $COMPOSE_CMD run --rm php81 ./run-tests.sh $@ && \
 $COMPOSE_CMD run --rm php82 ./run-tests.sh $@
+$COMPOSE_CMD run --rm php83 ./run-tests.sh $@

src/Compile/PrintExpressionCompiler.php

@@ -84,7 +84,7 @@ class PrintExpressionCompiler extends Base {
 				}
 
 				if ($compiler->getTemplate()->getSmarty()->escape_html) {
-					$output = "htmlspecialchars((string) {$output}, ENT_QUOTES, '" . addslashes(\Smarty\Smarty::$_CHARSET) . "')";
+					$output = "htmlspecialchars((string) ({$output}), ENT_QUOTES, '" . addslashes(\Smarty\Smarty::$_CHARSET) . "')";
 				}
 
 			}

src/Compiler/Template.php

@@ -593,8 +593,6 @@ class Template extends BaseCompiler {
 	public function getTagCompiler($tag): ?\Smarty\Compile\CompilerInterface {
         $tag = strtolower($tag);
 
-		$tag = strtolower($tag);
-
 		if (isset($this->smarty->security_policy) && !$this->smarty->security_policy->isTrustedTag($tag, $this)) {
 			return null;
 		}
@@ -1143,7 +1141,7 @@ class Template extends BaseCompiler {
 		if ($this->smarty->getFunctionHandler($base_tag)) {
 			if (!isset($this->smarty->security_policy) || $this->smarty->security_policy->isTrustedTag($base_tag, $this)) {
 				return (new \Smarty\Compile\PrintExpressionCompiler())->compile(
-					[],
+					['nofilter'], // functions are never auto-escaped
 					$this,
 					['value' =>	$this->compileFunctionCall($base_tag, $args, $parameter)]
 				);

src/Debug.php

@@ -6,16 +6,7 @@ namespace Smarty;
  * Smarty Internal Plugin Debug
  * Class to collect data for the Smarty Debugging Console
  *
-
-
  * @author     Uwe Tews
- */
-
-/**
- * Smarty Internal Plugin Debug Class
- *
-
-
  */
 class Debug extends Data
 {
@@ -24,14 +15,14 @@ class Debug extends Data
      *
      * @var array
      */
-    public $template_data = array();
+    public $template_data = [];
 
     /**
      * List of uid's which shall be ignored
      *
      * @var array
      */
-    public $ignore_uid = array();
+    public $ignore_uid = [];
 
     /**
      * Index of display() and fetch() calls
@@ -50,10 +41,10 @@ class Debug extends Data
     /**
      * Start logging template
      *
-     * @param \Smarty\Template $template template
+     * @param Template $template template
      * @param null                      $mode     true: display   false: fetch  null: subtemplate
      */
-    public function start_template(\Smarty\Template $template, $mode = null)
+    public function start_template(Template $template, $mode = null)
     {
         if (isset($mode) && !$template->_isSubTpl()) {
             $this->index++;
@@ -67,9 +58,9 @@ class Debug extends Data
     /**
      * End logging of cache time
      *
-     * @param \Smarty\Template $template cached template
+     * @param Template $template cached template
      */
-    public function end_template(\Smarty\Template $template)
+    public function end_template(Template $template)
     {
         $key = $this->get_key($template);
         $this->template_data[ $this->index ][ $key ][ 'total_time' ] +=
@@ -79,15 +70,15 @@ class Debug extends Data
     /**
      * Start logging of compile time
      *
-     * @param \Smarty\Template $template
+     * @param Template $template
      */
-    public function start_compile(\Smarty\Template $template)
+    public function start_compile(Template $template)
     {
         static $_is_stringy = array('string' => true, 'eval' => true);
         if (!empty($template->getCompiler()->trace_uid)) {
             $key = $template->getCompiler()->trace_uid;
             if (!isset($this->template_data[ $this->index ][ $key ])) {
-	            $this->saveTemplateData($_is_stringy, $template, $key);
+                $this->saveTemplateData($_is_stringy, $template, $key);
             }
         } else {
             if (isset($this->ignore_uid[ $template->getSource()->uid ])) {
@@ -101,9 +92,9 @@ class Debug extends Data
     /**
      * End logging of compile time
      *
-     * @param \Smarty\Template $template
+     * @param Template $template
      */
-    public function end_compile(\Smarty\Template $template)
+    public function end_compile(Template $template)
     {
         if (!empty($template->getCompiler()->trace_uid)) {
             $key = $template->getCompiler()->trace_uid;
@@ -120,9 +111,9 @@ class Debug extends Data
     /**
      * Start logging of render time
      *
-     * @param \Smarty\Template $template
+     * @param Template $template
      */
-    public function start_render(\Smarty\Template $template)
+    public function start_render(Template $template)
     {
         $key = $this->get_key($template);
         $this->template_data[ $this->index ][ $key ][ 'start_time' ] = microtime(true);
@@ -131,9 +122,9 @@ class Debug extends Data
     /**
      * End logging of compile time
      *
-     * @param \Smarty\Template $template
+     * @param Template $template
      */
-    public function end_render(\Smarty\Template $template)
+    public function end_render(Template $template)
     {
         $key = $this->get_key($template);
         $this->template_data[ $this->index ][ $key ][ 'render_time' ] +=
@@ -143,9 +134,9 @@ class Debug extends Data
     /**
      * Start logging of cache time
      *
-     * @param \Smarty\Template $template cached template
+     * @param Template $template cached template
      */
-    public function start_cache(\Smarty\Template $template)
+    public function start_cache(Template $template)
     {
         $key = $this->get_key($template);
         $this->template_data[ $this->index ][ $key ][ 'start_time' ] = microtime(true);
@@ -154,9 +145,9 @@ class Debug extends Data
     /**
      * End logging of cache time
      *
-     * @param \Smarty\Template $template cached template
+     * @param Template $template cached template
      */
-    public function end_cache(\Smarty\Template $template)
+    public function end_cache(Template $template)
     {
         $key = $this->get_key($template);
         $this->template_data[ $this->index ][ $key ][ 'cache_time' ] +=
@@ -166,9 +157,9 @@ class Debug extends Data
     /**
      * Register template object
      *
-     * @param \Smarty\Template $template cached template
+     * @param Template $template cached template
      */
-    public function register_template(\Smarty\Template $template)
+    public function register_template(Template $template)
     {
     }
 
@@ -184,13 +175,13 @@ class Debug extends Data
     /**
      * Opens a window for the Smarty Debugging Console and display the data
      *
-     * @param \Smarty\Template|\Smarty $obj object to debug
+     * @param Template|Smarty $obj object to debug
      * @param bool                            $full
      *
      * @throws \Exception
-     * @throws \Smarty\Exception
+     * @throws Exception
      */
-    public function display_debug($obj, $full = false)
+    public function display_debug($obj, bool $full = false)
     {
         if (!$full) {
             $this->offset++;
@@ -200,18 +191,18 @@ class Debug extends Data
         $smarty = $obj->getSmarty();
         // create fresh instance of smarty for displaying the debug console
         // to avoid problems if the application did overload the Smarty class
-        $debObj = new \Smarty\Smarty();
+        $debObj = new Smarty();
         // copy the working dirs from application
         $debObj->setCompileDir($smarty->getCompileDir());
-        $debObj->compile_check = \Smarty::COMPILECHECK_ON;
+        $debObj->compile_check = Smarty::COMPILECHECK_ON;
         $debObj->security_policy = null;
         $debObj->debugging = false;
         $debObj->debugging_ctrl = 'NONE';
         $debObj->error_reporting = E_ALL & ~E_NOTICE;
-        $debObj->debug_tpl = $smarty->debug_tpl ?? 'file:' . __DIR__ . '/../debug.tpl';
+        $debObj->debug_tpl = $smarty->debug_tpl ?? 'file:' . __DIR__ . '/debug.tpl';
         $debObj->registered_resources = array();
         $debObj->escape_html = true;
-        $debObj->caching = \Smarty::CACHING_OFF;
+        $debObj->caching = Smarty::CACHING_OFF;
         // prepare information of assigned variables
         $ptr = $this->get_debug_vars($obj);
         $_assigned_vars = $ptr->tpl_vars;
@@ -223,7 +214,7 @@ class Debug extends Data
         $displayMode = $debugging === 2 || !$full;
         $offset = $this->offset * 50;
         $_template = $debObj->doCreateTemplate($debObj->debug_tpl);
-        if ($obj instanceof \Smarty\Template) {
+        if ($obj instanceof Template) {
             $_template->assign('template_name', $templateName);
         } elseif ($obj instanceof Smarty || $full) {
             $_template->assign('template_data', $this->template_data[$this->index]);
@@ -298,11 +289,11 @@ class Debug extends Data
     /**
      * Return key into $template_data for template
      *
-     * @param \Smarty\Template $template template object
+     * @param Template $template template object
      *
      * @return string key into $template_data
      */
-    private function get_key(\Smarty\Template $template)
+    private function get_key(Template $template)
     {
         static $_is_stringy = array('string' => true, 'eval' => true);
 
@@ -319,9 +310,9 @@ class Debug extends Data
     /**
      * Ignore template
      *
-     * @param \Smarty\Template $template
+     * @param Template $template
      */
-    public function ignore(\Smarty\Template $template)
+    public function ignore(Template $template)
     {
         $this->ignore_uid[$template->getSource()->uid] = true;
     }
@@ -329,9 +320,9 @@ class Debug extends Data
     /**
      * handle 'URL' debugging mode
      *
-     * @param \Smarty $smarty
+     * @param Smarty $smarty
      */
-    public function debugUrl(\Smarty $smarty)
+    public function debugUrl(Smarty $smarty)
     {
         if (isset($_SERVER[ 'QUERY_STRING' ])) {
             $_query_string = $_SERVER[ 'QUERY_STRING' ];
@@ -360,12 +351,12 @@ class Debug extends Data
 
 	/**
 	 * @param array $_is_stringy
-	 * @param \Smarty\Template $template
+	 * @param Template $template
 	 * @param string $key
 	 *
 	 * @return void
 	 */
-	private function saveTemplateData(array $_is_stringy, \Smarty\Template $template, string $key): void {
+	private function saveTemplateData(array $_is_stringy, Template $template, string $key): void {
 		if (isset($_is_stringy[$template->getSource()->type])) {
 			$this->template_data[$this->index][$key]['name'] =
 				'\'' . substr($template->getSource()->name, 0, 25) . '...\'';

src/ErrorHandler.php

@@ -77,7 +77,7 @@ class ErrorHandler
         }
 
         if ($this->allowUndefinedArrayKeys && preg_match(
-            '/^(Undefined index|Undefined array key|Trying to access array offset on value of type)/',
+            '/^(Undefined index|Undefined array key|Trying to access array offset on)/',
             $errstr
         )) {
             return; // suppresses this error

src/Extension/ExtensionInterface.php

@@ -2,20 +2,82 @@
 
 namespace Smarty\Extension;
 
+use Smarty\BlockHandler\BlockHandlerInterface;
+use Smarty\Compile\CompilerInterface;
+use Smarty\Compile\Modifier\ModifierCompilerInterface;
+use Smarty\FunctionHandler\FunctionHandlerInterface;
+
 interface ExtensionInterface {
 
-	public function getTagCompiler(string $tag): ?\Smarty\Compile\CompilerInterface;
+	/**
+	 * Either return \Smarty\Compile\CompilerInterface that will compile the given $tag or
+	 * return null to indicate that you do not know how to handle this $tag. (Another Extension might.)
+	 *
+	 * @param string $tag
+	 * @return CompilerInterface|null
+	 */
+	public function getTagCompiler(string $tag): ?CompilerInterface;
 
-	public function getModifierCompiler(string $modifier): ?\Smarty\Compile\Modifier\ModifierCompilerInterface;
+	/**
+	 * Either return \Smarty\Compile\Modifier\ModifierCompilerInterface that will compile the given $modifier or
+	 * return null to indicate that you do not know how to handle this $modifier. (Another Extension might.)
+	 *
+	 * @param string $modifier
+	 * @return ModifierCompilerInterface|null
+	 */
+	public function getModifierCompiler(string $modifier): ?ModifierCompilerInterface;
 
-	public function getFunctionHandler(string $functionName): ?\Smarty\FunctionHandler\FunctionHandlerInterface;
+	/**
+	 * Either return \Smarty\FunctionHandler\FunctionHandlerInterface that will handle the given $functionName or
+	 * return null to indicate that you do not know how to handle this $functionName. (Another Extension might.)
+	 *
+	 * @param string $functionName
+	 * @return FunctionHandlerInterface|null
+	 */
+	public function getFunctionHandler(string $functionName): ?FunctionHandlerInterface;
 
-	public function getBlockHandler(string $blockTagName): ?\Smarty\BlockHandler\BlockHandlerInterface;
+	/**
+	 * Either return \Smarty\BlockHandler\BlockHandlerInterface that will handle the given $blockTagName or return null
+	 * to indicate that you do not know how to handle this $blockTagName. (Another Extension might.)
+	 *
+	 * @param string $blockTagName
+	 * @return BlockHandlerInterface|null
+	 */
+	public function getBlockHandler(string $blockTagName): ?BlockHandlerInterface;
 
+	/**
+	 * Either return a callable that takes at least 1 parameter (a string) and returns a modified string or return null
+	 * to indicate that you do not know how to handle this $modifierName. (Another Extension might.)
+	 *
+	 * The callable can accept additional optional parameters.
+	 *
+	 * @param string $modifierName
+	 * @return callable|null
+	 */
 	public function getModifierCallback(string $modifierName);
 
+	/**
+	 * Return a list of prefilters that will all be applied, in sequence.
+	 * Template prefilters can be used to preprocess templates before they are compiled.
+	 *
+	 * @return \Smarty\Filter\FilterInterface[]
+	 */
 	public function getPreFilters(): array;
+
+	/**
+	 * Return a list of postfilters that will all be applied, in sequence.
+	 * Template postfilters can be used to process compiled template code (so, after the compilation).
+	 *
+	 * @return \Smarty\Filter\FilterInterface[]
+	 */
 	public function getPostFilters(): array;
+
+	/**
+	 * Return a list of outputfilters that will all be applied, in sequence.
+	 * Template outputfilters can be used to change template output just before it is rendered.
+	 *
+	 * @return \Smarty\Filter\FilterInterface[]
+	 */
 	public function getOutputFilters(): array;
 
 }

src/Smarty.php

@@ -53,7 +53,7 @@ class Smarty extends \Smarty\TemplateBase {
 	/**
 	 * smarty version
 	 */
-	const SMARTY_VERSION = '5.0.0-rc1';
+	const SMARTY_VERSION = '5.0.0-rc2';
 
 	/**
 	 * define caching modes
@@ -251,9 +251,10 @@ class Smarty extends \Smarty\TemplateBase {
 
 	/**
 	 * debug mode
-	 * Setting this to true enables the debug-console.
+	 * Setting this to true enables the debug-console. Setting it to 2 enables individual Debug Console window by
+	 * template name.
 	 *
-	 * @var boolean
+	 * @var boolean|int
 	 */
 	public $debugging = false;
 

src/Template.php

@@ -555,6 +555,9 @@ class Template extends TemplateBase {
 	 */
 	public function getStreamVariable($variable)
 	{
+
+		trigger_error("Using stream variables (\`\{\$foo:bar\}\`)is deprecated.", E_USER_DEPRECATED);
+
 		$_result = '';
 		$fp = fopen($variable, 'r+');
 		if ($fp) {

src/debug.tpl

@@ -1,4 +1,4 @@
-{capture name='_smarty_debug' assign=debug_output}
+{capture name='_smarty_debug' assign='debug_output'}
     <!DOCTYPE html>
     <html lang="en">
     <head>
@@ -108,7 +108,7 @@
     </head>
     <body>
 
-    <h1>Smarty {Smarty::SMARTY_VERSION} Debug Console
+    <h1>Smarty {\Smarty\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)}
@@ -166,7 +166,7 @@
     </body>
     </html>
 {/capture}
-<script type="text/javascript">
+<script>
     _smarty_console = window.open("", "console{$targetWindow}", "width=1024,height=600,left={$offset},top={$offset},resizable,scrollbars=yes");
     _smarty_console.document.write("{$debug_output|escape:'javascript' nofilter}");
     _smarty_console.document.close();

tests/UnitTests/A_Core/AutoEscape/AutoEscapeTest.php

@@ -30,4 +30,35 @@ class AutoEscapeTest extends PHPUnit_Smarty
         $tpl->assign('foo', '<a@b.c>');
         $this->assertEquals("&lt;a@b.c&gt;", $this->smarty->fetch($tpl));
     }
+
+    /**
+     * test 'escapeHtml' property
+     * @group issue906
+     */
+    public function testAutoEscapeDoesNotEscapeFunctionPlugins()
+    {
+        $this->smarty->registerPlugin(
+            \Smarty\Smarty::PLUGIN_FUNCTION,
+            'horizontal_rule',
+            function ($params, $smarty)	{ return "<hr>"; }
+        );
+        $tpl = $this->smarty->createTemplate('eval:{horizontal_rule}');
+        $this->assertEquals("<hr>", $this->smarty->fetch($tpl));
+    }
+
+    /**
+     * test 'escapeHtml' property
+     * @group issue906
+     */
+    public function testAutoEscapeDoesNotEscapeBlockPlugins()
+    {
+        $this->smarty->registerPlugin(
+            \Smarty\Smarty::PLUGIN_BLOCK,
+            'paragraphify',
+            function ($params, $content)	{ return $content == null ? null :  "<p>".$content."</p>"; }
+        );
+        $tpl = $this->smarty->createTemplate('eval:{paragraphify}hi{/paragraphify}');
+        $this->assertEquals("<p>hi</p>", $this->smarty->fetch($tpl));
+    }
+
 }

tests/UnitTests/TemplateSource/TagTests/Debug/DebugTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace UnitTests\TemplateSource\TagTests\Debug;
+use PHPUnit_Smarty;
+use Smarty\Smarty;
+
+/**
+ * Smarty PHPunit tests of {debug} tag
+ */
+class PluginModifierStripTagsTest extends PHPUnit_Smarty {
+
+	public function setUp(): void {
+		$this->setUpSmarty(__DIR__);
+	}
+	public function testDefault() {
+		$tpl = $this->smarty->createTemplate('eval:{debug}');
+		$output = $this->smarty->fetch($tpl);
+		$this->assertStringContainsString("<script", $output);
+		$this->assertStringContainsString("</script>", $output);
+	}
+
+}

tests/UnitTests/TemplateSource/TagTests/If/CompileIfTest.php

@@ -103,7 +103,37 @@ class CompileIfTest extends PHPUnit_Smarty
                      array('{if 6 is not even}yes{else}no{/if}', 'no', 'IsNotEven', $i ++),
                      array('{if 3 is odd}yes{else}no{/if}', 'yes', 'IsOdd', $i ++),
                      array('{if 3 is not odd}yes{else}no{/if}', 'no', 'IsNotOdd', $i ++),
-                     array('{$foo=3}{if 3 is odd by $foo}yes{else}no{/if}', 'yes', 'IsOddByVar', $i ++),
+
+                     array('{if 0 is even by 3}yes{else}no{/if}', 'yes', 'IsEvenByTest0', $i ++),
+                     array('{if 1 is even by 3}yes{else}no{/if}', 'yes', 'IsEvenByTest1', $i ++),
+                     array('{if 2 is even by 3}yes{else}no{/if}', 'yes', 'IsEvenByTest2', $i ++),
+                     array('{if 3 is even by 3}yes{else}no{/if}', 'no', 'IsEvenByTest3', $i ++),
+                     array('{if 4 is even by 3}yes{else}no{/if}', 'no', 'IsEvenByTest4', $i ++),
+                     array('{if 5 is even by 3}yes{else}no{/if}', 'no', 'IsEvenByTest5', $i ++),
+                     array('{if 6 is even by 3}yes{else}no{/if}', 'yes', 'IsEvenByTest6', $i ++),
+                     array('{if 7 is even by 3}yes{else}no{/if}', 'yes', 'IsEvenByTest7', $i ++),
+
+                     array('{if 0 is odd by 3}yes{else}no{/if}', 'no', 'IsOddByTest0', $i ++),
+                     array('{if 1 is odd by 3}yes{else}no{/if}', 'no', 'IsOddByTest1', $i ++),
+                     array('{if 2 is odd by 3}yes{else}no{/if}', 'no', 'IsOddByTest2', $i ++),
+                     array('{if 3 is odd by 3}yes{else}no{/if}', 'yes', 'IsOddByTest3', $i ++),
+                     array('{if 4 is odd by 3}yes{else}no{/if}', 'yes', 'IsOddByTest4', $i ++),
+                     array('{if 5 is odd by 3}yes{else}no{/if}', 'yes', 'IsOddByTest5', $i ++),
+                     array('{if 6 is odd by 3}yes{else}no{/if}', 'no', 'IsOddByTest6', $i ++),
+                     array('{if 7 is odd by 3}yes{else}no{/if}', 'no', 'IsOddByTest7', $i ++),
+
+                     array('{if 2 is even by 3}yes{else}no{/if}', 'yes', 'IsEvenByVal1', $i ++),
+                     array('{if 3 is even by 2}yes{else}no{/if}', 'no', 'IsEvenByVal2', $i ++),
+                     array('{if 4 is even by 3}yes{else}no{/if}', 'no', 'IsEvenByVal3', $i ++),
+                     array('{$foo=3}{if 2 is even by $foo}yes{else}no{/if}', 'yes', 'IsEvenByVar1', $i ++),
+                     array('{$foo=2}{if 3 is even by $foo}yes{else}no{/if}', 'no', 'IsEvenByVar2', $i ++),
+                     array('{$foo=3}{if 4 is even by $foo}yes{else}no{/if}', 'no', 'IsEvenByVar3', $i ++),
+                     array('{if 2 is odd by 3}yes{else}no{/if}', 'no', 'IsOddByVal1', $i ++),
+                     array('{if 3 is odd by 2}yes{else}no{/if}', 'yes', 'IsOddByVal2', $i ++),
+                     array('{if 4 is odd by 3}yes{else}no{/if}', 'yes', 'IsOddByVal3', $i ++),
+                     array('{$foo=3}{if 2 is odd by $foo}yes{else}no{/if}', 'no', 'IsOddByVar1', $i ++),
+                     array('{$foo=2}{if 3 is odd by $foo}yes{else}no{/if}', 'yes', 'IsOddByVar2', $i ++),
+                     array('{$foo=3}{if 4 is odd by $foo}yes{else}no{/if}', 'yes', 'IsOddByVar3', $i ++),
                      array('{$foo=3}{$bar=6}{if $bar is not odd by $foo}yes{else}no{/if}', 'yes', 'IsNotOddByVar', $i ++),
                      array('{$foo=3}{$bar=3}{if 3+$bar is not odd by $foo}yes{else}no{/if}', 'yes', 'ExprIsNotOddByVar', $i ++),
                      array('{$foo=2}{$bar=6}{if (3+$bar) is not odd by ($foo+1)}yes{else}no{/if}', 'no', 'ExprIsNotOddByExpr', $i ++),

utilities/testrunners/php83/Dockerfile

@@ -0,0 +1,10 @@
+FROM php:8.3-cli
+
+## Basic utilities
+RUN apt-get update -yqq && apt-get install -y curl apt-utils git zip unzip
+
+## Composer
+COPY ./utilities/testrunners/shared/install-composer.sh /root/install-composer.sh
+WORKDIR /root
+RUN sh ./install-composer.sh
+RUN mv ./composer.phar /usr/local/bin/composer

utilities/update-changelog.php

@@ -0,0 +1,42 @@
+<?php
+
+// This takes the *.md files in changelog/ dir and inserts them
+// right below the '## [Unreleased]' marker in CHANGELOG.md
+
+$path_to_main_changelog = 'CHANGELOG.md';
+$marker = '## [Unreleased]';
+$changelog_files_pattern = 'changelog/*.md';
+$new_version = $argv[1];
+
+$file_contents = file_get_contents($path_to_main_changelog);
+
+foreach (glob($changelog_files_pattern) as $filename) {
+    $content_to_insert = file_get_contents($filename);
+
+    if (!endsWithNewline($content_to_insert)) {
+        $content_to_insert .= "\n";
+    }
+
+    $file_contents = str_replace(
+        $marker,
+        $marker . $content_to_insert,
+        $file_contents
+    );
+    unlink($filename);
+}
+
+
+// add the version number and date
+$file_contents = str_replace(
+    $marker,
+    $marker . sprintf("\n\n## [%s] - %s\n", $new_version, date('Y-m-d')),
+    $file_contents
+);
+
+file_put_contents($path_to_main_changelog, $file_contents);
+
+
+function endsWithNewline($str): bool
+{
+    return preg_match('/[\r\n]$/', $str) === 1;
+}

utilities/update-smarty-version-number.php

@@ -0,0 +1,11 @@
+<?php
+
+// This takes the Smarty class file and updates the SMARTY_VERSION constant
+
+$path_to_smarty_class = 'src/Smarty.php';
+$pattern = "/const SMARTY_VERSION = '[^']+'/";
+$replacement = "const SMARTY_VERSION = '" . $argv[1] . "'";
+
+$file_contents = preg_replace($pattern, $replacement, file_get_contents($path_to_smarty_class));
+
+file_put_contents($path_to_smarty_class, $file_contents);