Fixed failing {debug} tag.

Fixes #922

CHANGELOG.md

@@ -6,6 +6,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+- The {debug} tag was broken in v5 [#922](https://github.com/smarty-php/smarty/issues/922)
+
+## [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
+- Removed `$smarty->registered_filters` array
+
+## [5.0.0-rc1] - 2023-08-08
+
 ### Added
 - Added support for PHP8.2
 - Added a new way to extend Smarty functionality using `Smarty::addExtension()` or `Smarty::setExtensions()`. Please see the docs for more information.
@@ -26,7 +42,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
@@ -58,6 +74,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`

CONTRIBUTING.md

@@ -0,0 +1,119 @@
+# Contributing to Smarty
+
+First off, thanks for taking the time to contribute! ❤️
+
+> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+> - Star the project
+> - Tell a friend about it
+> - Refer this project in your project's readme
+> - Mention the project at local meetups and tell your friends/colleagues
+
+## I Have a Question
+
+> If you want to ask a question, we assume that you have read the available [Documentation](https://smarty-php.github.io/smarty).
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/smarty-php/smarty/issues) that might help you. 
+In case you have found a suitable issue and still need clarification, you can write your question in this issue. 
+It is also advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- [Open an Issue](https://github.com/smarty-php/smarty/issues/new).
+- Provide as much context as you can about what you're running into.
+- Provide Smarty and PHP versions
+
+We will then take care of the issue as soon as possible.
+
+## I Want To Contribute
+
+> ### Legal Notice
+> When contributing to this project, you must agree that you have authored 100% of the content, 
+> that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+### Reporting Bugs
+
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to 
+investigate carefully, collect information and describe the issue in detail in your report. Please complete the 
+following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side. (Make sure that you have read the [documentation](https://smarty-php.github.io/smarty). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/smarty-php/smarty/issues?q=label%3Abug).
+- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
+- Collect information about the bug:
+  - For an Exception: please provide the Stack trace
+  - OS (Windows, Linux, macOS)
+  - PHP version
+  - Smarty version
+  - A minimal snippet of (your) code that triggers the bug
+  - Expected output versus actual output
+  - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. 
+> For sensitive bugs, please see [SECURITY.md](SECURITY.md).
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/smarty-php/smarty/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
+- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be implemented by someone.
+
+
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for CONTRIBUTING.md, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation](https://smarty-php.github.io/smarty) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://github.com/smarty-php/smarty/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
+
+
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/smarty-php/smarty/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
+- **Explain why this enhancement would be useful** to most CONTRIBUTING.md users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+
+### Improving The Documentation
+
+The [docs](docs/index.md) are written in markdown, configured in [mkdocs.yml](mkdocs.yml) and published 
+to [GitHub pages](https://smarty-php.github.io/smarty) using [mkdocs](https://www.mkdocs.org/) and [mike](https://github.com/jimporter/mike).
+
+To preview the docs while you are writing, run:
+```bash
+mkdocs serve
+```
+This should launch a local web server and give you a link to open in your browser.
+
+When you are finished, commit your changes and provide a [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
+
+#### Publishing the docs
+If you are a maintainer, you can publish the document using [mike](https://github.com/jimporter/mike). Make sure you provide the correct version.
+
+```bash
+mike deploy 5.x
+```
+
+## Attribution
+This guide is based on the **contributing.md**. [Make your own](https://contributing.md/)!

Makefile

@@ -3,12 +3,6 @@ all: lexers parsers
 lexers: src/Lexer/ConfigfileLexer.php src/Lexer/TemplateLexer.php
 parsers: src/Parser/ConfigfileParser.php src/Parser/TemplateParser.php
 
-docs:
-	mike deploy 5.0
-
-test-docs:
-	mkdocs serve
-
 src/Lexer/ConfigfileLexer.php: src/Lexer/ConfigfileLexer.plex
 	php ./utilities/make-lexer.php src/Lexer/ConfigfileLexer.plex src/Lexer/ConfigfileLexer.php
 

SECURITY.md

@@ -2,13 +2,13 @@
 
 ## Supported Versions
 
-Smarty currently supports the latest minor version of Smarty 3 and Smarty 4.
+Smarty currently supports the latest minor version of Smarty 4 and Smarty 5.
 
 | Version | Supported          |
 |---------|--------------------|
+| 5.0.x   | :white_check_mark: |
 | 4.3.x   | :white_check_mark: |
-| 3.1.x   | :white_check_mark: |
-| < 3.1   | :x:                |
+| < 4.3   | :x:                |
 
 ## Reporting a Vulnerability
 

docker-compose.yml

@@ -5,7 +5,7 @@ services:
       context: .
       dockerfile: ./utilities/testrunners/php72/Dockerfile
     volumes:
-      - .:/app
+      - smarty-code:/app
     working_dir: /app
   php72:
     extends:
@@ -37,3 +37,35 @@ services:
       service: base
     build:
       dockerfile: ./utilities/testrunners/php82/Dockerfile
+
+volumes:
+  smarty-code:
+
+x-mutagen:
+  sync:
+    defaults:
+      symlink:
+        mode: "posix-raw"
+      ignore:
+        vcs: true
+        paths:
+          - ".docker"
+          - ".env.docker"
+          - ".bundles"
+          - "docker-compose.yml"
+          - ".idea"
+          - ".DS_Store"
+      mode: "two-way-resolved"
+      configurationBeta:
+        permissions:
+          defaultOwner: "id:${APP_USER_ID}"
+          defaultGroup: "id:${APP_GROUP_ID}"
+          defaultFileMode: 0666
+          defaultDirectoryMode: 0755
+      permissions:
+        defaultOwner: "id:${APP_USER_ID}"
+        defaultGroup: "id:${APP_GROUP_ID}"
+    smarty-code:
+      alpha: "."
+      beta: "volume://smarty-code"
+

docs/api/variables/assigning.md

@@ -22,7 +22,7 @@ footer.tpl:
 <small>Copyright {$companyName|escape}</small>
 ```
 
-Smarty will apply the [escape modifier](../designers/language-modifiers/language-modifier-escape.md)
+Smarty will apply the [escape modifier](../../designers/language-modifiers/language-modifier-escape.md)
 to the value assigned to the variable
 `companyName` and replace `{$companyName|escape}` with the result.
 

docs/api/variables/config-files.md

@@ -27,7 +27,7 @@ Intro = """This is a value that spans more
 
 ```
 
-Values of [config file variables](./language-variables/language-config-variables.md) can be in
+Values of [config file variables](../../designers/language-variables/language-config-variables.md) can be in
 quotes, but not necessary. You can use either single or double quotes.
 If you have a value that spans more than one line, enclose the entire
 value with triple quotes \("""\). You can put comments into config
@@ -81,9 +81,8 @@ $smarty->setConfigOverwrite(false);
 When config overwrite is disabled, Smarty will create arrays of config file variables when it encounters
 multiple entries with the same name.
 
-See also [`{config_load}`](./language-builtin-functions/language-function-config-load.md),
-[`$config_overwrite`](../programmers/api-variables/variable-config-overwrite.md),
-[`$default_config_handler_func`](../programmers/api-variables/variable-default-config-handler-func.md),
-[`getConfigVars()`](../programmers/api-functions/api-get-config-vars.md),
-[`clearConfig()`](../programmers/api-functions/api-clear-config.md) and
-[`configLoad()`](../programmers/api-functions/api-config-load.md)
+See also [`{config_load}`](../../designers/language-builtin-functions/language-function-config-load.md),
+[`$default_config_handler_func`](../../programmers/api-variables/variable-default-config-handler-func.md),
+[`getConfigVars()`](../../programmers/api-functions/api-get-config-vars.md),
+[`clearConfig()`](../../programmers/api-functions/api-clear-config.md) and
+[`configLoad()`](../../programmers/api-functions/api-config-load.md)

docs/api/variables/objects.md

@@ -55,7 +55,7 @@ You can restrict the methods and properties that can be accessed by
 listing them in an array as the third registration parameter.
 
 By default, parameters passed to objects through the templates are
-passed the same way [custom functions](../../designers/language-custom-functions/index.md) get
+passed the same way [custom tags](../../designers/language-custom-functions/index.md) get
 them. An associative array is passed as the first parameter, and the
 smarty object as the second. If you want the parameters passed one at a
 time for each argument like traditional object parameter passing, set

docs/designers/language-basic-syntax/index.md

@@ -14,7 +14,7 @@ A simple Smarty template could look like this:
 
 All Smarty template tags are enclosed within delimiters. By default
 these are `{` and `}`, but they can be
-[changed](../../programmers/api-variables/variable-left-delimiter.md).
+[changed](../../designers/language-basic-syntax/language-escaping.md).
 
 For the examples in this manual, we will assume that you are using the
 default delimiters. In Smarty, all content outside of delimiters is
@@ -22,12 +22,12 @@ displayed as static content, or unchanged. When Smarty encounters
 template tags, it attempts to interpret them, and displays the
 appropriate output in their place.
 
-The basis components of the Smarty syntax are:
+The basic components of the Smarty syntax are:
 
 - [Comments](language-syntax-comments.md)
 - [Variables](language-syntax-variables.md)
 - [Operators](language-syntax-operators.md)
-- [Functions](language-syntax-functions.md)
+- [Tags](language-syntax-tags.md)
 - [Attributes](language-syntax-attributes.md)
 - [Quotes](language-syntax-quotes.md)
 - [Escaping](language-escaping.md)

docs/designers/language-basic-syntax/language-escaping.md

@@ -45,8 +45,7 @@ variables.
 Smarty's default delimiters { and } cleanly represent presentational
 content. However, if another set of delimiters suit your needs better,
 you can change them with Smarty's
-[`$left_delimiter`](../../programmers/api-variables/variable-left-delimiter.md) and
-[`$right_delimiter`](../../programmers/api-variables/variable-right-delimiter.md) values.
+`setLeftDelimiter()` and `setRightDelimiter()` methods.
 
 > **Note**
 >
@@ -57,8 +56,8 @@ you can change them with Smarty's
 ```php
 <?php
 
-$smarty->left_delimiter = '<!--{';
-$smarty->right_delimiter = '}-->';
+$smarty->setLeftDelimiter('<!--{');
+$smarty->setRightDelimiter('}-->');
 
 $smarty->assign('foo', 'bar');
 $smarty->assign('name', 'Albert');

docs/designers/language-basic-syntax/language-syntax-attributes.md

@@ -1,6 +1,6 @@
 # Attributes
 
-Most of the [functions](./language-syntax-functions.md) take attributes that
+Most of the [tags](./language-syntax-tags.md) take attributes that
 specify or modify their behavior. Attributes to Smarty functions are
 much like HTML attributes. Static values don't have to be enclosed in
 quotes, but it is required for literal strings. Variables with or

docs/designers/language-basic-syntax/language-syntax-comments.md

@@ -1,7 +1,7 @@
 # Comments
 
 Template comments are surrounded by asterisks, and that is surrounded by
-the [delimiter](../../programmers/api-variables/variable-left-delimiter.md) tags like so:
+the [delimiter](../../designers/language-basic-syntax/language-escaping.md) tags like so:
 
 ## Examples
 

docs/designers/language-basic-syntax/language-syntax-tags.md

@@ -1,4 +1,4 @@
-# Functions
+# Tags
 
 Every Smarty tag either prints a [variable](./language-syntax-variables.md) or
 invokes some sort of function. These are processed and displayed by
@@ -31,8 +31,8 @@ within delimiters like so: `{funcname attr1="val1" attr2="val2"}`.
     [`{strip}`](../language-builtin-functions/language-function-strip.md). There should be no need to
     change or modify them.
 
--   Custom functions are **additional** functions implemented via
-    [plugins](../../programmers/plugins.md). They can be modified to your liking, or you can
+-   Custom tags are **additional** tags implemented via
+    [plugins](../../api/extending/introduction.md). They can be modified to your liking, or you can
     create new ones. [`{html_options}`](../language-custom-functions/language-function-html-options.md)
     is an example of a custom function.
 

docs/designers/language-builtin-functions/index.md

@@ -4,7 +4,7 @@ Smarty comes with several built-in functions. These built-in functions
 are the integral part of the smarty template engine. They are compiled
 into corresponding inline PHP code for maximum performance.
 
-You cannot create your own [custom functions](../language-custom-functions/index.md) with the same name; and you
+You cannot create your own [custom tags](../language-custom-functions/index.md) with the same name; and you
 should not need to modify the built-in functions.
 
 A few of these functions have an `assign` attribute which collects the

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

@@ -2,7 +2,7 @@
 
 `{block}` is used to define a named area of template source for template
 inheritance. For details see section of [Template
-Inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md).
+Inheritance](../../api/inheritance.md).
 
 The `{block}` template source area of a child template will replace the
 corresponding areas in the parent template(s).
@@ -195,7 +195,7 @@ The result would look like
 ```
 
 See also [Template
-Inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md),
+Inheritance](../../api/inheritance.md),
 [`$smarty.block.parent`](../language-variables/language-variables-smarty.md#smartyblockparent-languagevariablessmartyblockparent),
 [`$smarty.block.child`](../language-variables/language-variables-smarty.md#smartyblockchild-languagevariablessmartyblockchild), and
 [`{extends}`](./language-function-extends.md)

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

@@ -2,7 +2,7 @@
 
 `{extends}` tags are used in child templates in template inheritance for
 extending parent templates. For details see section of [Template
-Inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md).
+Inheritance](../../api/inheritance.md).
 
 -   The `{extends}` tag must be on the first line of the template.
 
@@ -10,7 +10,7 @@ Inheritance](../../programmers/advanced-features/advanced-features-template-inhe
     tag it may contain only `{block}` tags. Any other template content
     is ignored.
 
--   Use the syntax for [template resources](../../programmers/resources.md) to extend files
+-   Use the syntax for [template resources](../../api/resources.md) to extend files
     outside the [`$template_dir`](../../programmers/api-variables/variable-template-dir.md) directory.
 
 ## Attributes
@@ -33,5 +33,5 @@ Inheritance](../../programmers/advanced-features/advanced-features-template-inhe
 {extends 'parent.tpl'}  {* short-hand *}
 ```
 
-See also [Template Inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md)
+See also [Template Inheritance](../../api/inheritance.md)
 and [`{block}`](./language-function-block.md).

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

@@ -41,7 +41,7 @@ available within the included template.
     is useful to return values from the included template to the
     including template.
 
--   Use the syntax for [template resources](../../programmers/resources.md) to `{include}`
+-   Use the syntax for [template resources](../../api/resources.md) to `{include}`
     files outside of the [`$template_dir`](../../programmers/api-variables/variable-template-dir.md)
     directory.
 
@@ -85,11 +85,11 @@ The template above includes the example `links.tpl` below
 
 ```smarty
 <div id="box">
-    <h3>{$title}{/h3>
+    <h3>{$title}</h3>
     <ul>
         {foreach from=$links item=l}
             .. do stuff  ...
-        </foreach}
+        {/foreach}
     </ul>
 </div>
 ```
@@ -183,5 +183,5 @@ current template.
 {include file="$style_dir/$module.$view.tpl"}
 ```
       
-See also [template resources](../../programmers/resources.md) and
+See also [template resources](../../api/resources.md) and
 [componentized templates](../../appendixes/tips.md#componentized-templates).

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

@@ -4,7 +4,7 @@
 template delimiters, by default **{** and **}**. You can also use
 [`{literal}{/literal}`](./language-function-literal.md) to escape blocks of
 text eg Javascript or CSS. See also the complementary
-[`{$smarty.ldelim}`](../../programmers/api-variables/variable-left-delimiter.md).
+[`{$smarty.ldelim}`](../../designers/language-basic-syntax/language-escaping.md).
 
 ```smarty
 {* this will print literal delimiters out of the template *}

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

@@ -3,7 +3,7 @@
 `{literal}` tags allow a block of data to be taken literally. This is
 typically used around Javascript or stylesheet blocks where {curly
 braces} would interfere with the template
-[delimiter](../../programmers/api-variables/variable-left-delimiter.md) syntax. Anything within
+[delimiter](../../designers/language-basic-syntax/language-escaping.md) syntax. Anything within
 `{literal}{/literal}` tags is not interpreted, but displayed as-is. If
 you need template tags embedded in a `{literal}` block, consider using
 [`{ldelim}{rdelim}`](./language-function-ldelim.md) to escape the individual

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

@@ -326,10 +326,10 @@ The template to output the database result in a HTML table
 
 ```smarty
 <table>
-    <tr><th>&nbsp;</th><th>Name></th><th>Home</th><th>Cell</th><th>Email</th></tr>
+    <tr><th>&nbsp;</th><th>Name</th><th>Home</th><th>Cell</th><th>Email</th></tr>
     {section name=co loop=$contacts}
       <tr>
-        <td><a href="view.php?id={$contacts[co].id}">view<a></td>
+        <td><a href="view.php?id={$contacts[co].id}">view</a></td>
         <td>{$contacts[co].name}</td>
         <td>{$contacts[co].home}</td>
         <td>{$contacts[co].cell}</td>
@@ -465,7 +465,7 @@ header block every five rows.
 <table>
     {section name=co loop=$contacts}
       {if $smarty.section.co.iteration is div by 5}
-        <tr><th>&nbsp;</th><th>Name></th><th>Home</th><th>Cell</th><th>Email</th></tr>
+        <tr><th>&nbsp;</th><th>Name</th><th>Home</th><th>Cell</th><th>Email</th></tr>
       {/if}
       <tr>
         <td><a href="view.php?id={$contacts[co].id}">view<a></td>

docs/designers/language-custom-functions/index.md

@@ -1,4 +1,4 @@
-# Custom Functions
+# Custom Tags
 
 Smarty comes with several custom plugin functions that you can use in
 the templates.

docs/designers/language-custom-functions/language-function-eval.md

@@ -22,7 +22,7 @@ output to the template.
 >     templates.
 >
 > -   Evaluated variables are compiled on every invocation, the compiled
->     versions are not saved! However, if you have [caching](../../programmers/caching.md)
+>     versions are not saved! However, if you have [caching](../../api/caching/basics.md)
 >     enabled, the output will be cached with the rest of the template.
 >
 > -   If the content to evaluate doesn't change often, or is used

docs/designers/language-custom-functions/language-function-fetch.md

@@ -28,7 +28,7 @@ ftp and display the contents.
     > If security is enabled, and you are fetching a file from the local
     > file system, `{fetch}` will only allow files from within the
     > `$secure_dir` path of the security policy. See the
-    > [Security](../../programmers/advanced-features/advanced-features-security.md) section for details.
+    > [Security](../../api/security.md) section for details.
 
 -   If the `assign` attribute is set, the output of the `{fetch}`
     function will be assigned to this template variable instead of being

docs/designers/language-custom-functions/language-function-html-image.md

@@ -20,7 +20,7 @@ automatically calculated from the image file if they are not supplied.
     from. If not given, the web server's document root
     `$_ENV['DOCUMENT_ROOT']` is used as the base. If security is
     enabled, then the image must be located in the `$secure_dir` path of
-    the security policy. See the [Security](../../programmers/advanced-features/advanced-features-security.md)
+    the security policy. See the [Security](../../api/security.md)
     section for details.
 
 -   `href` is the href value to link the image to. If link is supplied,
@@ -37,7 +37,7 @@ automatically calculated from the image file if they are not supplied.
 >
 > `{html_image}` requires a hit to the disk to read the image and
 > calculate the height and width. If you don't use template
-> [caching](../../programmers/caching.md), it is generally better to avoid `{html_image}`
+> [caching](../../api/caching/basics.md), it is generally better to avoid `{html_image}`
 > and leave image tags static for optimal performance.
 
 ## Examples

docs/designers/language-custom-functions/language-function-textformat.md

@@ -1,6 +1,6 @@
 # {textformat}
 
-`{textformat}` is a [block function](../../programmers/plugins/plugins-block-functions.md) used to
+`{textformat}` is a block tag used to
 format text. It basically cleans up spaces and special characters, and
 formats paragraphs by wrapping at a boundary and indenting lines.
 

docs/designers/language-modifiers/index.md

@@ -1,7 +1,7 @@
 # Variable Modifiers
 
 Variable modifiers can be applied to
-[variables](../language-variables/index.md), [custom functions](../language-custom-functions/index.md)
+[variables](../language-variables/index.md), [custom tags](../language-custom-functions/index.md)
 or strings. To apply a modifier,
 specify the value followed by a `|` (pipe) and the modifier name. A
 modifier may accept additional parameters that affect its behavior.
@@ -102,4 +102,4 @@ These parameters follow the modifier name and are separated by a `:`
 
 See also [`registerPlugin()`](../../programmers/api-functions/api-register-plugin.md), [combining
 modifiers](../language-combining-modifiers.md). and [extending smarty with
-plugins](../../programmers/plugins.md)
+plugins](../../api/extending/introduction.md)

docs/designers/language-variables/index.md

@@ -8,11 +8,11 @@ variable depends on what symbol it is prefixed or enclosed within.
 - [{$smarty} reserved variable](language-variables-smarty.md)
 
 Variables in Smarty can be either displayed directly or used as
-arguments for [functions](../language-basic-syntax/language-syntax-functions.md),
+arguments for [tags](../language-basic-syntax/language-syntax-tags.md),
 [attributes](../language-basic-syntax/language-syntax-attributes.md) and
 [modifiers](../language-modifiers/index.md), inside conditional expressions, etc.
 To print a variable, simply enclose it in the
-[delimiters](../../programmers/api-variables/variable-left-delimiter.md) so that it is the only thing
+[delimiters](../../designers/language-basic-syntax/language-escaping.md) so that it is the only thing
 contained between them.
 
 ```smarty

docs/designers/language-variables/language-assigned-variables.md

@@ -110,7 +110,7 @@ zaphod@slartibartfast.example.com<br />
 
 ## Objects
 
-Properties of [objects](../../programmers/advanced-features/advanced-features-objects.md) assigned from PHP
+Properties of [objects](../../api/variables/objects.md) assigned from PHP
 can be referenced by specifying the property name after the `->` symbol.
 
 ```smarty

docs/designers/language-variables/language-variables-smarty.md

@@ -138,12 +138,12 @@ Returns the version of Smarty the template was compiled with.
 ## {$smarty.block.child}
 
 Returns block text from child template. See [Template
-inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md).
+inheritance](../../api/inheritance.md).
 
 ## {$smarty.block.parent}
 
 Returns block text from parent template. See [Template
-inheritance](../../programmers/advanced-features/advanced-features-template-inheritance.md)
+inheritance](../../api/inheritance.md)
 
 ## {$smarty.ldelim}, {$smarty.rdelim}
 

docs/features.md

@@ -1,36 +1,35 @@
-Features
-=======
+# Features
 
 Some of Smarty's features:
+
 -   It is extremely fast.
 -   It is efficient since the PHP parser does the dirty work.
 -   No template parsing overhead, only compiles once.
--   It is smart about [recompiling](#variable.compile.check) only the
+-   It is smart about recompiling only the
     template files that have changed.
 -   You can easily create your own custom
-    [functions](#language.custom.functions) and [variable
-    modifiers](#language.modifiers), so the template language is
+    [tags](api/extending/tags.md) and [modifiers](api/extending/modifiers.md), so the template language is
     extremely extensible.
--   Configurable template [{delimiter}](#variable.left.delimiter) tag
+-   Configurable template [{delimiter}](designers/language-basic-syntax/language-escaping.md) tag
     syntax, so you can use `{$foo}`, `{{$foo}}`, `<!--{$foo}-->`, etc.
--   The [`{if}..{elseif}..{else}..{/if}`](#language.function.if)
+-   The [`{if}..{elseif}..{else}..{/if}`](designers/language-builtin-functions/language-function-if.md)
     constructs are passed to the PHP parser, so the `{if...}` expression
     syntax can be as simple or as complex an evaluation as you like.
 -   Allows unlimited nesting of
-    [`sections`](#language.function.section), `if's` etc.
--   Built-in [caching](#caching) support
--   Arbitrary [template](#resources) sources
--   [Template Inheritance](#advanced.features.template.inheritance) for
+    [`sections`](designers/language-builtin-functions/language-function-section.md), `if's` etc.
+-   Built-in [caching](api/caching/basics.md) support
+-   Arbitrary [template](api/resources.md) sources
+-   [Template Inheritance](api/inheritance.md) for
     easy management of template content.
--   [Plugin](#plugins) architecture
+-   [Plugin](api/extending/introduction.md) architecture
 
 ## Separation of presentation from application code
 -   This means templates can certainly contain logic under the condition
     that it is for presentation only. Things such as
-    [including](./designers/language-builtin-functions/language-function-include.md) other templates,
-    [alternating](./designers/language-custom-functions/language-function-cycle.md) table row colors,
-    [upper-casing](./designers/language-modifiers/language-modifier-upper.md) a variable,
-    [looping](./designers/language-builtin-functions/language-function-foreach.md) over an array of data and
+    [including](designers/language-builtin-functions/language-function-include.md) other templates,
+    [alternating](designers/language-custom-functions/language-function-cycle.md) table row colors,
+    [upper-casing](designers/language-modifiers/language-modifier-upper.md) a variable,
+    [looping](designers/language-builtin-functions/language-function-foreach.md) over an array of data and
     rendering it are examples of presentation logic.
 -   This does not mean however that Smarty forces a separation of
     business and presentation logic. Smarty has no knowledge of which is
@@ -61,7 +60,7 @@ inheritance, instead of including other templates we maintain our
 templates as single pages. We can then manipulate blocks of content
 within by inheriting them. This makes templates intuitive, efficient and
 easy to manage. See
-[Template Inheritance](./programmers/advanced-features/advanced-features-template-inheritance.md)
+[Template Inheritance](api/inheritance.md)
 for more info.
 
 ## Why not use XML/XSLT syntax?
@@ -135,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

@@ -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:
@@ -79,6 +79,8 @@ $smarty->setCacheDir('/some/cache/dir');
 $smarty->testInstall();
 ```
 
+## Basic usage
+
 Now, let's create the `index.tpl` file that Smarty will display. This
 needs to be located in the [`$template_dir`](./programmers/api-variables/variable-template-dir.md).
 
@@ -165,7 +167,7 @@ class My_GuestBook extends Smarty {
 Now, we can use `My_GuestBook` instead of `Smarty` in our scripts:
 ```php
 <?php
-$smarty = new Smarty_GuestBook();
+$smarty = new My_GuestBook();
 $smarty->assign('name', 'Ned');
 $smarty->display('index.tpl');
 ```

docs/index.md

@@ -26,5 +26,6 @@ and 480 for $height, the result is:
 - [Features](./features.md) - or "Why do I want Smarty?"
 
 ## Help
+- [Upgrading from an older version](upgrading.md)
 - [Some random tips & tricks](./appendixes/tips.md)
 - [Troubleshooting](./appendixes/troubleshooting.md)

docs/philosophy.md

@@ -13,13 +13,13 @@ newspaper article.
 
 -   The article `$headline`, `$tagline`, `$author` and `$body` are
     content elements, they contain no information about how they will be
-    presented. They are [passed](#api.assign) into Smarty by the
+    presented. They are [passed](getting-started.md#basic-usage) into Smarty by the
     application.
 
 -   Then the template designer edits the templates and uses a
-    combination of HTML tags and [template tags](#language.basic.syntax)
+    combination of HTML tags and [template tags](designers/language-basic-syntax/language-syntax-tags.md)
     to format the presentation of these
-    [variables](#language.syntax.variables) with elements such as
+    [variables](designers/language-basic-syntax/language-syntax-variables.md) with elements such as
     tables, div\'s, background colors, font sizes, style sheets, svg
     etc.
 

docs/programmers/api-variables/variable-left-delimiter.md

@@ -1,8 +0,0 @@
-\$left\_delimiter {#variable.left.delimiter}
-=================
-
-This is the left delimiter used by the template language. Default is
-`{`.
-
-See also [`$right_delimiter`](#variable.right.delimiter) and [escaping
-smarty parsing](#language.escaping) .

docs/programmers/api-variables/variable-right-delimiter.md

@@ -1,8 +0,0 @@
-\$right\_delimiter {#variable.right.delimiter}
-==================
-
-This is the right delimiter used by the template language. Default is
-`}`.
-
-See also [`$left_delimiter`](#variable.left.delimiter) and [escaping
-smarty parsing](#language.escaping).

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

@@ -1,17 +1,18 @@
 #!/bin/bash
 
-if [[ "$1" =~ ^4\.[0-9\.-rc]+$ ]]; then
+if [[ "$1" =~ ^5\.[0-9\.]+(-rc[0-9]+)?$ ]]; then
    printf 'Creating release %s\n' "$1"
 else
-   echo "Invalid version number: $1. This script can only make v4.x.x releases."
+   echo "Invalid version number: $1. This script can only make v5.x.x releases."
    exit 1;
 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';/" libs/Smarty.class.php
 
-git add CHANGELOG.md libs/Smarty.class.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"
 
 git checkout master

mkdocs.yml

@@ -26,14 +26,16 @@ 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'
         - Comments: 'designers/language-basic-syntax/language-syntax-comments.md'
         - Variables: 'designers/language-basic-syntax/language-syntax-variables.md'
         - Operators: 'designers/language-basic-syntax/language-syntax-operators.md'
-        - Functions: 'designers/language-basic-syntax/language-syntax-functions.md'
+        - Tags: 'designers/language-basic-syntax/language-syntax-tags.md'
         - Attributes: 'designers/language-basic-syntax/language-syntax-attributes.md'
         - Quotes: 'designers/language-basic-syntax/language-syntax-quotes.md'
         - 'Escaping Smarty parsing': 'designers/language-basic-syntax/language-escaping.md'
@@ -70,7 +72,7 @@ nav:
         - 'upper': 'designers/language-modifiers/language-modifier-upper.md'
         - 'wordwrap': 'designers/language-modifiers/language-modifier-wordwrap.md'
     - 'Combining Modifiers': 'designers/language-combining-modifiers.md'
-    - 'Builtin Functions':
+    - 'Builtin Tags':
         - 'Introduction': 'designers/language-builtin-functions/index.md'
         - '{append}': 'designers/language-builtin-functions/language-function-append.md'
         - '{assign}': 'designers/language-builtin-functions/language-function-assign.md'
@@ -93,7 +95,7 @@ nav:
         - '{setfilter}': 'designers/language-builtin-functions/language-function-setfilter.md'
         - '{strip}': 'designers/language-builtin-functions/language-function-strip.md'
         - '{while}': 'designers/language-builtin-functions/language-function-while.md'
-    - 'Custom Functions':
+    - 'Custom Tags':
         - 'Introduction': 'designers/language-custom-functions/index.md'
         - '{counter}': 'designers/language-custom-functions/language-function-counter.md'
         - '{cycle}': 'designers/language-custom-functions/language-function-cycle.md'

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

@@ -5,9 +5,11 @@
 # - ./run-tests-for-all-php-versions.sh --group 20221124
 # - ./run-tests-for-all-php-versions.sh --exclude-group slow
 
-docker-compose run php72 ./run-tests.sh $@ && \
-docker-compose run php73 ./run-tests.sh $@ && \
-docker-compose run php74 ./run-tests.sh $@ && \
-docker-compose run php80 ./run-tests.sh $@ && \
-docker-compose run php81 ./run-tests.sh $@ && \
-docker-compose run php82 ./run-tests.sh $@
+COMPOSE_CMD="mutagen-compose"
+
+$COMPOSE_CMD run --rm php72 ./run-tests.sh $@ && \
+$COMPOSE_CMD run --rm php74 ./run-tests.sh $@ && \
+$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 $@

src/Compiler/Template.php

@@ -464,7 +464,7 @@ class Template extends BaseCompiler {
 	public function compileTag($tag, $args, $parameter = []) {
 		$this->prefixCodeStack[] = $this->prefix_code;
 		$this->prefix_code = [];
-		$result = $this->compileTag2(strtolower($tag), $args, $parameter);
+		$result = $this->compileTag2($tag, $args, $parameter);
 		$this->prefix_code = array_merge($this->prefix_code, array_pop($this->prefixCodeStack));
 		return $result;
 	}
@@ -591,6 +591,7 @@ class Template extends BaseCompiler {
 	 * @return ?\Smarty\Compile\CompilerInterface tag compiler object or null if not found or untrusted by security policy
 	 */
 	public function getTagCompiler($tag): ?\Smarty\Compile\CompilerInterface {
+        $tag = strtolower($tag);
 
 		if (isset($this->smarty->security_policy) && !$this->smarty->security_policy->isTrustedTag($tag, $this)) {
 			return null;
@@ -1114,7 +1115,7 @@ class Template extends BaseCompiler {
 			}
 		}
 
-		// call to function previousely defined by {function} tag
+		// call to function previously defined by {function} tag
 		if ($this->canCompileTemplateFunctionCall($tag)) {
 
 			if (!empty($parameter['modifierlist'])) {
@@ -1140,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,19 +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->registered_filters = 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;
@@ -224,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]);
@@ -299,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);
 
@@ -320,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;
     }
@@ -330,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' ];
@@ -361,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/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/FunctionHandler/Math.php

@@ -66,7 +66,7 @@ class Math extends Base {
 		$equation = preg_replace('/\s+/', '', $equation);
 
 		// Adapted from https://www.php.net/manual/en/function.eval.php#107377
-		$number = '(?:\d+(?:[,.]\d+)?|pi|π)'; // What is a number
+		$number = '-?(?:\d+(?:[,.]\d+)?|pi|π)'; // What is a number
 		$functionsOrVars = '((?:0x[a-fA-F0-9]+)|([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*))';
 		$operators = '[,+\/*\^%-]'; // Allowed math operators
 		$regexp = '/^((' . $number . '|' . $functionsOrVars . '|(' . $functionsOrVars . '\s*\((?1)*\)|\((?1)*\)))(?:' . $operators . '(?1))?)+$/';

src/Security.php

@@ -261,6 +261,8 @@ class Security {
 	 * @return boolean                 true if tag is trusted
 	 */
 	public function isTrustedTag($tag_name, $compiler) {
+		$tag_name = strtolower($tag_name);
+
 		// check for internal always required tags
 		if (in_array($tag_name,	['assign', 'call'])) {
 			return true;

src/Smarty.php

@@ -53,7 +53,7 @@ class Smarty extends \Smarty\TemplateBase {
 	/**
 	 * smarty version
 	 */
-	const SMARTY_VERSION = '5.0.0';
+	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;
 
@@ -384,13 +385,6 @@ class Smarty extends \Smarty\TemplateBase {
 	 */
 	public $registered_classes = [];
 
-	/**
-	 * registered filters
-	 *
-	 * @var array
-	 */
-	public $registered_filters = [];
-
 	/**
 	 * registered resources
 	 *

src/Template.php

@@ -196,7 +196,7 @@ class Template extends TemplateBase {
 				);
 			} else {
 				if ((!$this->caching || $this->getCached()->getNocacheCode() || $this->getSource()->handler->recompiled)
-					&& !$no_output_filter && isset($this->smarty->registered_filters['output'])
+					&& !$no_output_filter
 				) {
 					echo $this->smarty->runOutputFilters(ob_get_clean(), $this);
 				} else {

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/SmartyMethodsTests/RegisterFunction/RegisterFunctionTest.php

@@ -39,6 +39,17 @@ class RegisterFunctionTest extends PHPUnit_Smarty
         $this->assertEquals('hello world 1', $this->smarty->fetch('eval:{testfunction value=1}'));
     }
 
+    /**
+     * test registerPlugin method for function case-sensitive
+     */
+    public function testRegisterFunctionCaseInsensitive()
+    {
+        $this->smarty->registerPlugin(Smarty::PLUGIN_FUNCTION, 'testFunction', 'myfunction');
+        $this->assertEquals('myfunction',
+            $this->smarty->getRegisteredPlugin(Smarty::PLUGIN_FUNCTION, 'testFunction')[0]);
+        $this->assertEquals('hello world 1', $this->smarty->fetch('eval:{testFunction value=1}'));
+    }
+
     /**
      * test registerPlugin method for function  class
      */
@@ -143,7 +154,7 @@ class RegisterFunctionTest extends PHPUnit_Smarty
     public function testUnregisterFunctionNotRegistered()
     {
         $this->smarty->unregisterPlugin(Smarty::PLUGIN_FUNCTION, 'testfunction');
-	    $this->assertNull($this->smarty->getRegisteredPlugin(Smarty::PLUGIN_FUNCTION, 'testfunction'));
+        $this->assertNull($this->smarty->getRegisteredPlugin(Smarty::PLUGIN_FUNCTION, 'testfunction'));
     }
 
     /**
@@ -153,8 +164,34 @@ class RegisterFunctionTest extends PHPUnit_Smarty
     {
         $this->smarty->registerPlugin(Smarty::PLUGIN_BLOCK, 'testfunction', 'myfunction');
         $this->smarty->unregisterPlugin(Smarty::PLUGIN_FUNCTION, 'testfunction');
-	    $this->assertIsArray($this->smarty->getRegisteredPlugin(Smarty::PLUGIN_BLOCK, 'testfunction'));
+        $this->assertIsArray($this->smarty->getRegisteredPlugin(Smarty::PLUGIN_BLOCK, 'testfunction'));
     }
+
+
+    /**
+     * Test case (in)sensitivy of plugin functions
+     * @param $registerName
+     * @param $templateString
+     * @return void
+     * @throws \Smarty\Exception
+     * @group issue907
+     * @dataProvider dataProviderForCaseSensitivity
+     */
+    public function testCaseSensitivity($registerName, $templateString) {
+        $this->smarty->registerPlugin(
+            Smarty::PLUGIN_FUNCTION,
+            $registerName,
+            function($params, $smarty) { return 'function-output'; });
+        $this->assertEquals('function-output', $this->smarty->fetch('string:' . $templateString));
+    }
+
+    public function dataProviderForCaseSensitivity() {
+        return [
+            ['customTag', '{customTag}'],
+            ['customtag', '{customtag}'],
+        ];
+    }
+
 }
 
 function myfunction($params, $smarty)

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/ValueTests/Math/MathTest.php

@@ -93,6 +93,14 @@ class MathTest extends PHPUnit_Smarty
         $this->assertEquals($expected, $this->smarty->fetch($tpl));
     }
 
+    public function testNegativeNumbers()
+    {
+        $this->smarty->disableSecurity();
+        $expected = "-19 -- 4.1";
+        $tpl = $this->smarty->createTemplate('eval:{$x = 4}{$y = 5.5}{math equation="-2.0*(x+y)" x=$x y=$y} -- {math equation="-20.5 / -5"}');
+        $this->assertEquals($expected, $this->smarty->fetch($tpl));
+    }
+
     public function testSyntaxFormat()
     {
         $this->smarty->disableSecurity();

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);