3 files changed, 101 insertions, 205 deletions
diff --git a/phpBB/phpbb/template/locator.php b/phpBB/phpbb/template/locator.php
deleted file mode 100644
index f6fd20bcc2..0000000000
--- a/phpBB/phpbb/template/locator.php
+++ /dev/null
@@ -1,163 +0,0 @@
-<?php
-/**
-*
-* @package phpBB3
-* @copyright (c) 2011 phpBB Group
-* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
-*
-*/
-
-/**
-* @ignore
-*/
-if (!defined('IN_PHPBB'))
-{
-	exit;
-}
-
-
-/**
-* Resource locator interface.
-*
-* Objects implementing this interface maintain mapping from template handles
-* to source template file paths and locate templates.
-*
-* Locates style files.
-*
-* Resource locator is aware of styles tree, and can return actual
-* filesystem paths (i.e., the "child" style or the "parent" styles)
-* depending on what files exist.
-*
-* Root paths stored in locator are paths to style directories. Templates are
-* stored in subdirectory that $template_path points to.
-*
-* @package phpBB3
-*/
-interface phpbb_template_locator
-{
-	/**
-	* Sets the template filenames for handles. $filename_array
-	* should be a hash of handle => filename pairs.
-	*
-	* @param array $filename_array Should be a hash of handle => filename pairs.
-	*/
-	public function set_filenames(array $filename_array);
-
-	/**
-	* Determines the filename for a template handle.
-	*
-	* The filename comes from array used in a set_filenames call,
-	* which should have been performed prior to invoking this function.
-	* Return value is a file basename (without path).
-	*
-	* @param $handle string Template handle
-	* @return string Filename corresponding to the template handle
-	*/
-	public function get_filename_for_handle($handle);
-
-	/**
-	* Determines the source file path for a template handle without
-	* regard for styles tree.
-	*
-	* This function returns the path in "primary" style directory
-	* corresponding to the given template handle. That path may or
-	* may not actually exist on the filesystem. Because this function
-	* does not perform stat calls to determine whether the path it
-	* returns actually exists, it is faster than get_source_file_for_handle.
-	*
-	* Use get_source_file_for_handle to obtain the actual path that is
-	* guaranteed to exist (which might come from the parent style
-	* directory if primary style has parent styles).
-	*
-	* This function will trigger an error if the handle was never
-	* associated with a template file via set_filenames.
-	*
-	* @param $handle string Template handle
-	* @return string Path to source file path in primary style directory
-	*/
-	public function get_virtual_source_file_for_handle($handle);
-
-	/**
-	* Determines the source file path for a template handle, accounting
-	* for styles tree and verifying that the path exists.
-	*
-	* This function returns the actual path that may be compiled for
-	* the specified template handle. It will trigger an error if
-	* the template handle was never associated with a template path
-	* via set_filenames or if the template file does not exist on the
-	* filesystem.
-	*
-	* Use get_virtual_source_file_for_handle to just resolve a template
-	* handle to a path without any filesystem or styles tree checks.
-	*
-	* @param string $handle Template handle (i.e. "friendly" template name)
-	* @param bool $find_all If true, each root path will be checked and function
-	*				will return array of files instead of string and will not
-	*				trigger a error if template does not exist
-	* @return string Source file path
-	*/
-	public function get_source_file_for_handle($handle, $find_all = false);
-
-	/**
-	* Obtains a complete filesystem path for a file in a style.
-	*
-	* This function traverses the style tree (selected style and
-	* its parents in order, if inheritance is being used) and finds
-	* the first file on the filesystem matching specified relative path,
-	* or the first of the specified paths if more than one path is given.
-	*
-	* This function can be used to determine filesystem path of any
-	* file under any style, with the consequence being that complete
-	* relative to the style directory path must be provided as an argument.
-	*
-	* In particular, this function can be used to locate templates
-	* and javascript files.
-	*
-	* For locating templates get_first_template_location should be used
-	* as it prepends the configured template path to the template basename.
-	*
-	* Note: "selected style" is whatever style the style resource locator
-	* is configured for.
-	*
-	* The return value then will be a path, relative to the current
-	* directory or absolute, to the first existing file in the selected
-	* style or its closest parent.
-	*
-	* If the selected style does not have the file being searched,
-	* (and if inheritance is involved, none of the parents have it either),
-	* false will be returned.
-	*
-	* Multiple files can be specified, in which case the first file in
-	* the list that can be found on the filesystem is returned.
-	*
-	* If multiple files are specified and inheritance is involved,
-	* first each of the specified files is checked in the selected style,
-	* then each of the specified files is checked in the immediate parent,
-	* etc.
-	*
-	* Specifying true for $return_default will cause the function to
-	* return the first path which was checked for existence in the event
-	* that the template file was not found, instead of false.
-	* This is always a path in the selected style itself, not any of its
-	* parents.
-	*
-	* If $return_full_path is false, then instead of returning a usable
-	* path (when the file is found) the file's path relative to the style
-	* directory will be returned. This is the same path as was given to
-	* the function as a parameter. This can be used to check which of the
-	* files specified in $files exists. Naturally this requires passing
-	* more than one file in $files.
-	*
-	* @param array $files List of files to locate.
-	* @param bool $return_default Determines what to return if file does not
-	*				exist. If true, function will return location where file is
-	*				supposed to be. If false, function will return false.
-	* @param bool $return_full_path If true, function will return full path
-	*				to file. If false, function will return file name. This
-	*				parameter can be used to check which one of set of files
-	*				is available.
-	* @return string or boolean Source file path if file exists or $return_default is
-	*				true. False if file does not exist and $return_default is false
-	*/
-	public function get_first_file_location($files, $return_default = false, $return_full_path = true);
-}
diff --git a/phpBB/phpbb/template/template.php b/phpBB/phpbb/template/template.php
index 89a01e924d..6b9c331a3e 100644
--- a/phpBB/phpbb/template/template.php
+++ b/phpBB/phpbb/template/template.php
@@ -34,14 +34,32 @@ interface phpbb_template
 	public function set_filenames(array $filename_array);
 
 	/**
-	* Sets the style names/paths corresponding to style hierarchy being compiled
-	* and/or rendered.
+	* Get the style tree of the style preferred by the current user
 	*
-	* @param array $style_names List of style names in inheritance tree order
-	* @param array $style_paths List of style paths in inheritance tree order
+	* @return array Style tree, most specific first
+	*/
+	public function get_user_style();
+
+	/**
+	* 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 $this
+	*/
+	public function set_style($style_directories = array('styles'));
+
+	/**
+	* 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_style_names(array $style_names, array $style_paths);
+	public function set_custom_style($names, $paths);
 
 	/**
 	* Clears all variables and blocks assigned to this template.
diff --git a/phpBB/phpbb/template/twig/twig.php b/phpBB/phpbb/template/twig/twig.php
index 6cff1bb8e4..a96bdcbdb9 100644
--- a/phpBB/phpbb/template/twig/twig.php
+++ b/phpBB/phpbb/template/twig/twig.php
@@ -44,12 +44,6 @@ class phpbb_template_twig implements phpbb_template
 	protected $phpbb_root_path;
 
 	/**
-	* adm relative path
-	* @var string
-	*/
-	protected $adm_relative_path;
-
-	/**
 	* PHP file extension
 	* @var string
 	*/
@@ -75,16 +69,6 @@ class phpbb_template_twig implements phpbb_template
 	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
@@ -112,7 +96,6 @@ class phpbb_template_twig implements phpbb_template
 	public function __construct($phpbb_root_path, $php_ext, $config, $user, phpbb_template_context $context, phpbb_extension_manager $extension_manager = null, $adm_relative_path = null)
 	{
 		$this->phpbb_root_path = $phpbb_root_path;
-		$this->adm_relative_path = $adm_relative_path;
 		$this->php_ext = $php_ext;
 		$this->config = $config;
 		$this->user = $user;
@@ -147,6 +130,12 @@ class phpbb_template_twig implements phpbb_template
 		$lexer = new phpbb_template_twig_lexer($this->twig);
 
 		$this->twig->setLexer($lexer);
+
+		// Add admin namespace
+		if ($adm_relative_path !== null && is_dir($this->phpbb_root_path . $adm_relative_path . 'style/'))
+		{
+			$this->twig->getLoader()->setPaths($this->phpbb_root_path . $adm_relative_path . 'style/', 'admin');
+		}
 	}
 
 	/**
@@ -178,38 +167,90 @@ class phpbb_template_twig implements phpbb_template
 	}
 
 	/**
-	* Sets the style names/paths corresponding to style hierarchy being compiled
-	* and/or rendered.
+	* Get the style tree of the style preferred by the current user
 	*
-	* @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 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 $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/";
+
+				if (is_dir($path))
+				{
+					$paths[] = $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)
 		{
-			$style_names[] = 'all';
+			$names[] = 'all';
 
 			foreach ($this->extension_manager->all_enabled() as $ext_namespace => $ext_path)
 			{
@@ -217,7 +258,7 @@ 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';
 
@@ -241,7 +282,7 @@ class phpbb_template_twig implements phpbb_template
 	*/
 	public function destroy()
 	{
-		$this->context = array();
+		$this->context->clear();
 
 		return $this;
 	}
@@ -423,7 +464,7 @@ class phpbb_template_twig implements phpbb_template
 	*
 	* @return array
 	*/
-	public function get_template_vars()
+	protected function get_template_vars()
 	{
 		$context_vars = $this->context->get_data_ref();