summaryrefslogtreecommitdiff
path: root/lib/smarty/sysplugins/smarty_internal_template.php
diff options
context:
space:
mode:
authoremkael <emkael@tlen.pl>2018-10-18 02:39:34 +0200
committeremkael <emkael@tlen.pl>2018-10-18 02:39:42 +0200
commitab5d8d4e07bb3c8230d0285ef8902ef1979fce51 (patch)
tree0b955e585cb2fdbc7207392a5f2c97d610b6a5bc /lib/smarty/sysplugins/smarty_internal_template.php
parentc055ce2ab60c6582bad3e5babcb1d00384fde78a (diff)
Updating Smarty
Diffstat (limited to 'lib/smarty/sysplugins/smarty_internal_template.php')
-rw-r--r--lib/smarty/sysplugins/smarty_internal_template.php990
1 files changed, 523 insertions, 467 deletions
diff --git a/lib/smarty/sysplugins/smarty_internal_template.php b/lib/smarty/sysplugins/smarty_internal_template.php
index 94b27b9..bae22a7 100644
--- a/lib/smarty/sysplugins/smarty_internal_template.php
+++ b/lib/smarty/sysplugins/smarty_internal_template.php
@@ -1,676 +1,735 @@
<?php
/**
* Smarty Internal Plugin Template
- *
* This file contains the Smarty template engine
*
- * @package Smarty
+ * @package Smarty
* @subpackage Template
- * @author Uwe Tews
+ * @author Uwe Tews
*/
/**
* Main class with template data structures and methods
*
- * @package Smarty
+ * @package Smarty
* @subpackage Template
*
- * @property Smarty_Template_Source $source
- * @property Smarty_Template_Compiled $compiled
- * @property Smarty_Template_Cached $cached
+ * @property Smarty_Template_Compiled $compiled
+ * @property Smarty_Template_Cached $cached
+ * @property Smarty_Internal_TemplateCompilerBase $compiler
+ * @property mixed|\Smarty_Template_Cached registered_plugins
+ *
+ * The following methods will be dynamically loaded by the extension handler when they are called.
+ * They are located in a corresponding Smarty_Internal_Method_xxxx class
+ *
+ * @method bool mustCompile()
*/
-class Smarty_Internal_Template extends Smarty_Internal_TemplateBase {
+class Smarty_Internal_Template extends Smarty_Internal_TemplateBase
+{
+ /**
+ * Template object cache
+ *
+ * @var Smarty_Internal_Template[]
+ */
+ public static $tplObjCache = array();
/**
- * cache_id
- * @var string
+ * Template object cache for Smarty::isCached() === true
+ *
+ * @var Smarty_Internal_Template[]
*/
- public $cache_id = null;
+ public static $isCacheTplObj = array();
+
/**
- * $compile_id
- * @var string
+ * Sub template Info Cache
+ * - index name
+ * - value use count
+ *
+ * @var int[]
+ */
+ public static $subTplInfo = array();
+
+ /**
+ * This object type (Smarty = 1, template = 2, data = 4)
+ *
+ * @var int
+ */
+ public $_objType = 2;
+
+ /**
+ * Global smarty instance
+ *
+ * @var Smarty
*/
- public $compile_id = null;
+ public $smarty = null;
+
/**
- * caching enabled
- * @var boolean
+ * Source instance
+ *
+ * @var Smarty_Template_Source|Smarty_Template_Config
*/
- public $caching = null;
+ public $source = null;
+
/**
- * cache lifetime in seconds
- * @var integer
+ * Inheritance runtime extension
+ *
+ * @var Smarty_Internal_Runtime_Inheritance
*/
- public $cache_lifetime = null;
+ public $inheritance = null;
+
/**
* Template resource
+ *
* @var string
*/
public $template_resource = null;
+
/**
* flag if compiled template is invalid and must be (re)compiled
+ *
* @var bool
*/
public $mustCompile = null;
+
/**
- * flag if template does contain nocache code sections
- * @var bool
- */
- public $has_nocache_code = false;
- /**
- * special compiled and cached template properties
- * @var array
- */
- public $properties = array('file_dependency' => array(),
- 'nocache_hash' => '',
- 'function' => array());
- /**
- * required plugins
- * @var array
- */
- public $required_plugins = array('compiled' => array(), 'nocache' => array());
- /**
- * Global smarty instance
- * @var Smarty
- */
- public $smarty = null;
- /**
- * blocks for template inheritance
- * @var array
+ * Template Id
+ *
+ * @var null|string
*/
- public $block_data = array();
+ public $templateId = null;
+
/**
- * variable filters
- * @var array
+ * Scope in which variables shall be assigned
+ *
+ * @var int
*/
- public $variable_filters = array();
+ public $scope = 0;
+
/**
- * optional log of tag/attributes
- * @var array
+ * Flag which is set while rending a cache file
+ *
+ * @var bool
*/
- public $used_tags = array();
+ public $isRenderingCache = false;
+
/**
- * internal flag to allow relative path in child template blocks
- * @var bool
+ * Callbacks called before rendering template
+ *
+ * @var callback[]
*/
- public $allow_relative_path = false;
+ public $startRenderCallbacks = array();
+
/**
- * internal capture runtime stack
- * @var array
+ * Callbacks called after rendering template
+ *
+ * @var callback[]
*/
- public $_capture_stack = array(0 => array());
+ public $endRenderCallbacks = array();
/**
* Create template data object
- *
* Some of the global Smarty settings copied to template scope
- * It load the required template resources and cacher plugins
+ * It load the required template resources and caching plugins
+ *
+ * @param string $template_resource template resource string
+ * @param Smarty $smarty Smarty instance
+ * @param null|\Smarty_Internal_Template|\Smarty|\Smarty_Internal_Data $_parent back pointer to parent
+ * object with variables or
+ * null
+ * @param mixed $_cache_id cache id or null
+ * @param mixed $_compile_id compile id or null
+ * @param bool|int|null $_caching use caching?
+ * @param int|null $_cache_lifetime cache life-time in
+ * seconds
+ * @param bool $_isConfig
*
- * @param string $template_resource template resource string
- * @param Smarty $smarty Smarty instance
- * @param Smarty_Internal_Template $_parent back pointer to parent object with variables or null
- * @param mixed $_cache_id cache id or null
- * @param mixed $_compile_id compile id or null
- * @param bool $_caching use caching?
- * @param int $_cache_lifetime cache life-time in seconds
+ * @throws \SmartyException
*/
- public function __construct($template_resource, $smarty, $_parent = null, $_cache_id = null, $_compile_id = null, $_caching = null, $_cache_lifetime = null)
- {
- $this->smarty = &$smarty;
+ public function __construct(
+ $template_resource,
+ Smarty $smarty,
+ Smarty_Internal_Data $_parent = null,
+ $_cache_id = null,
+ $_compile_id = null,
+ $_caching = null,
+ $_cache_lifetime = null,
+ $_isConfig = false
+ ) {
+ $this->smarty = $smarty;
// Smarty parameter
$this->cache_id = $_cache_id === null ? $this->smarty->cache_id : $_cache_id;
$this->compile_id = $_compile_id === null ? $this->smarty->compile_id : $_compile_id;
- $this->caching = $_caching === null ? $this->smarty->caching : $_caching;
- if ($this->caching === true)
- $this->caching = Smarty::CACHING_LIFETIME_CURRENT;
+ $this->caching = (int)($_caching === null ? $this->smarty->caching : $_caching);
$this->cache_lifetime = $_cache_lifetime === null ? $this->smarty->cache_lifetime : $_cache_lifetime;
+ $this->compile_check = (int)$smarty->compile_check;
$this->parent = $_parent;
// Template resource
$this->template_resource = $template_resource;
- // copy block data of template inheritance
- if ($this->parent instanceof Smarty_Internal_Template) {
- $this->block_data = $this->parent->block_data;
+ $this->source = $_isConfig ? Smarty_Template_Config::load($this) : Smarty_Template_Source::load($this);
+ parent::__construct();
+ if ($smarty->security_policy && method_exists($smarty->security_policy, 'registerCallBacks')) {
+ $smarty->security_policy->registerCallBacks($this);
}
}
/**
- * Returns if the current template must be compiled by the Smarty compiler
+ * render template
*
- * It does compare the timestamps of template source and the compiled templates and checks the force compile configuration
+ * @param bool $no_output_filter if true do not run output filter
+ * @param null|bool $display true: display, false: fetch null: sub-template
*
- * @return boolean true if the template must be compiled
+ * @return string
+ * @throws \Exception
+ * @throws \SmartyException
*/
- public function mustCompile()
+ public function render($no_output_filter = true, $display = null)
{
+ if ($this->smarty->debugging) {
+ if (!isset($this->smarty->_debug)) {
+ $this->smarty->_debug = new Smarty_Internal_Debug();
+ }
+ $this->smarty->_debug->start_template($this, $display);
+ }
+ // checks if template exists
if (!$this->source->exists) {
- if ($this->parent instanceof Smarty_Internal_Template) {
- $parent_resource = " in '$this->parent->template_resource}'";
+ throw new SmartyException(
+ "Unable to load template '{$this->source->type}:{$this->source->name}'" .
+ ($this->_isSubTpl() ? " in '{$this->parent->template_resource}'" : '')
+ );
+ }
+ // disable caching for evaluated code
+ if ($this->source->handler->recompiled) {
+ $this->caching = Smarty::CACHING_OFF;
+ }
+ // read from cache or render
+ if ($this->caching === Smarty::CACHING_LIFETIME_CURRENT || $this->caching === Smarty::CACHING_LIFETIME_SAVED) {
+ if (!isset($this->cached) || $this->cached->cache_id !== $this->cache_id
+ || $this->cached->compile_id !== $this->compile_id
+ ) {
+ $this->loadCached(true);
+ }
+ $this->cached->render($this, $no_output_filter);
+ } else {
+ if (!isset($this->compiled) || $this->compiled->compile_id !== $this->compile_id) {
+ $this->loadCompiled(true);
+ }
+ $this->compiled->render($this);
+ }
+ // display or fetch
+ if ($display) {
+ if ($this->caching && $this->smarty->cache_modified_check) {
+ $this->smarty->ext->_cacheModify->cacheModifiedCheck(
+ $this->cached,
+ $this,
+ isset($content) ? $content : ob_get_clean()
+ );
} else {
- $parent_resource = '';
+ if ((!$this->caching || $this->cached->has_nocache_code || $this->source->handler->recompiled)
+ && !$no_output_filter && (isset($this->smarty->autoload_filters[ 'output' ])
+ || isset($this->smarty->registered_filters[ 'output' ]))
+ ) {
+ echo $this->smarty->ext->_filterHandler->runFilter('output', ob_get_clean(), $this);
+ } else {
+ echo ob_get_clean();
+ }
}
- throw new SmartyException("Unable to load template {$this->source->type} '{$this->source->name}'{$parent_resource}");
- }
- if ($this->mustCompile === null) {
- $this->mustCompile = (!$this->source->uncompiled && ($this->smarty->force_compile || $this->source->recompiled || $this->compiled->timestamp === false ||
- ($this->smarty->compile_check && $this->compiled->timestamp < $this->source->timestamp)));
+ if ($this->smarty->debugging) {
+ $this->smarty->_debug->end_template($this);
+ // debug output
+ $this->smarty->_debug->display_debug($this, true);
+ }
+ return '';
+ } else {
+ if ($this->smarty->debugging) {
+ $this->smarty->_debug->end_template($this);
+ if ($this->smarty->debugging === 2 && $display === false) {
+ $this->smarty->_debug->display_debug($this, true);
+ }
+ }
+ if (!$no_output_filter
+ && (!$this->caching || $this->cached->has_nocache_code || $this->source->handler->recompiled)
+ && (isset($this->smarty->autoload_filters[ 'output' ])
+ || isset($this->smarty->registered_filters[ 'output' ]))
+ ) {
+ return $this->smarty->ext->_filterHandler->runFilter('output', ob_get_clean(), $this);
+ }
+ // return cache content
+ return null;
}
- return $this->mustCompile;
}
/**
- * Compiles the template
+ * Runtime function to render sub-template
*
- * If the template is not evaluated the compiled template is saved on disk
+ * @param string $template template name
+ * @param mixed $cache_id cache id
+ * @param mixed $compile_id compile id
+ * @param integer $caching cache mode
+ * @param integer $cache_lifetime life time of cache data
+ * @param array $data passed parameter template variables
+ * @param int $scope scope in which {include} should execute
+ * @param bool $forceTplCache cache template object
+ * @param string $uid file dependency uid
+ * @param string $content_func function name
+ *
+ * @throws \Exception
+ * @throws \SmartyException
*/
- public function compileTemplateSource()
- {
- if (!$this->source->recompiled) {
- $this->properties['file_dependency'] = array();
- if ($this->source->components) {
- // uses real resource for file dependency
- $source = end($this->source->components);
- $this->properties['file_dependency'][$this->source->uid] = array($this->source->filepath, $this->source->timestamp, $source->type);
+ public function _subTemplateRender(
+ $template,
+ $cache_id,
+ $compile_id,
+ $caching,
+ $cache_lifetime,
+ $data,
+ $scope,
+ $forceTplCache,
+ $uid = null,
+ $content_func = null
+ ) {
+ $tpl = clone $this;
+ $tpl->parent = $this;
+ $smarty = &$this->smarty;
+ $_templateId = $smarty->_getTemplateId($template, $cache_id, $compile_id, $caching, $tpl);
+ // recursive call ?
+ if (isset($tpl->templateId) ? $tpl->templateId : $tpl->_getTemplateId() !== $_templateId) {
+ // already in template cache?
+ if (isset(self::$tplObjCache[ $_templateId ])) {
+ // copy data from cached object
+ $cachedTpl = &self::$tplObjCache[ $_templateId ];
+ $tpl->templateId = $cachedTpl->templateId;
+ $tpl->template_resource = $cachedTpl->template_resource;
+ $tpl->cache_id = $cachedTpl->cache_id;
+ $tpl->compile_id = $cachedTpl->compile_id;
+ $tpl->source = $cachedTpl->source;
+ if (isset($cachedTpl->compiled)) {
+ $tpl->compiled = $cachedTpl->compiled;
+ } else {
+ unset($tpl->compiled);
+ }
+ if ($caching !== 9999 && isset($cachedTpl->cached)) {
+ $tpl->cached = $cachedTpl->cached;
+ } else {
+ unset($tpl->cached);
+ }
} else {
- $this->properties['file_dependency'][$this->source->uid] = array($this->source->filepath, $this->source->timestamp, $this->source->type);
+ $tpl->templateId = $_templateId;
+ $tpl->template_resource = $template;
+ $tpl->cache_id = $cache_id;
+ $tpl->compile_id = $compile_id;
+ if (isset($uid)) {
+ // for inline templates we can get all resource information from file dependency
+ list($filepath, $timestamp, $type) = $tpl->compiled->file_dependency[ $uid ];
+ $tpl->source = new Smarty_Template_Source($smarty, $filepath, $type, $filepath);
+ $tpl->source->filepath = $filepath;
+ $tpl->source->timestamp = $timestamp;
+ $tpl->source->exists = true;
+ $tpl->source->uid = $uid;
+ } else {
+ $tpl->source = Smarty_Template_Source::load($tpl);
+ unset($tpl->compiled);
+ }
+ if ($caching !== 9999) {
+ unset($tpl->cached);
+ }
}
- }
- if ($this->smarty->debugging) {
- Smarty_Internal_Debug::start_compile($this);
- }
- // compile locking
- if ($this->smarty->compile_locking && !$this->source->recompiled) {
- if ($saved_timestamp = $this->compiled->timestamp) {
- touch($this->compiled->filepath);
+ } else {
+ // on recursive calls force caching
+ $forceTplCache = true;
+ }
+ $tpl->caching = $caching;
+ $tpl->cache_lifetime = $cache_lifetime;
+ // set template scope
+ $tpl->scope = $scope;
+ if (!isset(self::$tplObjCache[ $tpl->templateId ]) && !$tpl->source->handler->recompiled) {
+ // check if template object should be cached
+ if ($forceTplCache || (isset(self::$subTplInfo[ $tpl->template_resource ])
+ && self::$subTplInfo[ $tpl->template_resource ] > 1)
+ || ($tpl->_isSubTpl() && isset(self::$tplObjCache[ $tpl->parent->templateId ]))
+ ) {
+ self::$tplObjCache[ $tpl->templateId ] = $tpl;
}
}
- // call compiler
- try {
- $code = $this->compiler->compileTemplate($this);
- } catch (Exception $e) {
- // restore old timestamp in case of error
- if ($this->smarty->compile_locking && !$this->source->recompiled && $saved_timestamp) {
- touch($this->compiled->filepath, $saved_timestamp);
+ if (!empty($data)) {
+ // set up variable values
+ foreach ($data as $_key => $_val) {
+ $tpl->tpl_vars[ $_key ] = new Smarty_Variable($_val, $this->isRenderingCache);
}
- throw $e;
}
- // compiling succeded
- if (!$this->source->recompiled && $this->compiler->write_compiled_code) {
- // write compiled template
- $_filepath = $this->compiled->filepath;
- if ($_filepath === false)
- throw new SmartyException('getCompiledFilepath() did not return a destination to save the compiled template to');
- Smarty_Internal_Write_File::writeFile($_filepath, $code, $this->smarty);
- $this->compiled->exists = true;
- $this->compiled->isCompiled = true;
+ if ($tpl->caching === 9999) {
+ if (!isset($tpl->compiled)) {
+ $this->loadCompiled(true);
+ }
+ if ($tpl->compiled->has_nocache_code) {
+ $this->cached->hashes[ $tpl->compiled->nocache_hash ] = true;
+ }
}
- if ($this->smarty->debugging) {
- Smarty_Internal_Debug::end_compile($this);
+ $tpl->_cache = array();
+ if (isset($uid)) {
+ if ($smarty->debugging) {
+ if (!isset($smarty->_debug)) {
+ $smarty->_debug = new Smarty_Internal_Debug();
+ }
+ $smarty->_debug->start_template($tpl);
+ $smarty->_debug->start_render($tpl);
+ }
+ $tpl->compiled->getRenderedTemplateCode($tpl, $content_func);
+ if ($smarty->debugging) {
+ $smarty->_debug->end_template($tpl);
+ $smarty->_debug->end_render($tpl);
+ }
+ } else {
+ if (isset($tpl->compiled)) {
+ $tpl->compiled->render($tpl);
+ } else {
+ $tpl->render();
+ }
}
- // release compiler object to free memory
- unset($this->compiler);
}
/**
- * Writes the cached template output
- *
- * @return bool
+ * Get called sub-templates and save call count
*/
- public function writeCachedContent($content)
+ public function _subTemplateRegister()
{
- if ($this->source->recompiled || !($this->caching == Smarty::CACHING_LIFETIME_CURRENT || $this->caching == Smarty::CACHING_LIFETIME_SAVED)) {
- // don't write cache file
- return false;
+ foreach ($this->compiled->includes as $name => $count) {
+ if (isset(self::$subTplInfo[ $name ])) {
+ self::$subTplInfo[ $name ] += $count;
+ } else {
+ self::$subTplInfo[ $name ] = $count;
+ }
}
- $this->properties['cache_lifetime'] = $this->cache_lifetime;
- $this->properties['unifunc'] = 'content_' . uniqid('', false);
- $content = $this->createTemplateCodeFrame($content, true);
- $_smarty_tpl = $this;
- eval("?>" . $content);
- $this->cached->valid = true;
- $this->cached->processed = true;
- return $this->cached->write($this, $content);
}
/**
- * Template code runtime function to get subtemplate content
+ * Check if this is a sub template
*
- * @param string $template the resource handle of the template file
- * @param mixed $cache_id cache id to be used with this template
- * @param mixed $compile_id compile id to be used with this template
- * @param integer $caching cache mode
- * @param integer $cache_lifetime life time of cache data
- * @param array $vars optional variables to assign
- * @param int $parent_scope scope in which {include} should execute
- * @returns string template content
+ * @return bool true is sub template
*/
- public function getSubTemplate($template, $cache_id, $compile_id, $caching, $cache_lifetime, $data, $parent_scope)
+ public function _isSubTpl()
{
- // already in template cache?
- if ($this->smarty->allow_ambiguous_resources) {
- $_templateId = Smarty_Resource::getUniqueTemplateName($this->smarty, $template) . $cache_id . $compile_id;
- } else {
- $_templateId = $this->smarty->joined_template_dir . '#' . $template . $cache_id . $compile_id;
- }
-
- if (isset($_templateId[150])) {
- $_templateId = sha1($_templateId);
- }
- if (isset($this->smarty->template_objects[$_templateId])) {
- // clone cached template object because of possible recursive call
- $tpl = clone $this->smarty->template_objects[$_templateId];
- $tpl->parent = $this;
- $tpl->caching = $caching;
- $tpl->cache_lifetime = $cache_lifetime;
- } else {
- $tpl = new $this->smarty->template_class($template, $this->smarty, $this, $cache_id, $compile_id, $caching, $cache_lifetime);
- }
- // get variables from calling scope
- if ($parent_scope == Smarty::SCOPE_LOCAL) {
- $tpl->tpl_vars = $this->tpl_vars;
- } elseif ($parent_scope == Smarty::SCOPE_PARENT) {
- $tpl->tpl_vars = &$this->tpl_vars;
- } elseif ($parent_scope == Smarty::SCOPE_GLOBAL) {
- $tpl->tpl_vars = &Smarty::$global_tpl_vars;
- } elseif (($scope_ptr = $this->getScopePointer($parent_scope)) == null) {
- $tpl->tpl_vars = &$this->tpl_vars;
- } else {
- $tpl->tpl_vars = &$scope_ptr->tpl_vars;
- }
- $tpl->config_vars = $this->config_vars;
- if (!empty($data)) {
- // set up variable values
- foreach ($data as $_key => $_val) {
- $tpl->tpl_vars[$_key] = new Smarty_variable($_val);
- }
- }
- return $tpl->fetch(null, null, null, null, false, false, true);
+ return isset($this->parent) && $this->parent->_isTplObj();
}
/**
- * Template code runtime function to set up an inline subtemplate
+ * Assign variable in scope
*
- * @param string $template the resource handle of the template file
- * @param mixed $cache_id cache id to be used with this template
- * @param mixed $compile_id compile id to be used with this template
- * @param integer $caching cache mode
- * @param integer $cache_lifetime life time of cache data
- * @param array $vars optional variables to assign
- * @param int $parent_scope scope in which {include} should execute
- * @param string $hash nocache hash code
- * @returns string template content
+ * @param string $varName variable name
+ * @param mixed $value value
+ * @param bool $nocache nocache flag
+ * @param int $scope scope into which variable shall be assigned
*/
- public function setupInlineSubTemplate($template, $cache_id, $compile_id, $caching, $cache_lifetime, $data, $parent_scope, $hash)
+ public function _assignInScope($varName, $value, $nocache = false, $scope = 0)
{
- $tpl = new $this->smarty->template_class($template, $this->smarty, $this, $cache_id, $compile_id, $caching, $cache_lifetime);
- $tpl->properties['nocache_hash'] = $hash;
- // get variables from calling scope
- if ($parent_scope == Smarty::SCOPE_LOCAL ) {
- $tpl->tpl_vars = $this->tpl_vars;
- } elseif ($parent_scope == Smarty::SCOPE_PARENT) {
- $tpl->tpl_vars = &$this->tpl_vars;
- } elseif ($parent_scope == Smarty::SCOPE_GLOBAL) {
- $tpl->tpl_vars = &Smarty::$global_tpl_vars;
- } elseif (($scope_ptr = $this->getScopePointer($parent_scope)) == null) {
- $tpl->tpl_vars = &$this->tpl_vars;
+ if (isset($this->tpl_vars[ $varName ])) {
+ $this->tpl_vars[ $varName ] = clone $this->tpl_vars[ $varName ];
+ $this->tpl_vars[ $varName ]->value = $value;
+ if ($nocache || $this->isRenderingCache) {
+ $this->tpl_vars[ $varName ]->nocache = true;
+ }
} else {
- $tpl->tpl_vars = &$scope_ptr->tpl_vars;
+ $this->tpl_vars[ $varName ] = new Smarty_Variable($value, $nocache || $this->isRenderingCache);
}
- $tpl->config_vars = $this->config_vars;
- if (!empty($data)) {
- // set up variable values
- foreach ($data as $_key => $_val) {
- $tpl->tpl_vars[$_key] = new Smarty_variable($_val);
+ if ($scope >= 0) {
+ if ($scope > 0 || $this->scope > 0) {
+ $this->smarty->ext->_updateScope->_updateScope($this, $varName, $scope);
}
}
- return $tpl;
}
-
/**
- * Create code frame for compiled and cached templates
+ * Check if plugins are callable require file otherwise
*
- * @param string $content optional template content
- * @param bool $cache flag for cache file
- * @return string
+ * @param array $plugins required plugins
+ *
+ * @throws \SmartyException
*/
- public function createTemplateCodeFrame($content = '', $cache = false)
+ public function _checkPlugins($plugins)
{
- $plugins_string = '';
- // include code for plugins
- if (!$cache) {
- if (!empty($this->required_plugins['compiled'])) {
- $plugins_string = '<?php ';
- foreach ($this->required_plugins['compiled'] as $tmp) {
- foreach ($tmp as $data) {
- $file = addslashes($data['file']);
- $plugins_string .= "if (!is_callable('{$data['function']}')) include '{$file}';\n";
- }
- }
- $plugins_string .= '?>';
- }
- if (!empty($this->required_plugins['nocache'])) {
- $this->has_nocache_code = true;
- $plugins_string .= "<?php echo '/*%%SmartyNocache:{$this->properties['nocache_hash']}%%*/<?php \$_smarty = \$_smarty_tpl->smarty; ";
- foreach ($this->required_plugins['nocache'] as $tmp) {
- foreach ($tmp as $data) {
- $file = addslashes($data['file']);
- $plugins_string .= addslashes("if (!is_callable('{$data['function']}')) include '{$file}';\n");
- }
- }
- $plugins_string .= "?>/*/%%SmartyNocache:{$this->properties['nocache_hash']}%%*/';?>\n";
- }
- }
- // build property code
- $this->properties['has_nocache_code'] = $this->has_nocache_code;
- $output = '';
- if (!$this->source->recompiled) {
- $output = "<?php /*%%SmartyHeaderCode:{$this->properties['nocache_hash']}%%*/";
- if ($this->smarty->direct_access_security) {
- $output .= "if(!defined('SMARTY_DIR')) exit('no direct access allowed');\n";
- }
- }
- if ($cache) {
- // remove compiled code of{function} definition
- unset($this->properties['function']);
- if (!empty($this->smarty->template_functions)) {
- // copy code of {function} tags called in nocache mode
- foreach ($this->smarty->template_functions as $name => $function_data) {
- if (isset($function_data['called_nocache'])) {
- foreach ($function_data['called_functions'] as $func_name) {
- $this->smarty->template_functions[$func_name]['called_nocache'] = true;
+ static $checked = array();
+ foreach ($plugins as $plugin) {
+ $name = join('::', (array)$plugin[ 'function' ]);
+ if (!isset($checked[ $name ])) {
+ if (!is_callable($plugin[ 'function' ])) {
+ if (is_file($plugin[ 'file' ])) {
+ include_once $plugin[ 'file' ];
+ if (is_callable($plugin[ 'function' ])) {
+ $checked[ $name ] = true;
}
}
+ } else {
+ $checked[ $name ] = true;
}
- foreach ($this->smarty->template_functions as $name => $function_data) {
- if (isset($function_data['called_nocache'])) {
- unset($function_data['called_nocache'], $function_data['called_functions'], $this->smarty->template_functions[$name]['called_nocache']);
- $this->properties['function'][$name] = $function_data;
- }
+ }
+ if (!isset($checked[ $name ])) {
+ if (false !== $this->smarty->loadPlugin($name)) {
+ $checked[ $name ] = true;
+ } else {
+ throw new SmartyException("Plugin '{$name}' not callable");
}
}
}
- $this->properties['version'] = Smarty::SMARTY_VERSION;
- if (!isset($this->properties['unifunc'])) {
- $this->properties['unifunc'] = 'content_' . uniqid('', false);
- }
- if (!$this->source->recompiled) {
- $output .= "\$_valid = \$_smarty_tpl->decodeProperties(" . var_export($this->properties, true) . ',' . ($cache ? 'true' : 'false') . "); /*/%%SmartyHeaderCode%%*/?>\n";
- }
- if (!$this->source->recompiled) {
- $output .= '<?php if ($_valid && !is_callable(\'' . $this->properties['unifunc'] . '\')) {function ' . $this->properties['unifunc'] . '($_smarty_tpl) {?>';
- }
- $output .= $plugins_string;
- $output .= $content;
- if (!$this->source->recompiled) {
- $output .= '<?php }} ?>';
- }
- return $output;
}
/**
* This function is executed automatically when a compiled or cached template file is included
- *
* - Decode saved properties from compiled template and cache files
* - Check if compiled or cache file is valid
*
- * @param array $properties special template properties
- * @param bool $cache flag if called from cache file
- * @return bool flag if compiled or cache file is valid
+ * @param \Smarty_Internal_Template $tpl
+ * @param array $properties special template properties
+ * @param bool $cache flag if called from cache file
+ *
+ * @return bool flag if compiled or cache file is valid
+ * @throws \SmartyException
*/
- public function decodeProperties($properties, $cache = false)
+ public function _decodeProperties(Smarty_Internal_Template $tpl, $properties, $cache = false)
{
- $this->has_nocache_code = $properties['has_nocache_code'];
- $this->properties['nocache_hash'] = $properties['nocache_hash'];
- if (isset($properties['cache_lifetime'])) {
- $this->properties['cache_lifetime'] = $properties['cache_lifetime'];
- }
- if (isset($properties['file_dependency'])) {
- $this->properties['file_dependency'] = array_merge($this->properties['file_dependency'], $properties['file_dependency']);
- }
- if (!empty($properties['function'])) {
- $this->properties['function'] = array_merge($this->properties['function'], $properties['function']);
- $this->smarty->template_functions = array_merge($this->smarty->template_functions, $properties['function']);
+ // on cache resources other than file check version stored in cache code
+ if (!isset($properties[ 'version' ]) || Smarty::SMARTY_VERSION !== $properties[ 'version' ]) {
+ if ($cache) {
+ $tpl->smarty->clearAllCache();
+ } else {
+ $tpl->smarty->clearCompiledTemplate();
+ }
+ return false;
}
- $this->properties['version'] = (isset($properties['version'])) ? $properties['version'] : '';
- $this->properties['unifunc'] = $properties['unifunc'];
- // check file dependencies at compiled code
$is_valid = true;
- if ($this->properties['version'] != Smarty::SMARTY_VERSION) {
- $is_valid = false;
- } else if (((!$cache && $this->smarty->compile_check && empty($this->compiled->_properties) && !$this->compiled->isCompiled) || $cache && ($this->smarty->compile_check === true || $this->smarty->compile_check === Smarty::COMPILECHECK_ON)) && !empty($this->properties['file_dependency'])) {
- foreach ($this->properties['file_dependency'] as $_file_to_check) {
- if ($_file_to_check[2] == 'file' || $_file_to_check[2] == 'php') {
- if ($this->source->filepath == $_file_to_check[0] && isset($this->source->timestamp)) {
+ if (!empty($properties[ 'file_dependency' ])
+ && ((!$cache && $tpl->compile_check) || $tpl->compile_check === Smarty::COMPILECHECK_ON)
+ ) {
+ // check file dependencies at compiled code
+ foreach ($properties[ 'file_dependency' ] as $_file_to_check) {
+ if ($_file_to_check[ 2 ] === 'file' || $_file_to_check[ 2 ] === 'php') {
+ if ($tpl->source->filepath === $_file_to_check[ 0 ]) {
// do not recheck current template
- $mtime = $this->source->timestamp;
+ continue;
+ //$mtime = $tpl->source->getTimeStamp();
} else {
// file and php types can be checked without loading the respective resource handlers
- $mtime = filemtime($_file_to_check[0]);
+ $mtime = is_file($_file_to_check[ 0 ]) ? filemtime($_file_to_check[ 0 ]) : false;
}
- } elseif ($_file_to_check[2] == 'string') {
- continue;
} else {
- $source = Smarty_Resource::source(null, $this->smarty, $_file_to_check[0]);
- $mtime = $source->timestamp;
+ $handler = Smarty_Resource::load($tpl->smarty, $_file_to_check[ 2 ]);
+ if ($handler->checkTimestamps()) {
+ $source = Smarty_Template_Source::load($tpl, $tpl->smarty, $_file_to_check[ 0 ]);
+ $mtime = $source->getTimeStamp();
+ } else {
+ continue;
+ }
}
- if ($mtime > $_file_to_check[1]) {
+ if ($mtime === false || $mtime > $_file_to_check[ 1 ]) {
$is_valid = false;
break;
}
}
}
if ($cache) {
- $this->cached->valid = $is_valid;
+ // CACHING_LIFETIME_SAVED cache expiry has to be validated here since otherwise we'd define the unifunc
+ if ($tpl->caching === Smarty::CACHING_LIFETIME_SAVED && $properties[ 'cache_lifetime' ] >= 0
+ && (time() > ($tpl->cached->timestamp + $properties[ 'cache_lifetime' ]))
+ ) {
+ $is_valid = false;
+ }
+ $tpl->cached->cache_lifetime = $properties[ 'cache_lifetime' ];
+ $tpl->cached->valid = $is_valid;
+ $resource = $tpl->cached;
} else {
- $this->mustCompile = !$is_valid;
+ $tpl->mustCompile = !$is_valid;
+ $resource = $tpl->compiled;
+ $resource->includes = isset($properties[ 'includes' ]) ? $properties[ 'includes' ] : array();
}
- // store data in reusable Smarty_Template_Compiled
- if (!$cache) {
- $this->compiled->_properties = $properties;
+ if ($is_valid) {
+ $resource->unifunc = $properties[ 'unifunc' ];
+ $resource->has_nocache_code = $properties[ 'has_nocache_code' ];
+ // $tpl->compiled->nocache_hash = $properties['nocache_hash'];
+ $resource->file_dependency = $properties[ 'file_dependency' ];
}
- return $is_valid;
+ return $is_valid && !function_exists($properties[ 'unifunc' ]);
}
/**
- * Template code runtime function to create a local Smarty variable for array assignments
+ * Compiles the template
+ * If the template is not evaluated the compiled template is saved on disk
*
- * @param string $tpl_var tempate variable name
- * @param bool $nocache cache mode of variable
- * @param int $scope scope of variable
+ * @throws \Exception
*/
- public function createLocalArrayVariable($tpl_var, $nocache = false, $scope = Smarty::SCOPE_LOCAL)
+ public function compileTemplateSource()
{
- if (!isset($this->tpl_vars[$tpl_var])) {
- $this->tpl_vars[$tpl_var] = new Smarty_variable(array(), $nocache, $scope);
- } else {
- $this->tpl_vars[$tpl_var] = clone $this->tpl_vars[$tpl_var];
- if ($scope != Smarty::SCOPE_LOCAL) {
- $this->tpl_vars[$tpl_var]->scope = $scope;
- }
- if (!(is_array($this->tpl_vars[$tpl_var]->value) || $this->tpl_vars[$tpl_var]->value instanceof ArrayAccess)) {
- settype($this->tpl_vars[$tpl_var]->value, 'array');
- }
- }
+ return $this->compiled->compileTemplateSource($this);
}
/**
- * Template code runtime function to get pointer to template variable array of requested scope
+ * Writes the content to cache resource
+ *
+ * @param string $content
*
- * @param int $scope requested variable scope
- * @return array array of template variables
+ * @return bool
*/
- public function &getScope($scope)
+ public function writeCachedContent($content)
{
- if ($scope == Smarty::SCOPE_PARENT && !empty($this->parent)) {
- return $this->parent->tpl_vars;
- } elseif ($scope == Smarty::SCOPE_ROOT && !empty($this->parent)) {
- $ptr = $this->parent;
- while (!empty($ptr->parent)) {
- $ptr = $ptr->parent;
- }
- return $ptr->tpl_vars;
- } elseif ($scope == Smarty::SCOPE_GLOBAL) {
- return Smarty::$global_tpl_vars;
- }
- $null = null;
- return $null;
+ return $this->smarty->ext->_updateCache->writeCachedContent($this, $content);
}
/**
- * Get parent or root of template parent chain
+ * Get unique template id
*
- * @param int $scope pqrent or root scope
- * @return mixed object
+ * @return string
+ * @throws \SmartyException
*/
- public function getScopePointer($scope)
+ public function _getTemplateId()
{
- if ($scope == Smarty::SCOPE_PARENT && !empty($this->parent)) {
- return $this->parent;
- } elseif ($scope == Smarty::SCOPE_ROOT && !empty($this->parent)) {
- $ptr = $this->parent;
- while (!empty($ptr->parent)) {
- $ptr = $ptr->parent;
- }
- return $ptr;
- }
- return null;
+ return isset($this->templateId) ? $this->templateId : $this->templateId =
+ $this->smarty->_getTemplateId($this->template_resource, $this->cache_id, $this->compile_id);
+ }
+
+ /**
+ * runtime error not matching capture tags
+ *
+ * @throws \SmartyException
+ */
+ public function capture_error()
+ {
+ throw new SmartyException("Not matching {capture} open/close in '{$this->template_resource}'");
}
/**
- * [util function] counts an array, arrayaccess/traversable or PDOStatement object
+ * Load compiled object
*
- * @param mixed $value
- * @return int the count for arrays and objects that implement countable, 1 for other objects that don't, and 0 for empty elements
+ * @param bool $force force new compiled object
*/
- public function _count($value)
+ public function loadCompiled($force = false)
{
- if (is_array($value) === true || $value instanceof Countable) {
- return count($value);
- } elseif ($value instanceof IteratorAggregate) {
- // Note: getIterator() returns a Traversable, not an Iterator
- // thus rewind() and valid() methods may not be present
- return iterator_count($value->getIterator());
- } elseif ($value instanceof Iterator) {
- return iterator_count($value);
- } elseif ($value instanceof PDOStatement) {
- return $value->rowCount();
- } elseif ($value instanceof Traversable) {
- return iterator_count($value);
- } elseif ($value instanceof ArrayAccess) {
- if ($value->offsetExists(0)) {
- return 1;
- }
- } elseif (is_object($value)) {
- return count($value);
+ if ($force || !isset($this->compiled)) {
+ $this->compiled = Smarty_Template_Compiled::load($this);
}
- return 0;
}
/**
- * runtime error not matching capture tags
+ * Load cached object
*
+ * @param bool $force force new cached object
*/
- public function capture_error()
+ public function loadCached($force = false)
{
- throw new SmartyException("Not matching {capture} open/close in \"{$this->template_resource}\"");
+ if ($force || !isset($this->cached)) {
+ $this->cached = Smarty_Template_Cached::load($this);
+ }
}
/**
- * Empty cache for this template
- *
- * @param integer $exp_time expiration time
- * @return integer number of cache files deleted
- */
- public function clearCache($exp_time=null)
+ * Load inheritance object
+ */
+ public function _loadInheritance()
{
- Smarty_CacheResource::invalidLoadedCache($this->smarty);
- return $this->cached->handler->clear($this->smarty, $this->template_name, $this->cache_id, $this->compile_id, $exp_time);
+ if (!isset($this->inheritance)) {
+ $this->inheritance = new Smarty_Internal_Runtime_Inheritance();
+ }
}
- /**
- * set Smarty property in template context
+ /**
+ * Unload inheritance object
+ */
+ public function _cleanUp()
+ {
+ $this->startRenderCallbacks = array();
+ $this->endRenderCallbacks = array();
+ $this->inheritance = null;
+ }
+
+ /**
+ * Load compiler object
*
- * @param string $property_name property name
- * @param mixed $value value
+ * @throws \SmartyException
*/
- public function __set($property_name, $value)
+ public function loadCompiler()
{
- switch ($property_name) {
- case 'source':
- case 'compiled':
- case 'cached':
- case 'compiler':
- $this->$property_name = $value;
- return;
+ if (!class_exists($this->source->compiler_class)) {
+ $this->smarty->loadPlugin($this->source->compiler_class);
+ }
+ $this->compiler =
+ new $this->source->compiler_class(
+ $this->source->template_lexer_class,
+ $this->source->template_parser_class,
+ $this->smarty
+ );
+ }
- // FIXME: routing of template -> smarty attributes
- default:
- if (property_exists($this->smarty, $property_name)) {
- $this->smarty->$property_name = $value;
- return;
- }
+ /**
+ * Handle unknown class methods
+ *
+ * @param string $name unknown method-name
+ * @param array $args argument array
+ *
+ * @return mixed
+ */
+ public function __call($name, $args)
+ {
+ // method of Smarty object?
+ if (method_exists($this->smarty, $name)) {
+ return call_user_func_array(array($this->smarty, $name), $args);
}
-
- throw new SmartyException("invalid template property '$property_name'.");
+ // parent
+ return parent::__call($name, $args);
}
/**
* get Smarty property in template context
*
* @param string $property_name property name
+ *
+ * @return mixed|Smarty_Template_Cached
+ * @throws SmartyException
*/
public function __get($property_name)
{
switch ($property_name) {
- case 'source':
- if (empty($this->template_resource)) {
- throw new SmartyException("Unable to parse resource name \"{$this->template_resource}\"");
- }
- $this->source = Smarty_Resource::source($this);
- // cache template object under a unique ID
- // do not cache eval resources
- if ($this->source->type != 'eval') {
- if ($this->smarty->allow_ambiguous_resources) {
- $_templateId = $this->source->unique_resource . $this->cache_id . $this->compile_id;
- } else {
- $_templateId = $this->smarty->joined_template_dir . '#' . $this->template_resource . $this->cache_id . $this->compile_id;
- }
-
- if (isset($_templateId[150])) {
- $_templateId = sha1($_templateId);
- }
- $this->smarty->template_objects[$_templateId] = $this;
- }
- return $this->source;
-
case 'compiled':
- $this->compiled = $this->source->getCompiled($this);
+ $this->loadCompiled();
return $this->compiled;
-
case 'cached':
- if (!class_exists('Smarty_Template_Cached')) {
- include SMARTY_SYSPLUGINS_DIR . 'smarty_cacheresource.php';
- }
- $this->cached = new Smarty_Template_Cached($this);
+ $this->loadCached();
return $this->cached;
-
case 'compiler':
- $this->smarty->loadPlugin($this->source->compiler_class);
- $this->compiler = new $this->source->compiler_class($this->source->template_lexer_class, $this->source->template_parser_class, $this->smarty);
+ $this->loadCompiler();
return $this->compiler;
-
- // FIXME: routing of template -> smarty attributes
default:
+ // Smarty property ?
if (property_exists($this->smarty, $property_name)) {
return $this->smarty->$property_name;
}
}
-
throw new SmartyException("template property '$property_name' does not exist.");
}
/**
- * Template data object destrutor
+ * set Smarty property in template context
*
+ * @param string $property_name property name
+ * @param mixed $value value
+ *
+ * @throws SmartyException
+ */
+ public function __set($property_name, $value)
+ {
+ switch ($property_name) {
+ case 'compiled':
+ case 'cached':
+ case 'compiler':
+ $this->$property_name = $value;
+ return;
+ default:
+ // Smarty property ?
+ if (property_exists($this->smarty, $property_name)) {
+ $this->smarty->$property_name = $value;
+ return;
+ }
+ }
+ throw new SmartyException("invalid template property '$property_name'.");
+ }
+
+ /**
+ * Template data object destructor
*/
public function __destruct()
{
@@ -678,7 +737,4 @@ class Smarty_Internal_Template extends Smarty_Internal_TemplateBase {
$this->cached->handler->releaseLock($this->smarty, $this->cached);
}
}
-
}
-
-?> \ No newline at end of file