1 files changed, 115 insertions, 237 deletions
diff --git a/phpBB/phpbb/template/twig/twig.php b/phpBB/phpbb/template/twig/twig.php
index 92a37d1634..9df9310427 100644
--- a/phpBB/phpbb/template/twig/twig.php
+++ b/phpBB/phpbb/template/twig/twig.php
@@ -7,6 +7,8 @@
 *
 */
 
+namespace phpbb\template\twig;
+
 /**
 * @ignore
 */
@@ -19,16 +21,9 @@ if (!defined('IN_PHPBB'))
 * Twig Template class.
 * @package phpBB3
 */
-class phpbb_template_twig implements phpbb_template
+class twig extends \phpbb\template\base
 {
 	/**
-	* Template context.
-	* Stores template data used during template rendering.
-	* @var phpbb_template_context
-	*/
-	protected $context;
-
-	/**
 	* Path of the cache directory for the template
 	*
 	* Cannot be changed during runtime.
@@ -38,16 +33,16 @@ class phpbb_template_twig implements phpbb_template
 	private $cachepath = '';
 
 	/**
-	* phpBB root path
-	* @var string
+	* phpBB path helper
+	* @var \phpbb\path_helper
 	*/
-	protected $phpbb_root_path;
+	protected $path_helper;
 
 	/**
-	* adm relative path
+	* phpBB root path
 	* @var string
 	*/
-	protected $adm_relative_path;
+	protected $phpbb_root_path;
 
 	/**
 	* PHP file extension
@@ -57,34 +52,24 @@ class phpbb_template_twig implements phpbb_template
 
 	/**
 	* phpBB config instance
-	* @var phpbb_config
+	* @var \phpbb\config\config
 	*/
 	protected $config;
 
 	/**
 	* Current user
-	* @var phpbb_user
+	* @var \phpbb\user
 	*/
 	protected $user;
 
 	/**
 	* Extension manager.
 	*
-	* @var phpbb_extension_manager
+	* @var \phpbb\extension\manager
 	*/
 	protected $extension_manager;
 
 	/**
-	* Name of the style that the template being compiled and/or rendered
-	* belongs to, and its parents, in inheritance tree order.
-	*
-	* Used to invoke style-specific template events.
-	*
-	* @var array
-	*/
-	protected $style_names;
-
-	/**
 	* Twig Environment
 	*
 	* @var Twig_Environment
@@ -92,42 +77,33 @@ class phpbb_template_twig implements phpbb_template
 	protected $twig;
 
 	/**
-	* Array of filenames assigned to set_filenames
-	*
-	* @var array
-	*/
-	protected $filenames = array();
-
-	/**
 	* Constructor.
 	*
-	* @param string $phpbb_root_path phpBB root path
-	* @param string $php_ext php extension (typically 'php')
-	* @param phpbb_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
-	* @param string $adm_relative_path relative path to adm directory
+	* @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_root_path, $php_ext, $config, $user, phpbb_template_context $context, phpbb_extension_manager $extension_manager = null, $adm_relative_path = null)
+	public function __construct(\phpbb\path_helper $path_helper, $config, $user, \phpbb\template\context $context, \phpbb\extension\manager $extension_manager = null)
 	{
-		$this->phpbb_root_path = $phpbb_root_path;
-		$this->adm_relative_path = $adm_relative_path;
-		$this->php_ext = $php_ext;
+		$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 = $phpbb_root_path . 'cache/twig/';
+		$this->cachepath = $this->phpbb_root_path . 'cache/twig/';
 
 		// Initiate the loader, __main__ namespace paths will be setup later in set_style_names()
-		$loader = new Twig_Loader_Filesystem('');
+		$loader = new \phpbb\template\twig\loader('');
 
-		$this->twig = new phpbb_template_twig_environment(
+		$this->twig = new \phpbb\template\twig\environment(
 			$this->config,
 			($this->extension_manager) ? $this->extension_manager->all_enabled() : array(),
-			$this->phpbb_root_path,
+			$this->path_helper,
 			$loader,
 			array(
 				'cache'			=> (defined('IN_INSTALL')) ? false : $this->cachepath,
@@ -138,21 +114,27 @@ class phpbb_template_twig implements phpbb_template
 		);
 
 		$this->twig->addExtension(
-			new phpbb_template_twig_extension(
+			new \phpbb\template\twig\extension(
 				$this->context,
 				$this->user
 			)
 		);
 
-		$lexer = new phpbb_template_twig_lexer($this->twig);
+		$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
+	* @return \phpbb\template\template
 	*/
 	public function clear_cache()
 	{
@@ -165,51 +147,94 @@ class phpbb_template_twig implements phpbb_template
 	}
 
 	/**
-	* Sets the template filenames for handles.
+	* Get the style tree of the style preferred by the current user
 	*
-	* @param array $filename_array Should be a hash of handle => filename pairs.
-	* @return phpbb_template $this
+	* @return array Style tree, most specific first
 	*/
-	public function set_filenames(array $filename_array)
+	public function get_user_style()
 	{
-		$this->filenames = array_merge($this->filenames, $filename_array);
+		$style_list = array(
+			$this->user->style['style_path'],
+		);
 
-		return $this;
+		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;
 	}
 
 	/**
-	* Sets the style names/paths corresponding to style hierarchy being compiled
-	* and/or rendered.
+	* Set style location based on (current) user's chosen style.
 	*
-	* @param array $style_names List of style names in inheritance tree order
-	* @param array $style_paths List of style paths in inheritance tree order
-	* @param bool $is_core True if the style names are the "core" styles for this page load
-	* 	Core means the main phpBB template files
-	* @return phpbb_template $this
+	* @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_names(array $style_names, array $style_paths, $is_core = false)
+	public function set_style($style_directories = array('styles'))
 	{
-		$this->style_names = $style_names;
+		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();
+		}
 
-		// Set as __main__ namespace
-		$this->twig->getLoader()->setPaths($style_paths);
+		$names = $this->get_user_style();
 
-		// Core style namespace from phpbb_style::set_style()
-		if ($is_core)
+		$paths = array();
+		foreach ($style_directories as $directory)
 		{
-			$this->twig->getLoader()->setPaths($style_paths, 'core');
+			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;
+				}
+			}
 		}
 
-		// Add admin namespace
-		if (is_dir($this->phpbb_root_path . $this->adm_relative_path . 'style/'))
+		// 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())
 		{
-			$this->twig->getLoader()->setPaths($this->phpbb_root_path . $this->adm_relative_path . 'style/', 'admin');
+			// 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 string of name of template(s) in inheritance tree order, used by extensions.
+	* @param string|array or string $paths Array of style paths, relative to current root directory
+	* @return phpbb_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)
+		if ($this->extension_manager instanceof \phpbb\extension\manager)
 		{
-			$style_names[] = 'all';
+			$names[] = 'all';
 
 			foreach ($this->extension_manager->all_enabled() as $ext_namespace => $ext_path)
 			{
@@ -217,13 +242,17 @@ class phpbb_template_twig implements phpbb_template
 				$namespace = str_replace('/', '_', $ext_namespace);
 				$paths = array();
 
-				foreach ($style_names as $style_name)
+				foreach ($names as $style_name)
 				{
-					$ext_style_path = $ext_path . 'styles/' . $style_name . '/template';
+					$ext_style_path = $ext_path . 'styles/' . $style_name . '/';
+					$ext_style_template_path = $ext_style_path . 'template/';
 
-					if (is_dir($ext_style_path))
+					if (is_dir($ext_style_template_path))
 					{
-						$paths[] = $ext_style_path;
+						// Add the base style directory as a safe directory
+						$this->twig->getLoader()->addSafeDirectory($ext_style_path);
+
+						$paths[] = $ext_style_template_path;
 					}
 				}
 
@@ -235,31 +264,6 @@ class phpbb_template_twig implements phpbb_template
 	}
 
 	/**
-	* Clears all variables and blocks assigned to this template.
-	*
-	* @return phpbb_template $this
-	*/
-	public function destroy()
-	{
-		$this->context = array();
-
-		return $this;
-	}
-
-	/**
-	* Reset/empty complete block
-	*
-	* @param string $blockname Name of block to destroy
-	* @return phpbb_template $this
-	*/
-	public function destroy_block_vars($blockname)
-	{
-		$this->context->destroy_block_vars($blockname);
-
-		return $this;
-	}
-
-	/**
 	* Display a template for provided handle.
 	*
 	* The template will be loaded and compiled, if necessary, first.
@@ -267,7 +271,7 @@ class phpbb_template_twig implements phpbb_template
 	* This function calls hooks.
 	*
 	* @param string $handle Handle to display
-	* @return phpbb_template $this
+	* @return \phpbb\template\template $this
 	*/
 	public function display($handle)
 	{
@@ -283,35 +287,13 @@ class phpbb_template_twig implements phpbb_template
 	}
 
 	/**
-	* Calls hook if any is defined.
-	*
-	* @param string $handle Template handle being displayed.
-	* @param string $method Method name of the caller.
-	*/
-	protected function call_hook($handle, $method)
-	{
-		global $phpbb_hook;
-
-		if (!empty($phpbb_hook) && $phpbb_hook->call_hook(array(__CLASS__, $method), $handle, $this))
-		{
-			if ($phpbb_hook->hook_return(array(__CLASS__, $method)))
-			{
-				$result = $phpbb_hook->hook_return_result(array(__CLASS__, $method));
-				return array($result);
-			}
-		}
-
-		return false;
-	}
-
-	/**
 	* 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|string if $return_content is true return string of the compiled handle, otherwise return $this
+	* @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)
 	{
@@ -326,134 +308,30 @@ class phpbb_template_twig implements phpbb_template
 	}
 
 	/**
-	* Assign key variable pairs from an array
-	*
-	* @param array $vararray A hash of variable name => value pairs
-	* @return phpbb_template $this
-	*/
-	public function assign_vars(array $vararray)
-	{
-		foreach ($vararray as $key => $val)
-		{
-			$this->assign_var($key, $val);
-		}
-
-		return $this;
-	}
-
-	/**
-	* Assign a single scalar value to a single key.
-	*
-	* Value can be a string, an integer or a boolean.
-	*
-	* @param string $varname Variable name
-	* @param string $varval Value to assign to variable
-	* @return phpbb_template $this
-	*/
-	public function assign_var($varname, $varval)
-	{
-		$this->context->assign_var($varname, $varval);
-
-		return $this;
-	}
-
-	/**
-	* Append text to the string value stored in a key.
-	*
-	* Text is appended using the string concatenation operator (.).
-	*
-	* @param string $varname Variable name
-	* @param string $varval Value to append to variable
-	* @return phpbb_template $this
-	*/
-	public function append_var($varname, $varval)
-	{
-		$this->context->append_var($varname, $varval);
-
-		return $this;
-	}
-
-	/**
-	* Assign key variable pairs from an array to a specified block
-	* @param string $blockname Name of block to assign $vararray to
-	* @param array $vararray A hash of variable name => value pairs
-	* @return phpbb_template $this
-	*/
-	public function assign_block_vars($blockname, array $vararray)
-	{
-		$this->context->assign_block_vars($blockname, $vararray);
-
-		return $this;
-	}
-
-	/**
-	* Change already assigned key variable pair (one-dimensional - single loop entry)
-	*
-	* An example of how to use this function:
-	* {@example alter_block_array.php}
-	*
-	* @param	string	$blockname	the blockname, for example 'loop'
-	* @param	array	$vararray	the var array to insert/add or merge
-	* @param	mixed	$key		Key to search for
-	*
-	* array: KEY => VALUE [the key/value pair to search for within the loop to determine the correct position]
-	*
-	* int: Position [the position to change or insert at directly given]
-	*
-	* If key is false the position is set to 0
-	* If key is true the position is set to the last entry
-	*
-	* @param	string	$mode		Mode to execute (valid modes are 'insert' and 'change')
-	*
-	*	If insert, the vararray is inserted at the given position (position counting from zero).
-	*	If change, the current block gets merged with the vararray (resulting in new key/value pairs be added and existing keys be replaced by the new value).
-	*
-	* Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)
-	* and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)
-	*
-	* @return bool false on error, true on success
-	*/
-	public function alter_block_array($blockname, array $vararray, $key = false, $mode = 'insert')
-	{
-		return $this->context->alter_block_array($blockname, $vararray, $key, $mode);
-	}
-
-	/**
 	* Get template vars in a format Twig will use (from the context)
 	*
 	* @return array
 	*/
-	public function get_template_vars()
+	protected function get_template_vars()
 	{
 		$context_vars = $this->context->get_data_ref();
 
 		$vars = array_merge(
 			$context_vars['.'][0], // To get normal vars
-			$context_vars, // To get loops
 			array(
-				'definition'	=> new phpbb_template_twig_definition(),
+				'definition'	=> new \phpbb\template\twig\definition(),
 				'user'			=> $this->user,
+				'loops'			=> $context_vars, // To get loops
 			)
 		);
 
 		// cleanup
-		unset($vars['.']);
+		unset($vars['loops']['.']);
 
 		return $vars;
 	}
 
 	/**
-	* Get a filename from the handle
-	*
-	* @param string $handle
-	* @return string
-	*/
-	protected function get_filename_from_handle($handle)
-	{
-		return (isset($this->filenames[$handle])) ? $this->filenames[$handle] : $handle;
-	}
-
-	/**
 	* Get path to template for handle (required for BBCode parser)
 	*
 	* @return string