makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 14:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

Template engine optimisations, fixes, etc. Hopefully removed the need for error suppression in conditionals, unified some of the regex's

Browse source 
git-svn-id: file:///svn/phpbb/trunk@9587 89ea8834-ac86-4346-8a33-228a782c2dd0
This commit is contained in:
Chris Smith 2009-06-13 20:21:15 +00:00
parent d428a6c652
commit fd1608ab82
2 changed files with 59 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
phpBB/includes/classes/template.php
View file

@ -242,6 +242,11 @@ class phpbb_template
*/ */
private function _tpl_load($handle) private function _tpl_load($handle)
{ {
if (!isset($this->filename[$handle]))
{
trigger_error("template->_tpl_load(): No file specified for handle $handle", E_USER_ERROR);
}
$filename = $this->cachepath . str_replace('/', '.', $this->filename[$handle]) . '.' . PHP_EXT; $filename = $this->cachepath . str_replace('/', '.', $this->filename[$handle]) . '.' . PHP_EXT;
$recompile = (!file_exists($filename) || @filesize($filename) === 0 || (phpbb::$config['load_tplcompile'] && @filemtime($filename) < filemtime($this->files[$handle]))) ? true : false; $recompile = (!file_exists($filename) || @filesize($filename) === 0 || (phpbb::$config['load_tplcompile'] && @filemtime($filename) < filemtime($this->files[$handle]))) ? true : false;

80
phpBB/includes/classes/template_compile.php
View file

@ -23,10 +23,13 @@ if (!defined('IN_PHPBB'))
*/ */
class phpbb_template_filter extends php_user_filter class phpbb_template_filter extends php_user_filter
{ {
/** const REGEX_NS = '[a-z][a-z_0-9]+';
* @var string Replaceable tokens regex
*/ const REGEX_VAR = '[A-Z][A-Z_0-9]+';
private $regex = '~<!-- ([A-Z][A-Z_0-9]+)(?: (.*?) ?)?-->|{((?:[a-z][a-z_0-9]+\.)*\\$?[A-Z][A-Z_0-9]+)}~';
const REGEX_TAG = '<!-- ([A-Z][A-Z_0-9]+)(?: (.*?) ?)?-->';
const REGEX_TOKENS = '~<!-- ([A-Z][A-Z_0-9]+)(?: (.*?) ?)?-->|{((?:[a-z][a-z_0-9]+\.)*\\$?[A-Z][A-Z_0-9]+)}~';
/** /**
* @var array * @var array
@ -87,7 +90,7 @@ class phpbb_template_filter extends php_user_filter
private function compile($data) private function compile($data)
{ {
$data = preg_replace('#<(?:[\\?%]|script)#s', '<?php echo\'\\0\';?>', $data); $data = preg_replace('#<(?:[\\?%]|script)#s', '<?php echo\'\\0\';?>', $data);
return str_replace('?><?php', '', preg_replace_callback($this->regex, array($this, 'replace'), $data)); return str_replace('?><?php', '', preg_replace_callback(self::REGEX_TOKENS, array($this, 'replace'), $data));
} }
private function replace($matches) private function replace($matches)
@ -172,7 +175,7 @@ class phpbb_template_filter extends php_user_filter
$varrefs = array(); $varrefs = array();
// This one will handle varrefs WITH namespaces // This one will handle varrefs WITH namespaces
preg_match_all('#\{((?:[a-z0-9\-_]+\.)+)(\$)?([A-Z0-9\-_]+)\}#', $text_blocks, $varrefs, PREG_SET_ORDER); preg_match_all('#\{((?:' . self::REGEX_NS . '\.)+)(\$)?(' . self::REGEX_VAR . ')\}#', $text_blocks, $varrefs, PREG_SET_ORDER);
foreach ($varrefs as $var_val) foreach ($varrefs as $var_val)
{ {
@ -187,28 +190,28 @@ class phpbb_template_filter extends php_user_filter
$this->compile_language_tags($text_blocks); $this->compile_language_tags($text_blocks);
// This will handle the remaining root-level varrefs // This will handle the remaining root-level varrefs
$text_blocks = preg_replace('#\{([A-Z0-9\-_]+)\}#', "<?php echo (isset(\$_rootref['\\1'])) ? \$_rootref['\\1'] : ''; ?>", $text_blocks); $text_blocks = preg_replace('#\{(' . self::REGEX_VAR . ')\}#', "<?php echo (isset(\$_rootref['\\1'])) ? \$_rootref['\\1'] : ''; ?>", $text_blocks);
$text_blocks = preg_replace('#\{\$([A-Z0-9\-_]+)\}#', "<?php echo (isset(\$_tpldata['DEFINE']['.']['\\1'])) ? \$_tpldata['DEFINE']['.']['\\1'] : ''; ?>", $text_blocks); $text_blocks = preg_replace('#\{\$(' . self::REGEX_VAR . ')\}#', "<?php echo (isset(\$_tpldata['DEFINE']['.']['\\1'])) ? \$_tpldata['DEFINE']['.']['\\1'] : ''; ?>", $text_blocks);
return $text_blocks; return $text_blocks;
} }
/** /**
* Handlse special language tags L_ and LA_ * Handles special language tags L_ and LA_
*/ */
private function compile_language_tags(&$text_blocks) private function compile_language_tags(&$text_blocks)
{ {
// transform vars prefixed by L_ into their language variable pendant if nothing is set within the tpldata array // transform vars prefixed by L_ into their language variable pendant if nothing is set within the tpldata array
if (strpos($text_blocks, '{L_') !== false) if (strpos($text_blocks, '{L_') !== false)
{ {
$text_blocks = preg_replace('#\{L_([A-Z0-9\-_]+)\}#', "<?php echo ((isset(\$_rootref['L_\\1'])) ? \$_rootref['L_\\1'] : ((isset(\$_lang['\\1'])) ? \$_lang['\\1'] : '{ \\1 }')); ?>", $text_blocks); $text_blocks = preg_replace('#\{L_(' . self::REGEX_VAR . ')\}#', "<?php echo ((isset(\$_rootref['L_\\1'])) ? \$_rootref['L_\\1'] : ((isset(\$_lang['\\1'])) ? \$_lang['\\1'] : '{ \\1 }')); ?>", $text_blocks);
} }
// Handle addslashed language variables prefixed with LA_ // Handle addslashed language variables prefixed with LA_
// If a template variable already exist, it will be used in favor of it... // If a template variable already exist, it will be used in favor of it...
if (strpos($text_blocks, '{LA_') !== false) if (strpos($text_blocks, '{LA_') !== false)
{ {
$text_blocks = preg_replace('#\{LA_([A-Z0-9\-_]+)\}#', "<?php echo ((isset(\$_rootref['LA_\\1'])) ? \$_rootref['LA_\\1'] : ((isset(\$_rootref['L_\\1'])) ? addslashes(\$_rootref['L_\\1']) : ((isset(\$_lang['\\1'])) ? addslashes(\$_lang['\\1']) : '{ \\1 }'))); ?>", $text_blocks); $text_blocks = preg_replace('#\{LA_(' . self::REGEX_VAR . '+)\}#', "<?php echo ((isset(\$_rootref['LA_\\1'])) ? \$_rootref['LA_\\1'] : ((isset(\$_rootref['L_\\1'])) ? addslashes(\$_rootref['L_\\1']) : ((isset(\$_lang['\\1'])) ? addslashes(\$_lang['\\1']) : '{ \\1 }'))); ?>", $text_blocks);
} }
} }
@ -240,6 +243,7 @@ class phpbb_template_filter extends php_user_filter
// foo(3,4) : Will start the loop on the fourth entry and end it on the fifth // foo(3,4) : Will start the loop on the fourth entry and end it on the fifth
// foo(3,-4) : Will start the loop on the fourth entry and end it four from last // foo(3,-4) : Will start the loop on the fourth entry and end it four from last
$match = array(); $match = array();
if (preg_match('#^([^()]*)\(([\-\d]+)(?:,([\-\d]+))?\)$#', $tag_args, $match)) if (preg_match('#^([^()]*)\(([\-\d]+)(?:,([\-\d]+))?\)$#', $tag_args, $match))
{ {
$tag_args = $match[1]; $tag_args = $match[1];
@ -253,7 +257,7 @@ class phpbb_template_filter extends php_user_filter
$loop_start = '($_' . $tag_args . '_count < ' . $match[2] . ' ? $_' . $tag_args . '_count : ' . $match[2] . ')'; $loop_start = '($_' . $tag_args . '_count < ' . $match[2] . ' ? $_' . $tag_args . '_count : ' . $match[2] . ')';
} }
if (strlen($match[3]) < 1 || $match[3] == -1) if (!isset($match[3]) || strlen($match[3]) < 1 || $match[3] == -1)
{ {
$loop_end = '$_' . $tag_args . '_count'; $loop_end = '$_' . $tag_args . '_count';
} }
@ -328,7 +332,7 @@ class phpbb_template_filter extends php_user_filter
* some adaptions for our block level methods * some adaptions for our block level methods
* @access private * @access private
*/ */
private function compile_expression($tag_args) private function compile_expression($tag_args, &$vars = array())
{ {
$match = array(); $match = array();
preg_match_all('/(?: preg_match_all('/(?:
@ -435,7 +439,7 @@ class phpbb_template_filter extends php_user_filter
default: default:
$varrefs = array(); $varrefs = array();
if (preg_match('#^((?:[a-z0-9\-_]+\.)+)?(\$)?(?=[A-Z])([A-Z0-9\-_]+)#s', $token, $varrefs)) if (preg_match('#^((?:' . self::REGEX_NS . '\.)+)?(\$)?(?=[A-Z])([A-Z0-9\-_]+)#s', $token, $varrefs))
{ {
if (!empty($varrefs[1])) if (!empty($varrefs[1]))
{ {
@ -469,15 +473,18 @@ class phpbb_template_filter extends php_user_filter
default: default:
$token = $this->generate_block_data_ref(substr($varrefs[1], 0, -1), true, $varrefs[2]) . '[\'' . $varrefs[3] . '\']'; $token = $this->generate_block_data_ref(substr($varrefs[1], 0, -1), true, $varrefs[2]) . '[\'' . $varrefs[3] . '\']';
$vars[$token] = true;
break; break;
} }
} }
else else
{ {
$token = ($varrefs[2]) ? '$_tpldata[\'DEFINE\'][\'.\'][\'' . $varrefs[3] . '\']' : '$_rootref[\'' . $varrefs[3] . '\']'; $token = ($varrefs[2]) ? '$_tpldata[\'DEFINE\'][\'.\'][\'' . $varrefs[3] . '\']' : '$_rootref[\'' . $varrefs[3] . '\']';
$vars[$token] = true;
} }
} }
else if (preg_match('#^\.((?:[a-z0-9\-_]+\.?)+)$#s', $token, $varrefs)) else if (preg_match('#^\.((?:' . self::REGEX_NS . '\.?)+)$#s', $token, $varrefs))
{ {
// Allow checking if loops are set with .loopname // Allow checking if loops are set with .loopname
// It is also possible to check the loop count by doing <!-- IF .loopname > 1 --> for example // It is also possible to check the loop count by doing <!-- IF .loopname > 1 --> for example
@ -514,12 +521,19 @@ class phpbb_template_filter extends php_user_filter
private function compile_tag_if($tag_args, $elseif) private function compile_tag_if($tag_args, $elseif)
{ {
$tokens = $this->compile_expression($tag_args); $vars = array();
$tokens = $this->compile_expression($tag_args, $vars);
$tpl = ($elseif) ? '} else if (' : 'if (';
if (!empty($vars))
{
$tpl .= '(isset(' . implode(') && isset(', array_keys($vars)) . ')) && ';
}
// @todo We suppress notices within IF statements until we find a way to correctly check them
$tpl = ($elseif) ? '} else if (@(' : 'if (@(';
$tpl .= implode(' ', $tokens); $tpl .= implode(' ', $tokens);
$tpl .= ')) { '; $tpl .= ') { ';
return $tpl; return $tpl;
} }
@ -531,7 +545,7 @@ class phpbb_template_filter extends php_user_filter
private function compile_tag_define($tag_args, $op) private function compile_tag_define($tag_args, $op)
{ {
$match = array(); $match = array();
preg_match('#^((?:[a-z0-9\-_]+\.)+)?\$(?=[A-Z])([A-Z0-9_\-]*)(?: = (.*?))?$#', $tag_args, $match); preg_match('#^((?:' . self::REGEX_NS . '\.)+)?\$(?=[A-Z])([A-Z0-9_\-]*)(?: = (.*?))?$#', $tag_args, $match);
if (empty($match[2]) || (!isset($match[3]) && $op)) if (empty($match[2]) || (!isset($match[3]) && $op))
{ {
@ -563,7 +577,7 @@ class phpbb_template_filter extends php_user_filter
*/ */
private function compile_tag_include_php($tag_args) private function compile_tag_include_php($tag_args)
{ {
return "include('" . $tag_args . "');"; return "include('$tag_args');";
} }
/** /**
@ -589,7 +603,7 @@ class phpbb_template_filter extends php_user_filter
switch ($expr_type) switch ($expr_type)
{ {
case 'even': case 'even':
if (@$tokens[$expr_end] == 'by') if (isset($tokens[$expr_end]) && $tokens[$expr_end] == 'by')
{ {
$expr_end++; $expr_end++;
$expr_arg = $tokens[$expr_end++]; $expr_arg = $tokens[$expr_end++];
@ -602,7 +616,7 @@ class phpbb_template_filter extends php_user_filter
break; break;
case 'odd': case 'odd':
if (@$tokens[$expr_end] == 'by') if (isset($tokens[$expr_end]) && $tokens[$expr_end] == 'by')
{ {
$expr_end++; $expr_end++;
$expr_arg = $tokens[$expr_end++]; $expr_arg = $tokens[$expr_end++];
@ -615,7 +629,7 @@ class phpbb_template_filter extends php_user_filter
break; break;
case 'div': case 'div':
if (@$tokens[$expr_end] == 'by') if (isset($tokens[$expr_end]) && $tokens[$expr_end] == 'by')
{ {
$expr_end++; $expr_end++;
$expr_arg = $tokens[$expr_end++]; $expr_arg = $tokens[$expr_end++];
@ -625,9 +639,17 @@ class phpbb_template_filter extends php_user_filter
} }
if ($negate_expr) if ($negate_expr)
{
if ($expr[0] == '!')
{
// Negated expression, de-negate it.
$expr = substr($expr, 1);
}
else
{ {
$expr = "!($expr)"; $expr = "!($expr)";
} }
}
array_splice($tokens, 0, $expr_end, $expr); array_splice($tokens, 0, $expr_end, $expr);
@ -653,6 +675,7 @@ class phpbb_template_filter extends php_user_filter
$namespace = substr($namespace, 0, -1); $namespace = substr($namespace, 0, -1);
$expr = true; $expr = true;
$isset = false;
// S_ROW_COUNT is deceptive, it returns the current row number now the number of rows // S_ROW_COUNT is deceptive, it returns the current row number now the number of rows
// hence S_ROW_COUNT is deprecated in favour of S_ROW_NUM // hence S_ROW_COUNT is deprecated in favour of S_ROW_NUM
@ -688,10 +711,11 @@ class phpbb_template_filter extends php_user_filter
$varref .= "['$varname']"; $varref .= "['$varname']";
$expr = false; $expr = false;
$isset = true;
break; break;
} }
// @todo Test the !$expr more // @todo Test the !$expr more
$varref = ($echo) ? "<?php echo $varref; ?>" : (($expr || isset($varref)) ? $varref : ''); $varref = ($echo) ? '<?php echo ' . ($isset ? "isset($varref) ? $varref : ''" : $varref) . '; ?>' : (($expr || isset($varref)) ? $varref : '');
return $varref; return $varref;
} }
@ -767,15 +791,15 @@ stream_filter_register('phpbb_template', 'phpbb_template_filter');
class phpbb_template_compile class phpbb_template_compile
{ {
/** /**
* @var template Reference to the {@link template template} object performing compilation * @var phpbb_template Reference to the {@link phpbb_template template} object performing compilation
*/ */
private $template; private $template;
/** /**
* Constructor * Constructor
* @param template $template {@link template Template} object performing compilation * @param phpbb_template $template {@link phpbb_template Template} object performing compilation
*/ */
function __construct(phpbb_template $template) public function __construct(phpbb_template $template)
{ {
$this->template = $template; $this->template = $template;
} }