smarty-php/smarty
1
0
Fork 0
mirror of https://github.com/smarty-php/smarty.git synced 2025-08-02 17:34:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

removed phpplugin, removed now unused uncompiled handler and all checks for this, fixed a refactorbug in InheritanceRuntime. Moved getRenderedTemplateCode method to Smarty\Template. Renamed Cache en Compiled base class to GeneratedPhpFile for more clarity and distinction from Resource classes. Inlined Cached::create into its only caller. Some other minor improvements. Removed php7.1 CI tests.

Browse Source
This commit is contained in:
Simon Wisselink
2023-01-11 23:33:12 +01:00
parent 1fe5050a04
commit 577f910e49
18 changed files with 196 additions and 413 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/ci.yml vendored
View File

@@ -25,7 +25,6 @@ jobs:
- ubuntu-latest
php-version:
- "7.1"
- "7.2"
- "7.3"
- "7.4"

4
src/Compile/Tag/IncludeTag.php
View File

@@ -84,7 +84,7 @@ class IncludeTag extends Base {
$type = !empty($match[3]) ? $match[3] : $compiler->template->smarty->default_resource_type;
$name = !empty($match[5]) ? $match[5] : $match[6];
$handler = \Smarty\Resource\BasePlugin::load($compiler->smarty, $type);
if ($handler->recompiled || $handler->uncompiled) {
if ($handler->recompiled) {
$variable_template = true;
}
if (!$variable_template) {
@@ -285,7 +285,7 @@ class IncludeTag extends Base {
$t_hash
) {
$uid = $tpl->source->type . $tpl->source->uid;
if (!($tpl->source->handler->uncompiled) && $tpl->source->exists) {
if ($tpl->source->exists) {
$compiler->parent_compiler->mergedSubTemplatesData[$uid][$t_hash]['uid'] = $tpl->source->uid;
if (isset($compiler->template->inheritance)) {
$tpl->inheritance = clone $compiler->template->inheritance;

22
src/Compiler/CodeFrame.php
View File

@@ -2,9 +2,12 @@
namespace Smarty\Compiler;
use Smarty\Exception;
/**
* Smarty Internal Extension
* This file contains the Smarty template extension to create a code frame
*
* @author Uwe Tews
*/
@@ -24,15 +27,16 @@ class CodeFrame
}
/**
* Create code frame for compiled and cached templates
*
* @param string $content optional template content
* @param string $functions compiled template function and block code
* @param bool $cache flag for cache file
* @param \Smarty\Compiler\Template $compiler
*
* @return string
*/
* Create code frame for compiled and cached templates
*
* @param string $content optional template content
* @param string $functions compiled template function and block code
* @param bool $cache flag for cache file
* @param Template|null $compiler
*
* @return string
* @throws Exception
*/
public function create(
$content = '',
$functions = '',

8
src/Resource/BasePlugin.php
View File

@@ -36,16 +36,8 @@ abstract class BasePlugin
'extends' => ExtendsPlugin::class,
'stream' => StreamPlugin::class,
'eval' => StringEval::class,
'php' => PhpPlugin::class,
];
/**
* Source is bypassing compiler
*
* @var boolean
*/
public $uncompiled = false;
/**
* Source must be recompiled on every occasion
*

119
src/Resource/PhpPlugin.php
View File

@@ -1,119 +0,0 @@
<?php
namespace Smarty\Resource;
use Smarty\Template;
use Smarty\Template\Source;
use Smarty\Template\Compiled;
use Smarty\Exception;
/**
* Smarty Internal Plugin Resource PHP
* Implements the file system as resource for PHP templates
*
* @author Uwe Tews
* @author Rodney Rehm
*/
class PhpPlugin extends FilePlugin {
/**
* Flag that it's an uncompiled resource
*
* @var bool
*/
public $uncompiled = true;
/**
* Resource does implement populateCompiledFilepath() method
*
* @var bool
*/
public $hasCompiledHandler = true;
/**
* container for short_open_tag directive's value before executing PHP templates
*
* @var string
*/
protected $short_open_tag;
/**
* Create a new PHP Resource
*/
public function __construct() {
$this->short_open_tag = function_exists('ini_get') ? ini_get('short_open_tag') : 1;
}
/**
* Load template's source from file into current template object
*
* @param Source $source source object
*
* @return string template source
* @throws Exception if source cannot be loaded
*/
public function getContent(Source $source) {
if ($source->exists) {
return '';
}
throw new Exception("Unable to read template {$source->type} '{$source->name}'");
}
/**
* populate compiled object with compiled filepath
*
* @param Compiled $compiled compiled object
* @param Template $_template template object (is ignored)
*/
public function populateCompiledFilepath(Compiled $compiled, Template $_template) {
$compiled->filepath = $_template->source->filepath;
$compiled->timestamp = $_template->source->timestamp;
$compiled->exists = $_template->source->exists;
$compiled->file_dependency[$_template->source->uid] =
[
$compiled->filepath,
$compiled->timestamp,
$_template->source->type,
];
}
/**
* Render and output the template (without using the compiler)
*
* @param Source $source source object
* @param Template $_template template object
*
* @return void
* @throws Exception if template cannot be loaded or allow_php_templates is disabled
*/
public function renderUncompiled(Source $source, Template $_template) {
if (!$source->smarty->allow_php_templates) {
throw new Exception('PHP templates are disabled');
}
if (!$source->exists) {
throw new Exception(
"Unable to load template '{$source->type}:{$source->name}'" .
($_template->_isSubTpl() ? " in '{$_template->parent->template_resource}'" : '')
);
}
// prepare variables
extract($_template->getTemplateVars());
// include PHP template with short open tags enabled
if (function_exists('ini_set')) {
ini_set('short_open_tag', '1');
}
/**
*
*
* @var Template $_smarty_template
* used in included file
*/
$_smarty_template = $_template;
include $source->filepath;
if (function_exists('ini_set')) {
ini_set('short_open_tag', $this->short_open_tag);
}
}
}

54
src/Resource/UncompiledPlugin.php
View File

@@ -1,54 +0,0 @@
<?php
/**
* Smarty Resource Plugin
*
* @author Rodney Rehm
*/
namespace Smarty\Resource;
use Smarty\Smarty;
use Smarty\Template;
use Smarty\Template\Compiled;
/**
* Smarty Resource Plugin
* Base implementation for resource plugins that don't use the compiler
*
*/
abstract class UncompiledPlugin extends BasePlugin {
/**
* Flag that it's an uncompiled resource
*
* @var bool
*/
public $uncompiled = true;
/**
* Resource does implement populateCompiledFilepath() method
*
* @var bool
*/
public $hasCompiledHandler = true;
/**
* populate compiled object with compiled filepath
*
* @param Compiled $compiled compiled object
* @param Template $_template template object
*/
public function populateCompiledFilepath(Compiled $compiled, Template $_template) {
$compiled->filepath = $_template->source->filepath;
$compiled->timestamp = $_template->source->timestamp;
$compiled->exists = $_template->source->exists;
if ($_template->smarty->merge_compiled_includes || $_template->source->handler->checkTimestamps()) {
$compiled->file_dependency[$_template->source->uid] =
[$compiled->filepath, $compiled->timestamp, $_template->source->type,];
}
}
}

1
src/Runtime/InheritanceRuntime.php
View File

@@ -120,7 +120,6 @@ class InheritanceRuntime {
$tpl->caching ? 9999 : 0,
$tpl->cache_lifetime,
[],
false,
$uid,
$func
);

2
src/Smarty.php
View File

@@ -1386,7 +1386,7 @@ class Smarty extends \Smarty\TemplateBase
/* @var Template $tpl */
$tpl = $this->createTemplate($resource_name);
$this->caching = $_save_stat;
if (!$tpl->source->handler->uncompiled && !$tpl->source->handler->recompiled && $tpl->source->exists) {
if (!$tpl->source->handler->recompiled && $tpl->source->exists) {
$_resource_part_1 = basename(str_replace('^', DIRECTORY_SEPARATOR, $tpl->compiled->filepath));
$_resource_part_1_length = strlen($_resource_part_1);
} else {

84
src/Template.php
View File

@@ -10,7 +10,6 @@
namespace Smarty;
use Smarty\Smarty;
use Smarty\Runtime\InheritanceRuntime;
use Smarty\Template\Source;
use Smarty\Template\Cached;
@@ -298,7 +297,7 @@ class Template extends TemplateBase {
$smarty->getDebug()->start_template($tpl);
$smarty->getDebug()->start_render($tpl);
}
$tpl->compiled->getRenderedTemplateCode($tpl, $content_func);
$tpl->getRenderedTemplateCode($content_func);
if ($smarty->debugging) {
$smarty->getDebug()->end_template($tpl);
$smarty->getDebug()->end_render($tpl);
@@ -386,16 +385,16 @@ class Template extends TemplateBase {
}
$tpl->cached->cache_lifetime = $properties['cache_lifetime'];
$tpl->cached->valid = $is_valid;
$resource = $tpl->cached;
$generatedFile = $tpl->cached;
} else {
$tpl->mustCompile = !$is_valid;
$resource = $tpl->compiled;
$resource->includes = isset($properties['includes']) ? $properties['includes'] : [];
$generatedFile = $tpl->compiled;
$generatedFile->includes = $properties['includes'] ?? [];
}
if ($is_valid) {
$resource->unifunc = $properties['unifunc'];
$resource->has_nocache_code = $properties['has_nocache_code'];
$resource->file_dependency = $properties['file_dependency'];
$generatedFile->unifunc = $properties['unifunc'];
$generatedFile->has_nocache_code = $properties['has_nocache_code'];
$generatedFile->file_dependency = $properties['file_dependency'];
}
return $is_valid && !function_exists($properties['unifunc']);
}
@@ -465,10 +464,17 @@ class Template extends TemplateBase {
* Load cached object
*
* @param bool $force force new cached object
*
* @throws Exception
*/
public function loadCached($force = false) {
if ($force || !isset($this->cached)) {
$this->cached = Cached::create($this);
$this->cached = new Cached($this);
$this->cached->handler->populate($this->cached, $this);
// caching enabled ?
if (!$this->caching || $this->source->handler->recompiled) {
$this->cached->valid = false;
}
}
}
@@ -484,7 +490,7 @@ class Template extends TemplateBase {
/**
* Unload inheritance object
*/
public function _cleanUp() {
private function _cleanUp() {
$this->startRenderCallbacks = [];
$this->endRenderCallbacks = [];
$this->inheritance = null;
@@ -496,7 +502,9 @@ class Template extends TemplateBase {
* @throws \Smarty\Exception
*/
public function loadCompiler() {
$this->compiler = $this->source->createCompiler();
if (!isset($this->compiler)) {
$this->compiler = $this->source->createCompiler();
}
}
/**
@@ -510,7 +518,7 @@ class Template extends TemplateBase {
* @return string
*/
public function createCodeFrame($content = '', $functions = '', $cache = false, \Smarty\Compiler\Template $compiler = null) {
return $this->getFrameCompiler()->create($content, $functions, $cache, $compiler);
return $this->getCodeFrameCompiler()->create($content, $functions, $cache, $compiler);
}
/**
@@ -537,6 +545,9 @@ class Template extends TemplateBase {
*
* @return mixed|Cached
* @throws Exception
*
* @deprecated
* @TODO remove
*/
public function __get($property_name) {
switch ($property_name) {
@@ -565,6 +576,10 @@ class Template extends TemplateBase {
* @param mixed $value value
*
* @throws Exception
*
*
* @deprecated
* @TODO remove
*/
public function __set($property_name, $value) {
switch ($property_name) {
@@ -612,16 +627,15 @@ class Template extends TemplateBase {
throw new Exception("Unable to load template {$this->source->type} '{$this->source->name}'{$parent_resource}");
}
if ($this->mustCompile === null) {
$this->mustCompile = (!$this->source->handler->uncompiled &&
($this->smarty->force_compile || $this->source->handler->recompiled ||
!$this->compiled->exists || ($this->compile_check &&
$this->compiled->getTimeStamp() <
$this->source->getTimeStamp())));
$this->mustCompile = $this->smarty->force_compile
|| $this->source->handler->recompiled
|| !$this->compiled->exists
|| ($this->compile_check && $this->compiled->getTimeStamp() < $this->source->getTimeStamp());
}
return $this->mustCompile;
}
private function getFrameCompiler(): Compiler\CodeFrame {
private function getCodeFrameCompiler(): Compiler\CodeFrame {
return new \Smarty\Compiler\CodeFrame($this);
}
@@ -800,5 +814,39 @@ class Template extends TemplateBase {
}
}
/**
* get rendered template content by calling compiled or cached template code
*
* @param string $unifunc function with template code
*
* @throws \Exception
*/
public function getRenderedTemplateCode($unifunc) {
$level = ob_get_level();
try {
if (empty($unifunc) || !function_exists($unifunc)) {
throw new \Smarty\Exception("Invalid compiled template for '{$this->template_resource}'");
}
if ($this->startRenderCallbacks) {
foreach ($this->startRenderCallbacks as $callback) {
call_user_func($callback, $this);
}
}
$unifunc($this);
foreach ($this->endRenderCallbacks as $callback) {
call_user_func($callback, $this);
}
$this->isRenderingCache = false;
} catch (\Exception $e) {
$this->isRenderingCache = false;
while (ob_get_level() > $level) {
ob_end_clean();
}
if (isset($this->_getSmartyObj()->security_policy)) {
$this->_getSmartyObj()->security_policy->endTemplate();
}
throw $e;
}
}
}

41
src/Template/Cached.php
View File

@@ -3,18 +3,12 @@
namespace Smarty\Template;
use Smarty\Template;
use Smarty\Template\ResourceBase;
use Smarty\Template\Source;
/**
* Smarty Resource Data Object
* Cache Data Container for Template Files
*
* Represents a cached version of a template or config file.
* @author Rodney Rehm
*/
class Cached extends ResourceBase {
class Cached extends GeneratedPhpFile {
/**
* Cache Is Valid
@@ -73,11 +67,16 @@ class Cached extends ResourceBase {
public $hashes = [];
/**
* Flag if this is a cache resource
* Content buffer
*
* @var bool
* @var string
*/
public $isCache = true;
public $content = null;
private function renderTemplateCode(Template $_template) {
$_template->isRenderingCache = true;
$_template->getRenderedTemplateCode($this->unifunc);
}
/**
* create Cached Object container
@@ -93,22 +92,6 @@ class Cached extends ResourceBase {
$this->handler = $_template->smarty->getCacheResource();
}
/**
* @param Template $_template
*
* @return Cached
*/
public static function create(Template $_template) {
$_template->cached = new self($_template);
$_template->cached->handler->populate($_template->cached, $_template);
// caching enabled ?
if (!$_template->caching || $_template->source->handler->recompiled
) {
$_template->cached->valid = false;
}
return $_template->cached;
}
/**
* Render cache template
*
@@ -125,7 +108,7 @@ class Cached extends ResourceBase {
if (!$this->processed) {
$this->process($_template);
}
$this->getRenderedTemplateCode($_template);
$this->renderTemplateCode($_template);
if ($_template->smarty->debugging) {
$_template->smarty->getDebug()->end_cache($_template);
}
@@ -300,7 +283,7 @@ class Cached extends ResourceBase {
$_template->cached->process($_template, true);
}
$_template->compile_check = $compile_check;
$this->getRenderedTemplateCode($_template);
$this->renderTemplateCode($_template);
if ($_template->smarty->debugging) {
$_template->smarty->getDebug()->end_cache($_template);
}

33
src/Template/Compiled.php
View File

@@ -5,15 +5,10 @@ namespace Smarty\Template;
use Smarty\Template;
/**
* Smarty Resource Data Object
* Meta Data Container for Template Files
*
* Represents a compiled version of a template or config file.
* @author Rodney Rehm
* @property string $content compiled content
*/
class Compiled extends ResourceBase {
class Compiled extends GeneratedPhpFile {
/**
* nocache hash
@@ -22,6 +17,15 @@ class Compiled extends ResourceBase {
*/
public $nocache_hash = null;
/**
* Included sub templates
* - index name
* - value use count
*
* @var int[]
*/
public $includes = [];
/**
* get a Compiled Object of this source
*
@@ -105,11 +109,9 @@ class Compiled extends ResourceBase {
$_template->cached->file_dependency =
array_merge($_template->cached->file_dependency, $this->file_dependency);
}
if ($_template->source->handler->uncompiled) {
$_template->source->handler->renderUncompiled($_template->source, $_template);
} else {
$this->getRenderedTemplateCode($_template);
}
$_template->getRenderedTemplateCode($this->unifunc);
if ($_template->caching && $this->has_nocache_code) {
$_template->cached->hashes[$this->nocache_hash] = true;
}
@@ -130,7 +132,7 @@ class Compiled extends ResourceBase {
$smarty = &$_smarty_tpl->smarty;
if ($source->handler->recompiled) {
$source->handler->process($_smarty_tpl);
} elseif (!$source->handler->uncompiled) {
} else {
if (!$this->exists || $smarty->force_compile
|| ($_smarty_tpl->compile_check && $source->getTimeStamp() > $this->getTimeStamp())
) {
@@ -222,12 +224,12 @@ class Compiled extends ResourceBase {
if (!$_template->source->handler->recompiled) {
return file_get_contents($this->filepath);
}
return isset($this->content) ? $this->content : false;
return false;
}
/**
* Load fresh compiled template by including the PHP file
* HHVM requires a work around because of a PHP incompatibility
* HHVM requires a workaround because of a PHP incompatibility
*
* @param \Smarty\Template $_smarty_tpl do not change variable name, is used by compiled template
*/
@@ -245,4 +247,5 @@ class Compiled extends ResourceBase {
include $this->filepath;
}
}
}

79
src/Template/GeneratedPhpFile.php Normal file
View File

@@ -0,0 +1,79 @@
<?php
namespace Smarty\Template;
/**
* Base class for generated PHP files, such as compiled and cached versions of templates and config files.
* @author Rodney Rehm
*/
abstract class GeneratedPhpFile {
/**
* Compiled Filepath
*
* @var string
*/
public $filepath = null;
/**
* Compiled Timestamp
*
* @var integer|bool
*/
public $timestamp = false;
/**
* Compiled Existence
*
* @var boolean
*/
public $exists = false;
/**
* Template Compile Id (\Smarty\Template::$compile_id)
*
* @var string
*/
public $compile_id = null;
/**
* Compiled Content Loaded
*
* @var boolean
*/
public $processed = false;
/**
* unique function name for compiled template code
*
* @var string
*/
public $unifunc = '';
/**
* flag if template does contain nocache code sections
*
* @var bool
*/
public $has_nocache_code = false;
/**
* resource file dependency
*
* @var array
*/
public $file_dependency = [];
/**
* Get compiled time stamp
*
* @return int
*/
public function getTimeStamp() {
if ($this->exists && !$this->timestamp) {
$this->timestamp = filemtime($this->filepath);
}
return $this->timestamp;
}
}

147
src/Template/ResourceBase.php
View File

@@ -1,147 +0,0 @@
<?php
namespace Smarty\Template;
use Smarty\Template;
/**
* Smarty Template Resource Base Object
*
* @author Rodney Rehm
*/
abstract class ResourceBase {
/**
* Compiled Filepath
*
* @var string
*/
public $filepath = null;
/**
* Compiled Timestamp
*
* @var integer|bool
*/
public $timestamp = false;
/**
* Compiled Existence
*
* @var boolean
*/
public $exists = false;
/**
* Template Compile Id (\Smarty\Template::$compile_id)
*
* @var string
*/
public $compile_id = null;
/**
* Compiled Content Loaded
*
* @var boolean
*/
public $processed = false;
/**
* unique function name for compiled template code
*
* @var string
*/
public $unifunc = '';
/**
* flag if template does contain nocache code sections
*
* @var bool
*/
public $has_nocache_code = false;
/**
* resource file dependency
*
* @var array
*/
public $file_dependency = [];
/**
* Content buffer
*
* @var string
*/
public $content = null;
/**
* Included sub templates
* - index name
* - value use count
*
* @var int[]
*/
public $includes = [];
/**
* Flag if this is a cache resource
*
* @var bool
*/
public $isCache = false;
/**
* get rendered template content by calling compiled or cached template code
*
* @param \Smarty\Template $_template
* @param string $unifunc function with template code
*
* @throws \Exception
*/
public function getRenderedTemplateCode(Template $_template, $unifunc = null) {
$smarty = &$_template->smarty;
$_template->isRenderingCache = $this->isCache;
$level = ob_get_level();
try {
if (!isset($unifunc)) {
$unifunc = $this->unifunc;
}
if (empty($unifunc) || !function_exists($unifunc)) {
throw new \Smarty\Exception("Invalid compiled template for '{$_template->template_resource}'");
}
if ($_template->startRenderCallbacks) {
foreach ($_template->startRenderCallbacks as $callback) {
call_user_func($callback, $_template);
}
}
$unifunc($_template);
foreach ($_template->endRenderCallbacks as $callback) {
call_user_func($callback, $_template);
}
$_template->isRenderingCache = false;
} catch (\Exception $e) {
$_template->isRenderingCache = false;
while (ob_get_level() > $level) {
ob_end_clean();
}
if (isset($smarty->security_policy)) {
$smarty->security_policy->endTemplate();
}
throw $e;
}
}
/**
* Get compiled time stamp
*
* @return int
*/
public function getTimeStamp() {
if ($this->exists && !$this->timestamp) {
$this->timestamp = filemtime($this->filepath);
}
return $this->timestamp;
}
}

6
src/Template/Source.php
View File

@@ -7,11 +7,7 @@ use Smarty\Template;
use Smarty\Exception;
/**
* Smarty Resource Data Object
* Meta Data Container for Template Files
*
* Meta-data Container for Template source files
* @author Rodney Rehm
*/
class Source {

2
tests/UnitTests/ResourceTests/Eval/EvalResourceTest.php
View File

@@ -81,7 +81,7 @@ class EvalResourceTest extends PHPUnit_Smarty
public function testUsesCompiler()
{
$tpl = $this->smarty->createTemplate('eval:hello world');
$this->assertFalse($tpl->source->handler->uncompiled);
$this->markTestIncomplete();
}
/**

2
tests/UnitTests/ResourceTests/File/FileResourceTest.php
View File

@@ -93,7 +93,7 @@ class FileResourceTest extends PHPUnit_Smarty
public function testUsesCompiler()
{
$tpl = $this->smarty->createTemplate('helloworld.tpl');
$this->assertFalse($tpl->source->handler->uncompiled);
$this->markTestIncomplete();
}
public function testIsEvaluated()

2
tests/UnitTests/ResourceTests/Stream/StreamResourceTest.php
View File

@@ -70,7 +70,7 @@ class StreamResourceTest extends PHPUnit_Smarty
public function testUsesCompiler()
{
$tpl = $this->smarty->createTemplate('global:mytest');
$this->assertFalse($tpl->source->handler->uncompiled);
$this->markTestIncomplete();
}
/**

2
tests/UnitTests/ResourceTests/String/StringResourceTest.php
View File

@@ -83,7 +83,7 @@ class StringResourceTest extends PHPUnit_Smarty
public function testUsesCompiler()
{
$tpl = $this->smarty->createTemplate('string:hello world');
$this->assertFalse($tpl->source->handler->uncompiled);
$this->markTestIncomplete();
}
/**