diff options
Diffstat (limited to 'lib/smarty3/sysplugins/smarty_internal_compile_include.php')
| -rw-r--r-- | lib/smarty3/sysplugins/smarty_internal_compile_include.php | 345 |
1 files changed, 345 insertions, 0 deletions
diff --git a/lib/smarty3/sysplugins/smarty_internal_compile_include.php b/lib/smarty3/sysplugins/smarty_internal_compile_include.php new file mode 100644 index 0000000..3c840e6 --- /dev/null +++ b/lib/smarty3/sysplugins/smarty_internal_compile_include.php @@ -0,0 +1,345 @@ +<?php +/** + * Smarty Internal Plugin Compile Include + * Compiles the {include} tag + * + * @package Smarty + * @subpackage Compiler + * @author Uwe Tews + */ + +/** + * Smarty Internal Plugin Compile Include Class + * + * @package Smarty + * @subpackage Compiler + */ +class Smarty_Internal_Compile_Include extends Smarty_Internal_CompileBase +{ + /** + * caching mode to create nocache code but no cache file + */ + const CACHING_NOCACHE_CODE = 9999; + + /** + * Attribute definition: Overwrites base class. + * + * @var array + * @see Smarty_Internal_CompileBase + */ + public $required_attributes = array('file'); + + /** + * Attribute definition: Overwrites base class. + * + * @var array + * @see Smarty_Internal_CompileBase + */ + public $shorttag_order = array('file'); + + /** + * Attribute definition: Overwrites base class. + * + * @var array + * @see Smarty_Internal_CompileBase + */ + public $option_flags = array('nocache', 'inline', 'caching'); + + /** + * Attribute definition: Overwrites base class. + * + * @var array + * @see Smarty_Internal_CompileBase + */ + public $optional_attributes = array('_any'); + + /** + * Valid scope names + * + * @var array + */ + public $valid_scopes = array('parent' => Smarty::SCOPE_PARENT, 'root' => Smarty::SCOPE_ROOT, + 'global' => Smarty::SCOPE_GLOBAL, 'tpl_root' => Smarty::SCOPE_TPL_ROOT, + 'smarty' => Smarty::SCOPE_SMARTY); + + /** + * Compiles code for the {include} tag + * + * @param array $args array with attributes from parser + * @param Smarty_Internal_SmartyTemplateCompiler $compiler compiler object + * @param array $parameter array with compilation parameter + * + * @throws SmartyCompilerException + * @return string compiled code + */ + public function compile($args, Smarty_Internal_SmartyTemplateCompiler $compiler, $parameter) + { + $uid = $t_hash = null; + // check and get attributes + $_attr = $this->getAttributes($compiler, $args); + + $fullResourceName = $source_resource = $_attr[ 'file' ]; + $variable_template = false; + $cache_tpl = false; + // parse resource_name + if (preg_match('/^([\'"])(([A-Za-z0-9_\-]{2,})[:])?(([^$()]+)|(.+))\1$/', $source_resource, $match)) { + $type = !empty($match[ 3 ]) ? $match[ 3 ] : $compiler->template->smarty->default_resource_type; + $name = !empty($match[ 5 ]) ? $match[ 5 ] : $match[ 6 ]; + $handler = Smarty_Resource::load($compiler->smarty, $type); + if ($handler->recompiled || $handler->uncompiled) { + $variable_template = true; + } + if (!$variable_template) { + if ($type != 'string') { + $fullResourceName = "{$type}:{$name}"; + $compiled = $compiler->parent_compiler->template->compiled; + if (isset($compiled->includes[ $fullResourceName ])) { + $compiled->includes[ $fullResourceName ] ++; + $cache_tpl = true; + } else { + if ("{$compiler->template->source->type}:{$compiler->template->source->name}" == + $fullResourceName + ) { + // recursive call of current template + $compiled->includes[ $fullResourceName ] = 2; + $cache_tpl = true; + } else { + $compiled->includes[ $fullResourceName ] = 1; + } + } + $fullResourceName = '"' . $fullResourceName . '"'; + } + } + if (empty($match[ 5 ])) { + $variable_template = true; + } + } else { + $variable_template = true; + } + + // scope setup + $_scope = $compiler->convertScope($_attr, $this->valid_scopes); + + // set flag to cache subtemplate object when called within loop or template name is variable. + if ($cache_tpl || $variable_template || $compiler->loopNesting > 0) { + $_cache_tpl = 'true'; + } else { + $_cache_tpl = 'false'; + } + // assume caching is off + $_caching = Smarty::CACHING_OFF; + + $call_nocache = $compiler->tag_nocache || $compiler->nocache; + + // caching was on and {include} is not in nocache mode + if ($compiler->template->caching && !$compiler->nocache && !$compiler->tag_nocache) { + $_caching = self::CACHING_NOCACHE_CODE; + } + + // flag if included template code should be merged into caller + $merge_compiled_includes = ($compiler->smarty->merge_compiled_includes || $_attr[ 'inline' ] === true) && + !$compiler->template->source->handler->recompiled; + + if ($merge_compiled_includes) { + // variable template name ? + if ($variable_template) { + $merge_compiled_includes = false; + } + // variable compile_id? + if (isset($_attr[ 'compile_id' ]) && $compiler->isVariable($_attr[ 'compile_id' ])) { + $merge_compiled_includes = false; + } + } + + /* + * if the {include} tag provides individual parameter for caching or compile_id + * the subtemplate must not be included into the common cache file and is treated like + * a call in nocache mode. + * + */ + if ($_attr[ 'nocache' ] !== true && $_attr[ 'caching' ]) { + $_caching = $_new_caching = (int) $_attr[ 'caching' ]; + $call_nocache = true; + } else { + $_new_caching = Smarty::CACHING_LIFETIME_CURRENT; + } + if (isset($_attr[ 'cache_lifetime' ])) { + $_cache_lifetime = $_attr[ 'cache_lifetime' ]; + $call_nocache = true; + $_caching = $_new_caching; + } else { + $_cache_lifetime = '$_smarty_tpl->cache_lifetime'; + } + if (isset($_attr[ 'cache_id' ])) { + $_cache_id = $_attr[ 'cache_id' ]; + $call_nocache = true; + $_caching = $_new_caching; + } else { + $_cache_id = '$_smarty_tpl->cache_id'; + } + if (isset($_attr[ 'compile_id' ])) { + $_compile_id = $_attr[ 'compile_id' ]; + } else { + $_compile_id = '$_smarty_tpl->compile_id'; + } + + // if subtemplate will be called in nocache mode do not merge + if ($compiler->template->caching && $call_nocache) { + $merge_compiled_includes = false; + } + // assign attribute + if (isset($_attr[ 'assign' ])) { + // output will be stored in a smarty variable instead of being displayed + if ($_assign = $compiler->getId($_attr[ 'assign' ])) { + $_assign = "'{$_assign}'"; + if ($compiler->tag_nocache || $compiler->nocache || $call_nocache) { + // create nocache var to make it know for further compiling + $compiler->setNocacheInVariable($_attr[ 'assign' ]); + } + } else { + $_assign = $_attr[ 'assign' ]; + } + } + + $has_compiled_template = false; + if ($merge_compiled_includes) { + $c_id = isset($_attr[ 'compile_id' ]) ? $_attr[ 'compile_id' ] : $compiler->template->compile_id; + // we must observe different compile_id and caching + $t_hash = sha1($c_id . ($_caching ? '--caching' : '--nocaching')); + $compiler->smarty->allow_ambiguous_resources = true; + /* @var Smarty_Internal_Template $tpl */ + $tpl = new $compiler->smarty->template_class (trim($fullResourceName, '"\''), $compiler->smarty, + $compiler->template, $compiler->template->cache_id, $c_id, + $_caching); + $uid = $tpl->source->type . $tpl->source->uid; + if (!isset($compiler->parent_compiler->mergedSubTemplatesData[ $uid ][ $t_hash ])) { + $has_compiled_template = $this->compileInlineTemplate($compiler, $tpl, $t_hash); + } else { + $has_compiled_template = true; + } + unset($tpl); + } + // delete {include} standard attributes + unset($_attr[ 'file' ], $_attr[ 'assign' ], $_attr[ 'cache_id' ], $_attr[ 'compile_id' ], $_attr[ 'cache_lifetime' ], $_attr[ 'nocache' ], $_attr[ 'caching' ], $_attr[ 'scope' ], $_attr[ 'inline' ]); + // remaining attributes must be assigned as smarty variable + $_vars = 'array()'; + if (!empty($_attr)) { + $_pairs = array(); + // create variables + foreach ($_attr as $key => $value) { + $_pairs[] = "'$key'=>$value"; + } + $_vars = 'array(' . join(',', $_pairs) . ')'; + } + $update_compile_id = $compiler->template->caching && !$compiler->tag_nocache && !$compiler->nocache && + $_compile_id != '$_smarty_tpl->compile_id'; + if ($has_compiled_template && !$call_nocache) { + $_output = "<?php\n"; + if ($update_compile_id) { + $_output .= $compiler->makeNocacheCode("\$_compile_id_save[] = \$_smarty_tpl->compile_id;\n\$_smarty_tpl->compile_id = {$_compile_id};\n"); + } + if (!empty($_attr) && $_caching == 9999 && $compiler->template->caching) { + $_vars_nc = "foreach ($_vars as \$ik => \$iv) {\n"; + $_vars_nc .= "\$_smarty_tpl->tpl_vars[\$ik] = new Smarty_Variable(\$iv);\n"; + $_vars_nc .= "}\n"; + $_output .= substr($compiler->processNocacheCode('<?php ' . $_vars_nc . "?>\n", true), 6, - 3); + } + if (isset($_assign)) { + $_output .= "ob_start();\n"; + } + $_output .= "\$_smarty_tpl->_subTemplateRender({$fullResourceName}, {$_cache_id}, {$_compile_id}, {$_caching}, {$_cache_lifetime}, {$_vars}, {$_scope}, {$_cache_tpl}, '{$compiler->parent_compiler->mergedSubTemplatesData[$uid][$t_hash]['uid']}', '{$compiler->parent_compiler->mergedSubTemplatesData[$uid][$t_hash]['func']}');\n"; + if (isset($_assign)) { + $_output .= "\$_smarty_tpl->assign({$_assign}, ob_get_clean());\n"; + } + if ($update_compile_id) { + $_output .= $compiler->makeNocacheCode("\$_smarty_tpl->compile_id = array_pop(\$_compile_id_save);\n"); + } + $_output .= "?>\n"; + + return $_output; + } + + if ($call_nocache) { + $compiler->tag_nocache = true; + } + $_output = "<?php "; + if ($update_compile_id) { + $_output .= "\$_compile_id_save[] = \$_smarty_tpl->compile_id;\n\$_smarty_tpl->compile_id = {$_compile_id};\n"; + } + // was there an assign attribute + if (isset($_assign)) { + $_output .= "ob_start();\n"; + } + $_output .= "\$_smarty_tpl->_subTemplateRender({$fullResourceName}, $_cache_id, $_compile_id, $_caching, $_cache_lifetime, $_vars, $_scope, {$_cache_tpl});\n"; + if (isset($_assign)) { + $_output .= "\$_smarty_tpl->assign({$_assign}, ob_get_clean());\n"; + } + if ($update_compile_id) { + $_output .= "\$_smarty_tpl->compile_id = array_pop(\$_compile_id_save);\n"; + } + $_output .= "?>\n"; + return $_output; + } + + /** + * Compile inline sub template + * + * @param \Smarty_Internal_SmartyTemplateCompiler $compiler + * @param \Smarty_Internal_Template $tpl + * @param string $t_hash + * + * @return bool + */ + public function compileInlineTemplate(Smarty_Internal_SmartyTemplateCompiler $compiler, + Smarty_Internal_Template $tpl, $t_hash) + { + $uid = $tpl->source->type . $tpl->source->uid; + if (!($tpl->source->handler->uncompiled) && $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; + } + $tpl->compiled = new Smarty_Template_Compiled(); + $tpl->compiled->nocache_hash = $compiler->parent_compiler->template->compiled->nocache_hash; + $tpl->loadCompiler(); + // save unique function name + $compiler->parent_compiler->mergedSubTemplatesData[ $uid ][ $t_hash ][ 'func' ] = + $tpl->compiled->unifunc = 'content_' . str_replace(array('.', ','), '_', uniqid('', true)); + // make sure whole chain gets compiled + $tpl->mustCompile = true; + $compiler->parent_compiler->mergedSubTemplatesData[ $uid ][ $t_hash ][ 'nocache_hash' ] = + $tpl->compiled->nocache_hash; + if ($compiler->template->source->type == 'file') { + $sourceInfo = $compiler->template->source->filepath; + } else { + $basename = $compiler->template->source->handler->getBasename($compiler->template->source); + $sourceInfo = $compiler->template->source->type . ':' . + ($basename ? $basename : $compiler->template->source->name); + } + // get compiled code + $compiled_code = "<?php\n\n"; + $compiled_code .= "/* Start inline template \"{$sourceInfo}\" =============================*/\n"; + $compiled_code .= "function {$tpl->compiled->unifunc} (\$_smarty_tpl) {\n"; + $compiled_code .= "?>\n" . $tpl->compiler->compileTemplateSource($tpl, null, $compiler->parent_compiler); + $compiled_code .= "<?php\n"; + $compiled_code .= "}\n?>\n"; + $compiled_code .= $tpl->compiler->postFilter($tpl->compiler->blockOrFunctionCode); + $compiled_code .= "<?php\n\n"; + $compiled_code .= "/* End inline template \"{$sourceInfo}\" =============================*/\n"; + $compiled_code .= "?>"; + unset($tpl->compiler); + if ($tpl->compiled->has_nocache_code) { + // replace nocache_hash + $compiled_code = + str_replace("{$tpl->compiled->nocache_hash}", $compiler->template->compiled->nocache_hash, + $compiled_code); + $compiler->template->compiled->has_nocache_code = true; + } + $compiler->parent_compiler->mergedSubTemplatesCode[ $tpl->compiled->unifunc ] = $compiled_code; + return true; + } else { + return false; + } + } +} |