diff options
Diffstat (limited to 'phpBB/phpbb/template/twig')
23 files changed, 2221 insertions, 0 deletions
| diff --git a/phpBB/phpbb/template/twig/definition.php b/phpBB/phpbb/template/twig/definition.php new file mode 100644 index 0000000000..cb3c953692 --- /dev/null +++ b/phpBB/phpbb/template/twig/definition.php @@ -0,0 +1,69 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig; + +/** +* This class holds all DEFINE variables from the current page load +*/ +class definition +{ +	/** @var array **/ +	protected $definitions = array(); + +	/** +	* Get a DEFINE'd variable +	* +	* @param string $name +	* @param array $arguments +	* +	* @return mixed Null if not found +	*/ +	public function __call($name, $arguments) +	{ +		return (isset($this->definitions[$name])) ? $this->definitions[$name] : null; +	} + +	/** +	* DEFINE a variable +	* +	* @param string $name +	* @param mixed $value +	* @return \phpbb\template\twig\definition +	*/ +	public function set($name, $value) +	{ +		$this->definitions[$name] = $value; + +		return $this; +	} + +	/** +	* Append to a variable +	* +	* @param string $name +	* @param string $value +	* @return \phpbb\template\twig\definition +	*/ +	public function append($name, $value) +	{ +		if (!isset($this->definitions[$name])) +		{ +			$this->definitions[$name] = ''; +		} + +		$this->definitions[$name] .= $value; + +		return $this; +	} +} diff --git a/phpBB/phpbb/template/twig/environment.php b/phpBB/phpbb/template/twig/environment.php new file mode 100644 index 0000000000..476ffd935e --- /dev/null +++ b/phpBB/phpbb/template/twig/environment.php @@ -0,0 +1,205 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig; + +class environment extends \Twig_Environment +{ +	/** @var \phpbb\config\config */ +	protected $phpbb_config; + +	/** @var \phpbb\path_helper */ +	protected $phpbb_path_helper; + +	/** @var \phpbb\extension\manager */ +	protected $extension_manager; + +	/** @var string */ +	protected $phpbb_root_path; + +	/** @var string */ +	protected $web_root_path; + +	/** @var array **/ +	protected $namespace_look_up_order = array('__main__'); + +	/** +	* Constructor +	* +	* @param \phpbb\config\config $phpbb_config The phpBB configuration +	* @param \phpbb\path_helper $path_helper phpBB path helper +	* @param \phpbb\extension\manager $extension_manager phpBB extension manager +	* @param \Twig_LoaderInterface $loader Twig loader interface +	* @param array $options Array of options to pass to Twig +	*/ +	public function __construct($phpbb_config, \phpbb\path_helper $path_helper, \phpbb\extension\manager $extension_manager = null, \Twig_LoaderInterface $loader = null, $options = array()) +	{ +		$this->phpbb_config = $phpbb_config; + +		$this->phpbb_path_helper = $path_helper; +		$this->extension_manager = $extension_manager; + +		$this->phpbb_root_path = $this->phpbb_path_helper->get_phpbb_root_path(); +		$this->web_root_path = $this->phpbb_path_helper->get_web_root_path(); + +		return parent::__construct($loader, $options); +	} + +	/** +	* Get the list of enabled phpBB extensions +	* +	* Used in EVENT node +	* +	* @return array +	*/ +	public function get_phpbb_extensions() +	{ +		return ($this->extension_manager) ? $this->extension_manager->all_enabled() : array(); +	} + +	/** +	* Get phpBB config +	* +	* @return \phpbb\config\config +	*/ +	public function get_phpbb_config() +	{ +		return $this->phpbb_config; +	} + +	/** +	* Get the phpBB root path +	* +	* @return string +	*/ +	public function get_phpbb_root_path() +	{ +		return $this->phpbb_root_path; +	} + +	/** +	* Get the web root path +	* +	* @return string +	*/ +	public function get_web_root_path() +	{ +		return $this->web_root_path; +	} + +	/** +	* Get the phpbb path helper object +	* +	* @return \phpbb\path_helper +	*/ +	public function get_path_helper() +	{ +		return $this->phpbb_path_helper; +	} + +	/** +	* Get the namespace look up order +	* +	* @return array +	*/ +	public function getNamespaceLookUpOrder() +	{ +		return $this->namespace_look_up_order; +	} + +	/** +	* Set the namespace look up order to load templates from +	* +	* @param array $namespace +	* @return \Twig_Environment +	*/ +	public function setNamespaceLookUpOrder($namespace) +	{ +		$this->namespace_look_up_order = $namespace; + +		return $this; +	} + +	/** +	* Loads a template by name. +	* +	* @param string  $name  The template name +	* @param integer $index The index if it is an embedded template +	* @return \Twig_TemplateInterface A template instance representing the given template name +	* @throws \Twig_Error_Loader +	*/ +	public function loadTemplate($name, $index = null) +	{ +		if (strpos($name, '@') === false) +		{ +			foreach ($this->getNamespaceLookUpOrder() as $namespace) +			{ +				try +				{ +					if ($namespace === '__main__') +					{ +						return parent::loadTemplate($name, $index); +					} + +					return parent::loadTemplate('@' . $namespace . '/' . $name, $index); +				} +				catch (\Twig_Error_Loader $e) +				{ +				} +			} + +			// We were unable to load any templates +			throw $e; +		} +		else +		{ +			return parent::loadTemplate($name, $index); +		} +	} + +	/** +	* Finds a template by name. +	* +	* @param string  $name  The template name +	* @return string +	* @throws \Twig_Error_Loader +	*/ +	public function findTemplate($name) +	{ +		if (strpos($name, '@') === false) +		{ +			foreach ($this->getNamespaceLookUpOrder() as $namespace) +			{ +				try +				{ +					if ($namespace === '__main__') +					{ +						return parent::getLoader()->getCacheKey($name); +					} + +					return parent::getLoader()->getCacheKey('@' . $namespace . '/' . $name); +				} +				catch (\Twig_Error_Loader $e) +				{ +				} +			} + +			// We were unable to load any templates +			throw $e; +		} +		else +		{ +			return parent::getLoader()->getCacheKey($name); +		} +	} +} diff --git a/phpBB/phpbb/template/twig/extension.php b/phpBB/phpbb/template/twig/extension.php new file mode 100644 index 0000000000..3a983491b9 --- /dev/null +++ b/phpBB/phpbb/template/twig/extension.php @@ -0,0 +1,185 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig; + +class extension extends \Twig_Extension +{ +	/** @var \phpbb\template\context */ +	protected $context; + +	/** @var \phpbb\user */ +	protected $user; + +	/** +	* Constructor +	* +	* @param \phpbb\template\context $context +	* @param \phpbb\user $user +	* @return \phpbb\template\twig\extension +	*/ +	public function __construct(\phpbb\template\context $context, $user) +	{ +		$this->context = $context; +		$this->user = $user; +	} + +	/** +	* Get the name of this extension +	* +	* @return string +	*/ +	public function getName() +	{ +		return 'phpbb'; +	} + +	/** +	* Returns the token parser instance to add to the existing list. +	* +	* @return array An array of Twig_TokenParser instances +	*/ +	public function getTokenParsers() +	{ +		return array( +			new \phpbb\template\twig\tokenparser\defineparser, +			new \phpbb\template\twig\tokenparser\includeparser, +			new \phpbb\template\twig\tokenparser\includejs, +			new \phpbb\template\twig\tokenparser\includecss, +			new \phpbb\template\twig\tokenparser\event, +			new \phpbb\template\twig\tokenparser\includephp, +			new \phpbb\template\twig\tokenparser\php, +		); +	} + +	/** +	* Returns a list of filters to add to the existing list. +	* +	* @return array An array of filters +	*/ +	public function getFilters() +	{ +		return array( +			new \Twig_SimpleFilter('subset', array($this, 'loop_subset'), array('needs_environment' => true)), +			new \Twig_SimpleFilter('addslashes', 'addslashes'), +		); +	} + +	/** +	* Returns a list of global functions to add to the existing list. +	* +	* @return array An array of global functions +	*/ +	public function getFunctions() +	{ +		return array( +			new \Twig_SimpleFunction('lang', array($this, 'lang')), +		); +	} + +	/** +	* Returns a list of operators to add to the existing list. +	* +	* @return array An array of operators +	*/ +	public function getOperators() +	{ +		return array( +			array( +				'!' => array('precedence' => 50, 'class' => 'Twig_Node_Expression_Unary_Not'), +			), +			array( +				// precedence settings are copied from similar operators in Twig core extension +				'||' => array('precedence' => 10, 'class' => 'Twig_Node_Expression_Binary_Or', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), +				'&&' => array('precedence' => 15, 'class' => 'Twig_Node_Expression_Binary_And', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), + +				'eq' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_Equal', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), + +				'ne' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_NotEqual', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), +				'neq' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_NotEqual', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), +				'<>' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_NotEqual', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), + +				'===' => array('precedence' => 20, 'class' => '\phpbb\template\twig\node\expression\binary\equalequal', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), +				'!==' => array('precedence' => 20, 'class' => '\phpbb\template\twig\node\expression\binary\notequalequal', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), + +				'gt' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_Greater', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), +				'gte' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_GreaterEqual', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), +				'ge' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_GreaterEqual', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), +				'lt' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_Less', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), +				'lte' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_LessEqual', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), +				'le' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_LessEqual', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), + +				'mod' => array('precedence' => 60, 'class' => 'Twig_Node_Expression_Binary_Mod', 'associativity' => \Twig_ExpressionParser::OPERATOR_LEFT), +			), +		); +	} + +	/** +	* Grabs a subset of a loop +	* +	* @param \Twig_Environment $env          A Twig_Environment instance +	* @param mixed            $item         A variable +	* @param integer          $start        Start of the subset +	* @param integer          $end   	     End of the subset +	* @param Boolean          $preserveKeys Whether to preserve key or not (when the input is an array) +	* +	* @return mixed The sliced variable +	*/ +	function loop_subset(\Twig_Environment $env, $item, $start, $end = null, $preserveKeys = false) +	{ +		// We do almost the same thing as Twig's slice (array_slice), except when $end is positive +		if ($end >= 1) +		{ +			// When end is > 1, subset will end on the last item in an array with the specified $end +			// This is different from slice in that it is the number we end on rather than the number +			//  of items to grab (length) + +			// Start must always be the actual starting number for this calculation (not negative) +			$start = ($start < 0) ? sizeof($item) + $start : $start; +			$end = $end - $start; +		} + +		// We always include the last element (this was the past design) +		$end = ($end == -1 || $end === null) ? null : $end + 1; + +		return twig_slice($env, $item, $start, $end, $preserveKeys); +	} + +	/** +	* Get output for a language variable (L_FOO, LA_FOO) +	* +	* This function checks to see if the language var was outputted to $context +	* (e.g. in the ACP, L_TITLE) +	* If not, we return the result of $user->lang() +	* +	* @return string +	*/ +	function lang() +	{ +		$args = func_get_args(); +		$key = $args[0]; + +		$context = $this->context->get_data_ref(); +		$context_vars = $context['.'][0]; + +		if (isset($context_vars['L_' . $key])) +		{ +			return $context_vars['L_' . $key]; +		} + +		// LA_ is transformed into lang(\'$1\')|addslashes, so we should not +		// need to check for it + +		return call_user_func_array(array($this->user, 'lang'), $args); +	} +} diff --git a/phpBB/phpbb/template/twig/lexer.php b/phpBB/phpbb/template/twig/lexer.php new file mode 100644 index 0000000000..c5dc7273ba --- /dev/null +++ b/phpBB/phpbb/template/twig/lexer.php @@ -0,0 +1,354 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig; + +class lexer extends \Twig_Lexer +{ +	public function tokenize($code, $filename = null) +	{ +		// Our phpBB tags +		// Commented out tokens are handled separately from the main replace +		$phpbb_tags = array( +			/*'BEGIN', +			'BEGINELSE', +			'END', +			'IF', +			'ELSE', +			'ELSEIF', +			'ENDIF', +			'DEFINE', +			'UNDEFINE',*/ +			'ENDDEFINE', +			'INCLUDE', +			'INCLUDEPHP', +			'INCLUDEJS', +			'INCLUDECSS', +			'PHP', +			'ENDPHP', +			'EVENT', +		); + +		// Twig tag masks +		$twig_tags = array( +			'autoescape', +			'endautoescape', +			'if', +			'elseif', +			'else', +			'endif', +			'block', +			'endblock', +			'use', +			'extends', +			'embed', +			'filter', +			'endfilter', +			'flush', +			'for', +			'endfor', +			'macro', +			'endmacro', +			'import', +			'from', +			'sandbox', +			'endsandbox', +			'set', +			'endset', +			'spaceless', +			'endspaceless', +			'verbatim', +			'endverbatim', +		); + +		// Fix tokens that may have inline variables (e.g. <!-- DEFINE $TEST = '{FOO}') +		$code = $this->strip_surrounding_quotes(array( +			'INCLUDE', +			'INCLUDEPHP', +			'INCLUDEJS', +			'INCLUDECSS', +		), $code); +		$code = $this->fix_inline_variable_tokens(array( +			'DEFINE \$[a-zA-Z0-9_]+ =', +			'INCLUDE', +			'INCLUDEPHP', +			'INCLUDEJS', +			'INCLUDECSS', +		), $code); +		$code = $this->add_surrounding_quotes(array( +			'INCLUDE', +			'INCLUDEPHP', +			'INCLUDEJS', +			'INCLUDECSS', +		), $code); + +		// Fix our BEGIN statements +		$code = $this->fix_begin_tokens($code); + +		// Fix our IF tokens +		$code = $this->fix_if_tokens($code); + +		// Fix our DEFINE tokens +		$code = $this->fix_define_tokens($code); + +		// Replace all of our starting tokens, <!-- TOKEN --> with Twig style, {% TOKEN %} +		// This also strips outer parenthesis, <!-- IF (blah) --> becomes <!-- IF blah --> +		$code = preg_replace('#<!-- (' . implode('|', $phpbb_tags) . ')(?: (.*?) ?)?-->#', '{% $1 $2 %}', $code); + +		// Replace all of our twig masks with Twig code (e.g. <!-- BLOCK .+ --> with {% block $1 %}) +		$code = $this->replace_twig_tag_masks($code, $twig_tags); + +		// Replace all of our language variables, {L_VARNAME}, with Twig style, {{ lang('NAME') }} +		// Appends any filters after lang() +		$code = preg_replace('#{L_([a-zA-Z0-9_\.]+)(\|[^}]+?)?}#', '{{ lang(\'$1\')$2 }}', $code); + +		// Replace all of our escaped language variables, {LA_VARNAME}, with Twig style, {{ lang('NAME')|addslashes }} +		// Appends any filters after lang(), but before addslashes +		$code = preg_replace('#{LA_([a-zA-Z0-9_\.]+)(\|[^}]+?)?}#', '{{ lang(\'$1\')$2|addslashes }}', $code); + +		// Replace all of our variables, {VARNAME}, with Twig style, {{ VARNAME }} +		// Appends any filters +		$code = preg_replace('#{([a-zA-Z0-9_\.]+)(\|[^}]+?)?}#', '{{ $1$2 }}', $code); + +		return parent::tokenize($code, $filename); +	} + +	/** +	* Strip surrounding quotes +	* +	* First step to fix tokens that may have inline variables +	* E.g. <!-- INCLUDE '{TEST}.html' to <!-- INCLUDE {TEST}.html +	* +	* @param array $tokens array of tokens to search for (imploded to a regular expression) +	* @param string $code +	* @return string +	*/ +	protected function strip_surrounding_quotes($tokens, $code) +	{ +		// Remove matching quotes at the beginning/end if a statement; +		// E.g. 'asdf'"' -> asdf'" +		// E.g. "asdf'"" -> asdf'" +		// E.g. 'asdf'" -> 'asdf'" +		return preg_replace('#<!-- (' . implode('|', $tokens) . ') (([\'"])?(.*?)\1) -->#', '<!-- $1 $2 -->', $code); +	} + +	/** +	* Fix tokens that may have inline variables +	* +	* Second step to fix tokens that may have inline variables +	* E.g. <!-- INCLUDE '{TEST}.html' to <!-- INCLUDE ' ~ {TEST} ~ '.html +	* +	* @param array $tokens array of tokens to search for (imploded to a regular expression) +	* @param string $code +	* @return string +	*/ +	protected function fix_inline_variable_tokens($tokens, $code) +	{ +		$callback = function($matches) +		{ +			// Replace template variables with start/end to parse variables (' ~ TEST ~ '.html) +			$matches[2] = preg_replace('#{([a-zA-Z0-9_\.$]+)}#', "'~ \$1 ~'", $matches[2]); + +			return "<!-- {$matches[1]} {$matches[2]} -->"; +		}; + +		return preg_replace_callback('#<!-- (' . implode('|', $tokens) . ') (.+?) -->#', $callback, $code); +	} + +	/** +	* Add surrounding quotes +	* +	* Last step to fix tokens that may have inline variables +	* E.g. <!-- INCLUDE '{TEST}.html' to <!-- INCLUDE '' ~ {TEST} ~ '.html' +	* +	* @param array $tokens array of tokens to search for (imploded to a regular expression) +	* @param string $code +	* @return string +	*/ +	protected function add_surrounding_quotes($tokens, $code) +	{ +		return preg_replace('#<!-- (' . implode('|', $tokens) . ') (.+?) -->#', '<!-- $1 \'$2\' -->', $code); +	} + +	/** +	* Fix begin tokens (convert our BEGIN to Twig for) +	* +	* Not meant to be used outside of this context, public because the anonymous function calls this +	* +	* @param string $code +	* @param array $parent_nodes (used in recursion) +	* @return string +	*/ +	public function fix_begin_tokens($code, $parent_nodes = array()) +	{ +		// PHP 5.3 cannot use $this in an anonymous function, so use this as a work-around +		$parent_class = $this; +		$callback = function ($matches) use ($parent_class, $parent_nodes) +		{ +			$hard_parents = explode('.', $matches[1]); +			array_pop($hard_parents); // ends with . +			if ($hard_parents) +			{ +				$parent_nodes = array_merge($hard_parents, $parent_nodes); +			} + +			$name = $matches[2]; +			$subset = trim(substr($matches[3], 1, -1)); // Remove parenthesis +			$body = $matches[4]; + +			// Replace <!-- BEGINELSE --> +			$body = str_replace('<!-- BEGINELSE -->', '{% else %}', $body); + +			// Is the designer wanting to call another loop in a loop? +			// <!-- BEGIN loop --> +			// <!-- BEGIN !loop2 --> +			// <!-- END !loop2 --> +			// <!-- END loop --> +			// 'loop2' is actually on the same nesting level as 'loop' you assign +			// variables to it with template->assign_block_vars('loop2', array(...)) +			if (strpos($name, '!') === 0) +			{ +				// Count the number if ! occurrences +				$count = substr_count($name, '!'); +				for ($i = 0; $i < $count; $i++) +				{ +					array_pop($parent_nodes); +					$name = substr($name, 1); +				} +			} + +			// Remove all parent nodes, e.g. foo, bar from foo.bar.foobar.VAR +			foreach ($parent_nodes as $node) +			{ +				$body = preg_replace('#([^a-zA-Z0-9_])' . $node . '\.([a-zA-Z0-9_]+)\.#', '$1$2.', $body); +			} + +			// Add current node to list of parent nodes for child nodes +			$parent_nodes[] = $name; + +			// Recursive...fix any child nodes +			$body = $parent_class->fix_begin_tokens($body, $parent_nodes); + +			// Need the parent variable name +			array_pop($parent_nodes); +			$parent = (!empty($parent_nodes)) ? end($parent_nodes) . '.' : ''; + +			if ($subset !== '') +			{ +				$subset = '|subset(' . $subset . ')'; +			} + +			$parent = ($parent) ?: 'loops.'; +			// Turn into a Twig for loop +			return "{% for {$name} in {$parent}{$name}{$subset} %}{$body}{% endfor %}"; +		}; + +		return preg_replace_callback('#<!-- BEGIN ((?:[a-zA-Z0-9_]+\.)*)([!a-zA-Z0-9_]+)(\([0-9,\-]+\))? -->(.+?)<!-- END \1\2 -->#s', $callback, $code); +	} + +	/** +	* Fix IF statements +	* +	* @param string $code +	* @return string +	*/ +	protected function fix_if_tokens($code) +	{ +		// Replace ELSE IF with ELSEIF +		$code = preg_replace('#<!-- ELSE IF (.+?) -->#', '<!-- ELSEIF $1 -->', $code); + +		// Replace our "div by" with Twig's divisibleby (Twig does not like test names with spaces) +		$code = preg_replace('# div by ([0-9]+)#', ' divisibleby($1)', $code); + +		$callback = function($matches) +		{ +			$inner = $matches[2]; +			// Replace $TEST with definition.TEST +			$inner = preg_replace('#(\s\(*!?)\$([a-zA-Z_0-9]+)#', '$1definition.$2', $inner); + +			// Replace .foo with loops.foo|length +			$inner = preg_replace('#(\s\(*!?)\.([a-zA-Z_0-9]+)([^a-zA-Z_0-9\.])#', '$1loops.$2|length$3', $inner); + +			// Replace .foo.bar with foo.bar|length +			$inner = preg_replace('#(\s\(*!?)\.([a-zA-Z_0-9\.]+)([^a-zA-Z_0-9\.])#', '$1$2|length$3', $inner); + +			return "<!-- {$matches[1]}IF{$inner}-->"; +		}; + +		return preg_replace_callback('#<!-- (ELSE)?IF((.*?) (?:\(*!?[\$|\.]([^\s]+)(.*?))?)-->#', $callback, $code); +	} + +	/** +	* Fix DEFINE statements and {$VARNAME} variables +	* +	* @param string $code +	* @return string +	*/ +	protected function fix_define_tokens($code) +	{ +		/** +		* Changing $VARNAME to definition.varname because set is only local +		* context (e.g. DEFINE $TEST will only make $TEST available in current +		* template and any child templates, but not any parent templates). +		* +		* DEFINE handles setting it properly to definition in its node, but the +		* variables reading FROM it need to be altered to definition.VARNAME +		* +		* Setting up definition as a class in the array passed to Twig +		* ($context) makes set definition.TEST available in the global context +		*/ + +		// Replace <!-- DEFINE $NAME with {% DEFINE definition.NAME +		$code = preg_replace('#<!-- DEFINE \$(.*?) -->#', '{% DEFINE $1 %}', $code); + +		// Changing UNDEFINE NAME to DEFINE NAME = null to save from creating an extra token parser/node +		$code = preg_replace('#<!-- UNDEFINE \$(.*?)-->#', '{% DEFINE $1= null %}', $code); + +		// Replace all of our variables, {$VARNAME}, with Twig style, {{ definition.VARNAME }} +		$code = preg_replace('#{\$([a-zA-Z0-9_\.]+)}#', '{{ definition.$1 }}', $code); + +		// Replace all of our variables, ~ $VARNAME ~, with Twig style, ~ definition.VARNAME ~ +		$code = preg_replace('#~ \$([a-zA-Z0-9_\.]+) ~#', '~ definition.$1 ~', $code); + +		return $code; +	} + +	/** +	* Replace Twig tag masks with Twig tag calls +	* +	* E.g. <!-- BLOCK foo --> with {% block foo %} +	* +	* @param string $code +	* @param array $twig_tags All tags we want to create a mask for +	* @return string +	*/ +	protected function replace_twig_tag_masks($code, $twig_tags) +	{ +		$callback = function ($matches) +		{ +			$matches[1] = strtolower($matches[1]); + +			return "{% {$matches[1]}{$matches[2]}%}"; +		}; + +		foreach ($twig_tags as &$tag) +		{ +			$tag = strtoupper($tag); +		} + +		// twig_tags is an array of the twig tags, which are all lowercase, but we use all uppercase tags +		$code = preg_replace_callback('#<!-- (' . implode('|', $twig_tags) . ')(.*?)-->#',$callback, $code); + +		return $code; +	} +} diff --git a/phpBB/phpbb/template/twig/loader.php b/phpBB/phpbb/template/twig/loader.php new file mode 100644 index 0000000000..2f8ffaa776 --- /dev/null +++ b/phpBB/phpbb/template/twig/loader.php @@ -0,0 +1,147 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig; + +/** +* Twig Template loader +*/ +class loader extends \Twig_Loader_Filesystem +{ +	protected $safe_directories = array(); + +	/** +	* Set safe directories +	* +	* @param array $directories Array of directories that are safe (empty to clear) +	* @return \Twig_Loader_Filesystem +	*/ +	public function setSafeDirectories($directories = array()) +	{ +		$this->safe_directories = array(); + +		if (!empty($directories)) +		{ +			foreach ($directories as $directory) +			{ +				$this->addSafeDirectory($directory); +			} +		} + +		return $this; +	} + +	/** +	* Add safe directory +	* +	* @param string $directory Directory that should be added +	* @return \Twig_Loader_Filesystem +	*/ +	public function addSafeDirectory($directory) +	{ +		$directory = phpbb_realpath($directory); + +		if ($directory !== false) +		{ +			$this->safe_directories[] = $directory; +		} + +		return $this; +	} + +	/** +	* Get current safe directories +	* +	* @return array +	*/ +	public function getSafeDirectories() +	{ +		return $this->safe_directories; +	} + +	/** +	* Override for parent::validateName() +	* +	* This is done because we added support for safe directories, and when Twig +	*	findTemplate() is called, validateName() is called first, which would +	*	always throw an exception if the file is outside of the configured +	*	template directories. +	*/ +	protected function validateName($name) +	{ +		return; +	} + +	/** +	* Find the template +	* +	* Override for Twig_Loader_Filesystem::findTemplate to add support +	*	for loading from safe directories. +	*/ +	protected function findTemplate($name) +	{ +		$name = (string) $name; + +		// normalize name +		$name = preg_replace('#/{2,}#', '/', strtr($name, '\\', '/')); + +		// If this is in the cache we can skip the entire process below +		//	as it should have already been validated +		if (isset($this->cache[$name])) { +			return $this->cache[$name]; +		} + +		// First, find the template name. The override above of validateName +		//	causes the validateName process to be skipped for this call +		$file = parent::findTemplate($name); + +		try +		{ +			// Try validating the name (which may throw an exception) +			parent::validateName($name); +		} +		catch (\Twig_Error_Loader $e) +		{ +			if (strpos($e->getRawMessage(), 'Looks like you try to load a template outside configured directories') === 0) +			{ +				// Ok, so outside of the configured template directories, we +				//	can now check if we're within a "safe" directory + +				// Find the real path of the directory the file is in +				$directory = phpbb_realpath(dirname($file)); + +				if ($directory === false) +				{ +					// Some sort of error finding the actual path, must throw the exception +					throw $e; +				} + +				foreach ($this->safe_directories as $safe_directory) +				{ +					if (strpos($directory, $safe_directory) === 0) +					{ +						// The directory being loaded is below a directory +						// that is "safe". We're good to load it! +						return $file; +					} +				} +			} + +			// Not within any safe directories +			throw $e; +		} + +		// No exception from validateName, safe to load. +		return $file; +	} +} diff --git a/phpBB/phpbb/template/twig/node/definenode.php b/phpBB/phpbb/template/twig/node/definenode.php new file mode 100644 index 0000000000..695ec4281f --- /dev/null +++ b/phpBB/phpbb/template/twig/node/definenode.php @@ -0,0 +1,57 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @copyright Portions (c) 2009 Fabien Potencier, Armin Ronacher +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\node; + + +class definenode extends \Twig_Node +{ +	public function __construct($capture, \Twig_NodeInterface $name, \Twig_NodeInterface $value, $lineno, $tag = null) +	{ +		parent::__construct(array('name' => $name, 'value' => $value), array('capture' => $capture, 'safe' => false), $lineno, $tag); +	} + +	/** +	* Compiles the node to PHP. +	* +	* @param \Twig_Compiler A Twig_Compiler instance +	*/ +	public function compile(\Twig_Compiler $compiler) +	{ +		$compiler->addDebugInfo($this); + +		if ($this->getAttribute('capture')) { +			$compiler +				->write("ob_start();\n") +				->subcompile($this->getNode('value')) +			; + +			$compiler->write("\$value = ('' === \$value = ob_get_clean()) ? '' : new \Twig_Markup(\$value, \$this->env->getCharset());\n"); +		} +		else +		{ +			$compiler +				->write("\$value = ") +				->subcompile($this->getNode('value')) +				->raw(";\n") +			; +		} + +		$compiler +			->write("\$context['definition']->set('") +			->raw($this->getNode('name')->getAttribute('name')) +			->raw("', \$value);\n") +		; +	} +} diff --git a/phpBB/phpbb/template/twig/node/event.php b/phpBB/phpbb/template/twig/node/event.php new file mode 100644 index 0000000000..8fc4ba4775 --- /dev/null +++ b/phpBB/phpbb/template/twig/node/event.php @@ -0,0 +1,83 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\node; + + +class event extends \Twig_Node +{ +	/** +	* The subdirectory in which all template listener files must be placed +	* @var string +	*/ +	protected $listener_directory = 'event/'; + +	/** @var \Twig_Environment */ +	protected $environment; + +	public function __construct(\Twig_Node_Expression $expr, \phpbb\template\twig\environment $environment, $lineno, $tag = null) +	{ +		$this->environment = $environment; + +		parent::__construct(array('expr' => $expr), array(), $lineno, $tag); +	} + +	/** +	* Compiles the node to PHP. +	* +	* @param \Twig_Compiler A Twig_Compiler instance +	*/ +	public function compile(\Twig_Compiler $compiler) +	{ +		$compiler->addDebugInfo($this); + +		$location = $this->listener_directory . $this->getNode('expr')->getAttribute('name'); + +		foreach ($this->environment->get_phpbb_extensions() as $ext_namespace => $ext_path) +		{ +			$ext_namespace = str_replace('/', '_', $ext_namespace); + +			if (defined('DEBUG')) +			{ +				// If debug mode is enabled, lets check for new/removed EVENT +				//  templates on page load rather than at compile. This is +				//  slower, but makes developing extensions easier (no need to +				//  purge the cache when a new event template file is added) +				$compiler +					->write("if (\$this->env->getLoader()->exists('@{$ext_namespace}/{$location}.html')) {\n") +					->indent() +				; +			} + +			if (defined('DEBUG') || $this->environment->getLoader()->exists('@' . $ext_namespace . '/' . $location . '.html')) +			{ +				$compiler +					->write("\$previous_look_up_order = \$this->env->getNamespaceLookUpOrder();\n") + +					// We set the namespace lookup order to be this extension first, then the main path +					->write("\$this->env->setNamespaceLookUpOrder(array('{$ext_namespace}', '__main__'));\n") +					->write("\$this->env->loadTemplate('@{$ext_namespace}/{$location}.html')->display(\$context);\n") +					->write("\$this->env->setNamespaceLookUpOrder(\$previous_look_up_order);\n") +				; +			} + +			if (defined('DEBUG')) +			{ +				$compiler +					->outdent() +					->write("}\n\n") +				; +			} +		} +	} +} diff --git a/phpBB/phpbb/template/twig/node/expression/binary/equalequal.php b/phpBB/phpbb/template/twig/node/expression/binary/equalequal.php new file mode 100644 index 0000000000..8c7f7b378d --- /dev/null +++ b/phpBB/phpbb/template/twig/node/expression/binary/equalequal.php @@ -0,0 +1,23 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\node\expression\binary; + + +class equalequal extends \Twig_Node_Expression_Binary +{ +	public function operator(\Twig_Compiler $compiler) +	{ +		return $compiler->raw('==='); +	} +} diff --git a/phpBB/phpbb/template/twig/node/expression/binary/notequalequal.php b/phpBB/phpbb/template/twig/node/expression/binary/notequalequal.php new file mode 100644 index 0000000000..2e95c68090 --- /dev/null +++ b/phpBB/phpbb/template/twig/node/expression/binary/notequalequal.php @@ -0,0 +1,23 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\node\expression\binary; + + +class notequalequal extends \Twig_Node_Expression_Binary +{ +	public function operator(\Twig_Compiler $compiler) +	{ +		return $compiler->raw('!=='); +	} +} diff --git a/phpBB/phpbb/template/twig/node/includeasset.php b/phpBB/phpbb/template/twig/node/includeasset.php new file mode 100644 index 0000000000..15195a226b --- /dev/null +++ b/phpBB/phpbb/template/twig/node/includeasset.php @@ -0,0 +1,81 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\node; + +abstract class includeasset extends \Twig_Node +{ +	/** @var \Twig_Environment */ +	protected $environment; + +	public function __construct(\Twig_Node_Expression $expr, \phpbb\template\twig\environment $environment, $lineno, $tag = null) +	{ +		$this->environment = $environment; + +		parent::__construct(array('expr' => $expr), array(), $lineno, $tag); +	} +	/** +	* Compiles the node to PHP. +	* +	* @param \Twig_Compiler A Twig_Compiler instance +	*/ +	public function compile(\Twig_Compiler $compiler) +	{ +		$compiler->addDebugInfo($this); + +		$config = $this->environment->get_phpbb_config(); + +		$compiler +			->write("\$asset_file = ") +			->subcompile($this->getNode('expr')) +			->raw(";\n") +			->write("\$asset = new \phpbb\\template\\asset(\$asset_file, \$this->getEnvironment()->get_path_helper());\n") +			->write("if (substr(\$asset_file, 0, 2) !== './' && \$asset->is_relative()) {\n") +			->indent() +				->write("\$asset_path = \$asset->get_path();") +				->write("\$local_file = \$this->getEnvironment()->get_phpbb_root_path() . \$asset_path;\n") +				->write("if (!file_exists(\$local_file)) {\n") +				->indent() +					->write("\$local_file = \$this->getEnvironment()->findTemplate(\$asset_path);\n") +					->write("\$asset->set_path(\$local_file, true);\n") +				->outdent() +				->write("\$asset->add_assets_version('{$config['assets_version']}');\n") +				->write("\$asset_file = \$asset->get_url();\n") +				->write("}\n") +			->outdent() +			->write("}\n") +			->write("\$context['definition']->append('{$this->get_definition_name()}', '") +		; + +		$this->append_asset($compiler); + +		$compiler +			->raw("\n');\n") +		; +	} + +	/** +	* Get the definition name +	* +	* @return string (e.g. 'SCRIPTS') +	*/ +	abstract public function get_definition_name(); + +	/** +	* Append the output code for the asset +	* +	* @param \Twig_Compiler A Twig_Compiler instance +	* @return null +	*/ +	abstract protected function append_asset(\Twig_Compiler $compiler); +} diff --git a/phpBB/phpbb/template/twig/node/includecss.php b/phpBB/phpbb/template/twig/node/includecss.php new file mode 100644 index 0000000000..2ce63402aa --- /dev/null +++ b/phpBB/phpbb/template/twig/node/includecss.php @@ -0,0 +1,37 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\node; + +class includecss extends \phpbb\template\twig\node\includeasset +{ +	/** +	* {@inheritdoc} +	*/ +	public function get_definition_name() +	{ +		return 'STYLESHEETS'; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function append_asset(\Twig_Compiler $compiler) +	{ +		$compiler +			->raw("<link href=\"' . ") +			->raw("\$asset_file . '\"") +			->raw(' rel="stylesheet" type="text/css" media="screen, projection" />') +		; +	} +} diff --git a/phpBB/phpbb/template/twig/node/includejs.php b/phpBB/phpbb/template/twig/node/includejs.php new file mode 100644 index 0000000000..0f67f9ff60 --- /dev/null +++ b/phpBB/phpbb/template/twig/node/includejs.php @@ -0,0 +1,39 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\node; + +class includejs extends \phpbb\template\twig\node\includeasset +{ +	/** +	* {@inheritdoc} +	*/ +	public function get_definition_name() +	{ +		return 'SCRIPTS'; +	} + +	/** +	* {@inheritdoc} +	*/ +	protected function append_asset(\Twig_Compiler $compiler) +	{ +		$config = $this->environment->get_phpbb_config(); + +		$compiler +			->raw("<script type=\"text/javascript\" src=\"' . ") +			->raw("\$asset_file") +			->raw(". '\"></script>\n") +		; +	} +} diff --git a/phpBB/phpbb/template/twig/node/includenode.php b/phpBB/phpbb/template/twig/node/includenode.php new file mode 100644 index 0000000000..42428b6106 --- /dev/null +++ b/phpBB/phpbb/template/twig/node/includenode.php @@ -0,0 +1,54 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\node; + + +class includenode extends \Twig_Node_Include +{ +	/** +	* Compiles the node to PHP. +	* +	* @param \Twig_Compiler A Twig_Compiler instance +	*/ +	public function compile(\Twig_Compiler $compiler) +	{ +		$compiler->addDebugInfo($this); + +		$compiler +			->write("\$location = ") +			->subcompile($this->getNode('expr')) +			->raw(";\n") +			->write("\$namespace = false;\n") +			->write("if (strpos(\$location, '@') === 0) {\n") +			->indent() +				->write("\$namespace = substr(\$location, 1, strpos(\$location, '/') - 1);\n") +				->write("\$previous_look_up_order = \$this->env->getNamespaceLookUpOrder();\n") + +				// We set the namespace lookup order to be this namespace first, then the main path +				->write("\$this->env->setNamespaceLookUpOrder(array(\$namespace, '__main__'));\n") +			->outdent() +			->write("}\n") +		; + +		parent::compile($compiler); + +		$compiler +			->write("if (\$namespace) {\n") +			->indent() +				->write("\$this->env->setNamespaceLookUpOrder(\$previous_look_up_order);\n") +			->outdent() +			->write("}\n") +		; +	} +} diff --git a/phpBB/phpbb/template/twig/node/includephp.php b/phpBB/phpbb/template/twig/node/includephp.php new file mode 100644 index 0000000000..826617e8e8 --- /dev/null +++ b/phpBB/phpbb/template/twig/node/includephp.php @@ -0,0 +1,90 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* Sections (c) 2009 Fabien Potencier, Armin Ronacher +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\node; + + +class includephp extends \Twig_Node +{ +	/** @var \Twig_Environment */ +	protected $environment; + +	public function __construct(\Twig_Node_Expression $expr, \phpbb\template\twig\environment $environment, $lineno, $ignoreMissing = false, $tag = null) +	{ +		$this->environment = $environment; + +		parent::__construct(array('expr' => $expr), array('ignore_missing' => (Boolean) $ignoreMissing), $lineno, $tag); +	} + +	/** +	* Compiles the node to PHP. +	* +	* @param \Twig_Compiler A Twig_Compiler instance +	*/ +	public function compile(\Twig_Compiler $compiler) +	{ +		$compiler->addDebugInfo($this); + +		$config = $this->environment->get_phpbb_config(); + +		if (!$config['tpl_allow_php']) +		{ +			$compiler +				->write("// INCLUDEPHP Disabled\n") +			; + +			return; +		} + +		if ($this->getAttribute('ignore_missing')) { +			$compiler +				->write("try {\n") +				->indent() +			; +		} + +		$compiler +			->write("\$location = ") +			->subcompile($this->getNode('expr')) +			->raw(";\n") +			->write("if (phpbb_is_absolute(\$location)) {\n") +			->indent() +				// Absolute path specified +				->write("require(\$location);\n") +			->outdent() +			->write("} else if (file_exists(\$this->getEnvironment()->get_phpbb_root_path() . \$location)) {\n") +			->indent() +				// PHP file relative to phpbb_root_path +				->write("require(\$this->getEnvironment()->get_phpbb_root_path() . \$location);\n") +			->outdent() +			->write("} else {\n") +			->indent() +				// Local path (behaves like INCLUDE) +				->write("require(\$this->getEnvironment()->getLoader()->getCacheKey(\$location));\n") +			->outdent() +			->write("}\n") +		; + +		if ($this->getAttribute('ignore_missing')) { +			$compiler +				->outdent() +				->write("} catch (\Twig_Error_Loader \$e) {\n") +				->indent() +				->write("// ignore missing template\n") +				->outdent() +				->write("}\n\n") +			; +		} +	} +} diff --git a/phpBB/phpbb/template/twig/node/php.php b/phpBB/phpbb/template/twig/node/php.php new file mode 100644 index 0000000000..3a24513dca --- /dev/null +++ b/phpBB/phpbb/template/twig/node/php.php @@ -0,0 +1,53 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\node; + + +class php extends \Twig_Node +{ +	/** @var \Twig_Environment */ +	protected $environment; + +	public function __construct(\Twig_Node_Text $text, \phpbb\template\twig\environment $environment, $lineno, $tag = null) +	{ +		$this->environment = $environment; + +		parent::__construct(array('text' => $text), array(), $lineno, $tag); +	} + +	/** +	* Compiles the node to PHP. +	* +	* @param \Twig_Compiler A Twig_Compiler instance +	*/ +	public function compile(\Twig_Compiler $compiler) +	{ +		$compiler->addDebugInfo($this); + +		$config = $this->environment->get_phpbb_config(); + +		if (!$config['tpl_allow_php']) +		{ +			$compiler +				->write("// PHP Disabled\n") +			; + +			return; +		} + +		$compiler +			->raw($this->getNode('text')->getAttribute('data')) +		; +	} +} diff --git a/phpBB/phpbb/template/twig/tokenparser/defineparser.php b/phpBB/phpbb/template/twig/tokenparser/defineparser.php new file mode 100644 index 0000000000..cfee84a363 --- /dev/null +++ b/phpBB/phpbb/template/twig/tokenparser/defineparser.php @@ -0,0 +1,74 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @copyright Portions (c) 2009 Fabien Potencier, Armin Ronacher +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\tokenparser; + + +class defineparser extends \Twig_TokenParser +{ +	/** +	* Parses a token and returns a node. +	* +	* @param \Twig_Token $token A Twig_Token instance +	* +	* @return \Twig_NodeInterface A Twig_NodeInterface instance +	* @throws \Twig_Error_Syntax +	* @throws \phpbb\template\twig\node\definenode +	*/ +	public function parse(\Twig_Token $token) +	{ +		$lineno = $token->getLine(); +		$stream = $this->parser->getStream(); +		$name = $this->parser->getExpressionParser()->parseExpression(); + +		$capture = false; +		if ($stream->test(\Twig_Token::OPERATOR_TYPE, '=')) { +			$stream->next(); +			$value = $this->parser->getExpressionParser()->parseExpression(); + +			if ($value instanceof \Twig_Node_Expression_Name) +			{ +				// This would happen if someone improperly formed their DEFINE syntax +				// e.g. <!-- DEFINE $VAR = foo --> +				throw new \Twig_Error_Syntax('Invalid DEFINE', $token->getLine(), $this->parser->getFilename()); +			} + +			$stream->expect(\Twig_Token::BLOCK_END_TYPE); +		} else { +			$capture = true; + +			$stream->expect(\Twig_Token::BLOCK_END_TYPE); + +			$value = $this->parser->subparse(array($this, 'decideBlockEnd'), true); +			$stream->expect(\Twig_Token::BLOCK_END_TYPE); +		} + +		return new \phpbb\template\twig\node\definenode($capture, $name, $value, $lineno, $this->getTag()); +	} + +	public function decideBlockEnd(\Twig_Token $token) +	{ +		return $token->test('ENDDEFINE'); +	} + +	/** +	* Gets the tag name associated with this token parser. +	* +	* @return string The tag name +	*/ +	public function getTag() +	{ +		return 'DEFINE'; +	} +} diff --git a/phpBB/phpbb/template/twig/tokenparser/event.php b/phpBB/phpbb/template/twig/tokenparser/event.php new file mode 100644 index 0000000000..4c7c8e07d9 --- /dev/null +++ b/phpBB/phpbb/template/twig/tokenparser/event.php @@ -0,0 +1,45 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\tokenparser; + + +class event extends \Twig_TokenParser +{ +	/** +	* Parses a token and returns a node. +	* +	* @param \Twig_Token $token A Twig_Token instance +	* +	* @return \Twig_NodeInterface A Twig_NodeInterface instance +	*/ +	public function parse(\Twig_Token $token) +	{ +		$expr = $this->parser->getExpressionParser()->parseExpression(); + +		$stream = $this->parser->getStream(); +		$stream->expect(\Twig_Token::BLOCK_END_TYPE); + +		return new \phpbb\template\twig\node\event($expr, $this->parser->getEnvironment(), $token->getLine(), $this->getTag()); +	} + +	/** +	* Gets the tag name associated with this token parser. +	* +	* @return string The tag name +	*/ +	public function getTag() +	{ +		return 'EVENT'; +	} +} diff --git a/phpBB/phpbb/template/twig/tokenparser/includecss.php b/phpBB/phpbb/template/twig/tokenparser/includecss.php new file mode 100644 index 0000000000..1f30811754 --- /dev/null +++ b/phpBB/phpbb/template/twig/tokenparser/includecss.php @@ -0,0 +1,44 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\tokenparser; + +class includecss extends \Twig_TokenParser +{ +	/** +	* Parses a token and returns a node. +	* +	* @param \Twig_Token $token A Twig_Token instance +	* +	* @return \Twig_NodeInterface A Twig_NodeInterface instance +	*/ +	public function parse(\Twig_Token $token) +	{ +		$expr = $this->parser->getExpressionParser()->parseExpression(); + +		$stream = $this->parser->getStream(); +		$stream->expect(\Twig_Token::BLOCK_END_TYPE); + +		return new \phpbb\template\twig\node\includecss($expr, $this->parser->getEnvironment(), $token->getLine(), $this->getTag()); +	} + +	/** +	* Gets the tag name associated with this token parser. +	* +	* @return string The tag name +	*/ +	public function getTag() +	{ +		return 'INCLUDECSS'; +	} +} diff --git a/phpBB/phpbb/template/twig/tokenparser/includejs.php b/phpBB/phpbb/template/twig/tokenparser/includejs.php new file mode 100644 index 0000000000..4156048e42 --- /dev/null +++ b/phpBB/phpbb/template/twig/tokenparser/includejs.php @@ -0,0 +1,45 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\tokenparser; + + +class includejs extends \Twig_TokenParser +{ +	/** +	* Parses a token and returns a node. +	* +	* @param \Twig_Token $token A Twig_Token instance +	* +	* @return \Twig_NodeInterface A Twig_NodeInterface instance +	*/ +	public function parse(\Twig_Token $token) +	{ +		$expr = $this->parser->getExpressionParser()->parseExpression(); + +		$stream = $this->parser->getStream(); +		$stream->expect(\Twig_Token::BLOCK_END_TYPE); + +		return new \phpbb\template\twig\node\includejs($expr, $this->parser->getEnvironment(), $token->getLine(), $this->getTag()); +	} + +	/** +	* Gets the tag name associated with this token parser. +	* +	* @return string The tag name +	*/ +	public function getTag() +	{ +		return 'INCLUDEJS'; +	} +} diff --git a/phpBB/phpbb/template/twig/tokenparser/includeparser.php b/phpBB/phpbb/template/twig/tokenparser/includeparser.php new file mode 100644 index 0000000000..6ee78e5562 --- /dev/null +++ b/phpBB/phpbb/template/twig/tokenparser/includeparser.php @@ -0,0 +1,45 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @copyright Portions (c) 2009 Fabien Potencier, Armin Ronacher +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\tokenparser; + + +class includeparser extends \Twig_TokenParser_Include +{ +	/** +	* Parses a token and returns a node. +	* +	* @param \Twig_Token $token A Twig_Token instance +	* +	* @return \Twig_NodeInterface A Twig_NodeInterface instance +	*/ +	public function parse(\Twig_Token $token) +	{ +		$expr = $this->parser->getExpressionParser()->parseExpression(); + +		list($variables, $only, $ignoreMissing) = $this->parseArguments(); + +		return new \phpbb\template\twig\node\includenode($expr, $variables, $only, $ignoreMissing, $token->getLine(), $this->getTag()); +	} + +	/** +	* Gets the tag name associated with this token parser. +	* +	* @return string The tag name +	*/ +	public function getTag() +	{ +		return 'INCLUDE'; +	} +} diff --git a/phpBB/phpbb/template/twig/tokenparser/includephp.php b/phpBB/phpbb/template/twig/tokenparser/includephp.php new file mode 100644 index 0000000000..38196c5290 --- /dev/null +++ b/phpBB/phpbb/template/twig/tokenparser/includephp.php @@ -0,0 +1,55 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @copyright Portions (c) 2009 Fabien Potencier, Armin Ronacher +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\tokenparser; + + +class includephp extends \Twig_TokenParser +{ +	/** +	* Parses a token and returns a node. +	* +	* @param \Twig_Token $token A Twig_Token instance +	* +	* @return \Twig_NodeInterface A Twig_NodeInterface instance +	*/ +	public function parse(\Twig_Token $token) +	{ +		$expr = $this->parser->getExpressionParser()->parseExpression(); + +		$stream = $this->parser->getStream(); + +		$ignoreMissing = false; +		if ($stream->test(\Twig_Token::NAME_TYPE, 'ignore')) { +			$stream->next(); +			$stream->expect(\Twig_Token::NAME_TYPE, 'missing'); + +			$ignoreMissing = true; +		} + +		$stream->expect(\Twig_Token::BLOCK_END_TYPE); + +		return new \phpbb\template\twig\node\includephp($expr, $this->parser->getEnvironment(), $token->getLine(), $ignoreMissing, $this->getTag()); +	} + +	/** +	* Gets the tag name associated with this token parser. +	* +	* @return string The tag name +	*/ +	public function getTag() +	{ +		return 'INCLUDEPHP'; +	} +} diff --git a/phpBB/phpbb/template/twig/tokenparser/php.php b/phpBB/phpbb/template/twig/tokenparser/php.php new file mode 100644 index 0000000000..557a70cca1 --- /dev/null +++ b/phpBB/phpbb/template/twig/tokenparser/php.php @@ -0,0 +1,53 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig\tokenparser; + + +class php extends \Twig_TokenParser +{ +	/** +	* Parses a token and returns a node. +	* +	* @param \Twig_Token $token A Twig_Token instance +	* +	* @return \Twig_NodeInterface A Twig_NodeInterface instance +	*/ +	public function parse(\Twig_Token $token) +	{ +		$stream = $this->parser->getStream(); + +		$stream->expect(\Twig_Token::BLOCK_END_TYPE); + +		$body = $this->parser->subparse(array($this, 'decideEnd'), true); + +		$stream->expect(\Twig_Token::BLOCK_END_TYPE); + +		return new \phpbb\template\twig\node\php($body, $this->parser->getEnvironment(), $token->getLine(), $this->getTag()); +	} + +	public function decideEnd(\Twig_Token $token) +	{ +		return $token->test('ENDPHP'); +	} + +	/** +	* Gets the tag name associated with this token parser. +	* +	* @return string The tag name +	*/ +	public function getTag() +	{ +		return 'PHP'; +	} +} diff --git a/phpBB/phpbb/template/twig/twig.php b/phpBB/phpbb/template/twig/twig.php new file mode 100644 index 0000000000..a3b002f350 --- /dev/null +++ b/phpBB/phpbb/template/twig/twig.php @@ -0,0 +1,360 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\template\twig; + +/** +* Twig Template class. +*/ +class twig extends \phpbb\template\base +{ +	/** +	* Path of the cache directory for the template +	* +	* Cannot be changed during runtime. +	* +	* @var string +	*/ +	private $cachepath = ''; + +	/** +	* phpBB path helper +	* @var \phpbb\path_helper +	*/ +	protected $path_helper; + +	/** +	* phpBB root path +	* @var string +	*/ +	protected $phpbb_root_path; + +	/** +	* PHP file extension +	* @var string +	*/ +	protected $php_ext; + +	/** +	* phpBB config instance +	* @var \phpbb\config\config +	*/ +	protected $config; + +	/** +	* Current user +	* @var \phpbb\user +	*/ +	protected $user; + +	/** +	* Extension manager. +	* +	* @var \phpbb\extension\manager +	*/ +	protected $extension_manager; + +	/** +	* Twig Environment +	* +	* @var \Twig_Environment +	*/ +	protected $twig; + +	/** +	* Constructor. +	* +	* @param \phpbb\path_helper $path_helper +	* @param \phpbb\config\config $config +	* @param \phpbb\user $user +	* @param \phpbb\template\context $context template context +	* @param \phpbb\extension\manager $extension_manager extension manager, if null then template events will not be invoked +	*/ +	public function __construct(\phpbb\path_helper $path_helper, $config, $user, \phpbb\template\context $context, \phpbb\extension\manager $extension_manager = null) +	{ +		$this->path_helper = $path_helper; +		$this->phpbb_root_path = $path_helper->get_phpbb_root_path(); +		$this->php_ext = $path_helper->get_php_ext(); +		$this->config = $config; +		$this->user = $user; +		$this->context = $context; +		$this->extension_manager = $extension_manager; + +		$this->cachepath = $this->phpbb_root_path . 'cache/twig/'; + +		// Initiate the loader, __main__ namespace paths will be setup later in set_style_names() +		$loader = new \phpbb\template\twig\loader(''); + +		$this->twig = new \phpbb\template\twig\environment( +			$this->config, +			$this->path_helper, +			$this->extension_manager, +			$loader, +			array( +				'cache'			=> (defined('IN_INSTALL')) ? false : $this->cachepath, +				'debug'			=> defined('DEBUG'), +				'auto_reload'	=> (bool) $this->config['load_tplcompile'], +				'autoescape'	=> false, +			) +		); + +		$this->twig->addExtension( +			new \phpbb\template\twig\extension( +				$this->context, +				$this->user +			) +		); + +		$lexer = new \phpbb\template\twig\lexer($this->twig); + +		$this->twig->setLexer($lexer); + +		// Add admin namespace +		if ($this->path_helper->get_adm_relative_path() !== null && is_dir($this->phpbb_root_path . $this->path_helper->get_adm_relative_path() . 'style/')) +		{ +			$this->twig->getLoader()->setPaths($this->phpbb_root_path . $this->path_helper->get_adm_relative_path() . 'style/', 'admin'); +		} +	} + +	/** +	* Clear the cache +	* +	* @return \phpbb\template\template +	*/ +	public function clear_cache() +	{ +		if (is_dir($this->cachepath)) +		{ +			$this->twig->clearCacheFiles(); +		} + +		return $this; +	} + +	/** +	* Get the style tree of the style preferred by the current user +	* +	* @return array Style tree, most specific first +	*/ +	public function get_user_style() +	{ +		$style_list = array( +			$this->user->style['style_path'], +		); + +		if ($this->user->style['style_parent_id']) +		{ +			$style_list = array_merge($style_list, array_reverse(explode('/', $this->user->style['style_parent_tree']))); +		} + +		return $style_list; +	} + +	/** +	* Set style location based on (current) user's chosen style. +	* +	* @param array $style_directories The directories to add style paths for +	* 	E.g. array('ext/foo/bar/styles', 'styles') +	* 	Default: array('styles') (phpBB's style directory) +	* @return \phpbb\template\template $this +	*/ +	public function set_style($style_directories = array('styles')) +	{ +		if ($style_directories !== array('styles') && $this->twig->getLoader()->getPaths('core') === array()) +		{ +			// We should set up the core styles path since not already setup +			$this->set_style(); +		} + +		$names = $this->get_user_style(); +		// Add 'all' folder to $names array +		//	It allows extensions to load a template file from 'all' folder, +		//	if a style doesn't include it. +		$names[] = 'all'; + +		$paths = array(); +		foreach ($style_directories as $directory) +		{ +			foreach ($names as $name) +			{ +				$path = $this->phpbb_root_path . trim($directory, '/') . "/{$name}/"; +				$template_path = $path . 'template/'; + +				if (is_dir($template_path)) +				{ +					// Add the base style directory as a safe directory +					$this->twig->getLoader()->addSafeDirectory($path); + +					$paths[] = $template_path; +				} +			} +		} + +		// If we're setting up the main phpBB styles directory and the core +		// namespace isn't setup yet, we will set it up now +		if ($style_directories === array('styles') && $this->twig->getLoader()->getPaths('core') === array()) +		{ +			// Set up the core style paths namespace +			$this->twig->getLoader()->setPaths($paths, 'core'); +		} + +		$this->set_custom_style($names, $paths); + +		return $this; +	} + +	/** +	* Set custom style location (able to use directory outside of phpBB). +	* +	* Note: Templates are still compiled to phpBB's cache directory. +	* +	* @param string|array $names Array of names (or detailed names) or string of name of template(s) in inheritance tree order, used by extensions. +	*	E.g. array( +	*			'name' 		=> 'adm', +	*			'ext_path' 	=> 'adm/style/', +	*		) +	* @param string|array of string $paths Array of style paths, relative to current root directory +	* @return \phpbb\template\template $this +	*/ +	public function set_custom_style($names, $paths) +	{ +		$paths = (is_string($paths)) ? array($paths) : $paths; +		$names = (is_string($names)) ? array($names) : $names; + +		// Set as __main__ namespace +		$this->twig->getLoader()->setPaths($paths); + +		// Add all namespaces for all extensions +		if ($this->extension_manager instanceof \phpbb\extension\manager) +		{ +			$names[] = 'all'; + +			foreach ($this->extension_manager->all_enabled() as $ext_namespace => $ext_path) +			{ +				// namespaces cannot contain / +				$namespace = str_replace('/', '_', $ext_namespace); +				$paths = array(); + +				foreach ($names as $template_dir) +				{ +					if (is_array($template_dir)) +					{ +						if (isset($template_dir['ext_path'])) +						{ +							$ext_style_template_path = $ext_path . $template_dir['ext_path']; +							$ext_style_path = dirname($ext_style_template_path); +						} +						else +						{ +							$ext_style_path = $ext_path . 'styles/' . $template_dir['name'] . '/'; +							$ext_style_template_path = $ext_style_path . 'template/'; +						} +					} +					else +					{ +						$ext_style_path = $ext_path . 'styles/' . $template_dir . '/'; +						$ext_style_template_path = $ext_style_path . 'template/'; +					} + +					if (is_dir($ext_style_template_path)) +					{ +						// Add the base style directory as a safe directory +						$this->twig->getLoader()->addSafeDirectory($ext_style_path); + +						$paths[] = $ext_style_template_path; +					} +				} + +				$this->twig->getLoader()->setPaths($paths, $namespace); +			} +		} + +		return $this; +	} + +	/** +	* Display a template for provided handle. +	* +	* The template will be loaded and compiled, if necessary, first. +	* +	* This function calls hooks. +	* +	* @param string $handle Handle to display +	* @return \phpbb\template\template $this +	*/ +	public function display($handle) +	{ +		$result = $this->call_hook($handle, __FUNCTION__); +		if ($result !== false) +		{ +			return $result[0]; +		} + +		$this->twig->display($this->get_filename_from_handle($handle), $this->get_template_vars()); + +		return $this; +	} + +	/** +	* Display the handle and assign the output to a template variable +	* or return the compiled result. +	* +	* @param string $handle Handle to operate on +	* @param string $template_var Template variable to assign compiled handle to +	* @param bool $return_content If true return compiled handle, otherwise assign to $template_var +	* @return \phpbb\template\template|string if $return_content is true return string of the compiled handle, otherwise return $this +	*/ +	public function assign_display($handle, $template_var = '', $return_content = true) +	{ +		if ($return_content) +		{ +			return $this->twig->render($this->get_filename_from_handle($handle), $this->get_template_vars()); +		} + +		$this->assign_var($template_var, $this->twig->render($this->get_filename_from_handle($handle, $this->get_template_vars()))); + +		return $this; +	} + +	/** +	* Get template vars in a format Twig will use (from the context) +	* +	* @return array +	*/ +	protected function get_template_vars() +	{ +		$context_vars = $this->context->get_data_ref(); + +		$vars = array_merge( +			$context_vars['.'][0], // To get normal vars +			array( +				'definition'	=> new \phpbb\template\twig\definition(), +				'user'			=> $this->user, +				'loops'			=> $context_vars, // To get loops +			) +		); + +		// cleanup +		unset($vars['loops']['.']); + +		return $vars; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_source_file_for_handle($handle) +	{ +		return $this->twig->getLoader()->getCacheKey($this->get_filename_from_handle($handle)); +	} +} | 
