Merge branch 'develop' of git://github.com/phpbb/phpbb3 into ticket/11103

author: Nathaniel Guse <nathaniel.guse@gmail.com> 2012-12-12 16:30:50 -0600
committer: Nathaniel Guse <nathaniel.guse@gmail.com> 2012-12-12 16:30:50 -0600
commit: 7ae5b62fc68017b6bdd5e55c9641e92a86a1f487 (patch)
tree: 54e156815f13c40e9b880712de32ae13728ffdae /phpBB
parent: 84284a9ccee7d5ccc658c3d1f751a5254b3b9175 (diff)
parent: 9420647c43b300699afe6fe72f09d1746daf64a2 (diff)
download: forums-7ae5b62fc68017b6bdd5e55c9641e92a86a1f487.tar
forums-7ae5b62fc68017b6bdd5e55c9641e92a86a1f487.tar.gz
forums-7ae5b62fc68017b6bdd5e55c9641e92a86a1f487.tar.bz2
forums-7ae5b62fc68017b6bdd5e55c9641e92a86a1f487.tar.xz
forums-7ae5b62fc68017b6bdd5e55c9641e92a86a1f487.zip
14 files changed, 217 insertions, 24 deletions
diff --git a/phpBB/adm/index.php b/phpBB/adm/index.php
index e20bbe4bec..0f84af6f9e 100644
--- a/phpBB/adm/index.php
+++ b/phpBB/adm/index.php
@@ -52,7 +52,7 @@ $mode			= request_var('mode', '');
 
 // Set custom style for admin area
 $phpbb_style->set_ext_dir_prefix('adm/');
-$phpbb_style->set_custom_style('admin', $phpbb_admin_path . 'style', '');
+$phpbb_style->set_custom_style('admin', $phpbb_admin_path . 'style', array(), '');
 $template->assign_var('T_ASSETS_PATH', $phpbb_root_path . 'assets');
 $template->assign_var('T_TEMPLATE_PATH', $phpbb_admin_path . 'style');
 
diff --git a/phpBB/adm/swatch.php b/phpBB/adm/swatch.php
index 86498a255f..c01651e0f0 100644
--- a/phpBB/adm/swatch.php
+++ b/phpBB/adm/swatch.php
@@ -24,7 +24,7 @@ $user->setup();
 $phpbb_admin_path = (defined('PHPBB_ADMIN_PATH')) ? PHPBB_ADMIN_PATH : './';
 
 // Set custom template for admin area
-$phpbb_style->set_custom_style('admin', $phpbb_admin_path . 'style', '');
+$phpbb_style->set_custom_style('admin', $phpbb_admin_path . 'style', array(), '');
 
 $template->set_filenames(array(
 	'body' => 'colour_swatch.html')
diff --git a/phpBB/config/services.yml b/phpBB/config/services.yml
index 06f098fa71..c3e4ee2128 100644
--- a/phpBB/config/services.yml
+++ b/phpBB/config/services.yml
@@ -195,6 +195,7 @@ services:
             - @user
             - @style.resource_locator
             - @template_context
+            - @ext.manager
 
     template_context:
         class: phpbb_template_context
diff --git a/phpBB/includes/bbcode.php b/phpBB/includes/bbcode.php
index b9ffa8091c..e8681420d4 100644
--- a/phpBB/includes/bbcode.php
+++ b/phpBB/includes/bbcode.php
@@ -134,7 +134,7 @@ class bbcode
 
 			$style_resource_locator = new phpbb_style_resource_locator();
 			$style_path_provider = new phpbb_style_extension_path_provider($phpbb_extension_manager, new phpbb_style_path_provider());
-			$template = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, new phpbb_template_context());
+			$template = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, new phpbb_template_context(), $phpbb_extension_manager);
 			$style = new phpbb_style($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, $style_path_provider, $template);
 			$style->set_style();
 			$template->set_filenames(array('bbcode.html' => 'bbcode.html'));
diff --git a/phpBB/includes/functions_messenger.php b/phpBB/includes/functions_messenger.php
index a18aeddabd..a33d7f0aa3 100644
--- a/phpBB/includes/functions_messenger.php
+++ b/phpBB/includes/functions_messenger.php
@@ -210,7 +210,7 @@ class messenger
 		{
 			$style_resource_locator = new phpbb_style_resource_locator();
 			$style_path_provider = new phpbb_style_extension_path_provider($phpbb_extension_manager, new phpbb_style_path_provider());
-			$tpl = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, new phpbb_template_context());
+			$tpl = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, new phpbb_template_context(), $extension_manager);
 			$style = new phpbb_style($phpbb_root_path, $phpEx, $config, $user, $style_resource_locator, $style_path_provider, $tpl);
 
 			$this->tpl_msg[$template_lang . $template_file] = $tpl;
@@ -231,7 +231,7 @@ class messenger
 				}
 			}
 
-			$style->set_custom_style($template_lang . '_email', array($template_path, $fallback_template_path), '');
+			$style->set_custom_style($template_lang . '_email', array($template_path, $fallback_template_path), array(), '');
 
 			$tpl->set_filenames(array(
 				'body'		=> $template_file . '.txt',
diff --git a/phpBB/includes/style/style.php b/phpBB/includes/style/style.php
index effd496fb9..4703c3a219 100644
--- a/phpBB/includes/style/style.php
+++ b/phpBB/includes/style/style.php
@@ -91,16 +91,22 @@ class phpbb_style
 	{
 		$style_path = $this->user->style['style_path'];
 		$style_dirs = ($this->user->style['style_parent_id']) ? array_reverse(explode('/', $this->user->style['style_parent_tree'])) : array();
-		$paths = array($this->get_style_path($style_path));
+
+		$names = array($style_path);
 		foreach ($style_dirs as $dir)
 		{
-			$paths[] = $this->get_style_path($dir);
+			$names[] = $dir;
 		}
+		// Add 'all' path, used as last fallback path by events and extensions
+		//$names[] = 'all';
 
-		// Add 'all' path, used as last fallback path by hooks and extensions
-		$paths[] = $this->get_style_path('all');
+		$paths = array();
+		foreach ($names as $name)
+		{
+			$paths[] = $this->get_style_path($name);
+		}
 
-		return $this->set_custom_style($style_path, $paths);
+		return $this->set_custom_style($style_path, $paths, $names);
 	}
 
 	/**
@@ -110,18 +116,27 @@ class phpbb_style
 	*
 	* @param string $name Name of style, used for cache prefix. Examples: "admin", "prosilver"
 	* @param array or string $paths Array of style paths, relative to current root directory
+	* @param array $names Array of names of templates in inheritance tree order, used by extensions. If empty, $name will be used.
 	* @param string $template_path Path to templates, relative to style directory. False if path should be set to default (templates/).
 	*/
-	public function set_custom_style($name, $paths, $template_path = false)
+	public function set_custom_style($name, $paths, $names = array(), $template_path = false)
 	{
 		if (is_string($paths))
 		{
 			$paths = array($paths);
 		}
 
+		if (empty($names))
+		{
+			$names = array($name);
+		}
+		$this->names = $names;
+
 		$this->provider->set_styles($paths);
 		$this->locator->set_paths($this->provider);
 
+		$this->template->set_style_names($names);
+
 		if ($template_path !== false)
 		{
 			$this->locator->set_template_path($template_path);
diff --git a/phpBB/includes/template/compile.php b/phpBB/includes/template/compile.php
index 22da21820e..fcdaf7abda 100644
--- a/phpBB/includes/template/compile.php
+++ b/phpBB/includes/template/compile.php
@@ -35,16 +35,23 @@ class phpbb_template_compile
 	/**
 	* Constructor.
 	*
-	* @param bool @allow_php Whether PHP code will be allowed in templates (inline PHP code, PHP tag and INCLUDEPHP tag)
+	* @param bool $allow_php Whether PHP code will be allowed in templates (inline PHP code, PHP tag and INCLUDEPHP tag)
+	* @param array $style_names Name of style to which the template being compiled belongs and parents in style tree order
 	* @param phpbb_style_resource_locator $locator Resource locator
 	* @param string $phpbb_root_path Path to phpBB root directory
+	* @param phpbb_extension_manager $extension_manager Extension manager to use for finding template fragments in extensions; if null, template events will not be invoked
+	* @param phpbb_user $user Current user
 	*/
-	public function __construct($allow_php, $locator, $phpbb_root_path)
+	public function __construct($allow_php, $style_names, $locator, $phpbb_root_path, $extension_manager = null, $user = null)
 	{
 		$this->filter_params = array(
 			'allow_php'	=> $allow_php,
+			'style_names'	=> $style_names,
 			'locator'	=> $locator,
-			'phpbb_root_path'	=> $phpbb_root_path
+			'phpbb_root_path'	=> $phpbb_root_path,
+			'extension_manager'	=> $extension_manager,
+			'user'          => $user,
+			'template_compile'	=> $this,
 		);
 	}
 
diff --git a/phpBB/includes/template/filter.php b/phpBB/includes/template/filter.php
index 66d28242a3..f73ad28ba1 100644
--- a/phpBB/includes/template/filter.php
+++ b/phpBB/includes/template/filter.php
@@ -88,6 +88,37 @@ class phpbb_template_filter extends php_user_filter
 	private $phpbb_root_path;
 
 	/**
+	* 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
+	*/
+	private $style_names;
+
+	/**
+	* Extension manager.
+	*
+	* @var phpbb_extension_manager
+	*/
+	private $extension_manager;
+
+	/**
+	* Current user
+	*
+	* @var phpbb_user
+	*/
+	private $user;
+
+	/**
+	* Template compiler.
+	*
+	* @var phpbb_template_compile
+	*/
+	private $template_compile;
+
+	/**
 	* Stream filter
 	*
 	* Is invoked for evey chunk of the stream, allowing us
@@ -138,8 +169,10 @@ class phpbb_template_filter extends php_user_filter
 	/**
 	* Initializer, called on creation.
 	*
-	* Get the allow_php option, root directory and locator from params,
+	* Get the allow_php option, style_names, root directory and locator from params,
 	* which are passed to stream_filter_append.
+	*
+	* @return boolean Returns true
 	*/
 	public function onCreate()
 	{
@@ -148,6 +181,13 @@ class phpbb_template_filter extends php_user_filter
 		$this->allow_php = $this->params['allow_php'];
 		$this->locator = $this->params['locator'];
 		$this->phpbb_root_path = $this->params['phpbb_root_path'];
+		$this->style_names = $this->params['style_names'];
+		$this->extension_manager = $this->params['extension_manager'];
+		if (isset($this->params['user']))
+		{
+			$this->user = $this->params['user'];
+		}
+		$this->template_compile = $this->params['template_compile'];
 		return true;
 	}
 
@@ -229,7 +269,9 @@ class phpbb_template_filter extends php_user_filter
 	}
 
 	/**
-	* Callback for replacing matched tokens with PHP code
+	* Callback for replacing matched tokens with compiled template code.
+	*
+	* Compiled template code is an HTML stream with embedded PHP.
 	*
 	* @param array $matches Regular expression matches
 	* @return string compiled template code
@@ -317,6 +359,10 @@ class phpbb_template_filter extends php_user_filter
 				return '<!-- ENDPHP -->';
 			break;
 
+			case 'EVENT':
+				return '<?php ' . $this->compile_tag_event($matches[2]) . '?>';
+			break;
+
 			default:
 				return $matches[0];
 			break;
@@ -836,6 +882,97 @@ class phpbb_template_filter extends php_user_filter
 	}
 
 	/**
+	* Compile EVENT tag.
+	*
+	* $tag_args should be a single string identifying the event.
+	* The event name can contain letters, numbers and underscores only.
+	* If an invalid event name is specified, an E_USER_ERROR will be
+	* triggered.
+	*
+	* Event tags are only functional when the template engine has
+	* an instance of the extension manager. Extension manager would
+	* be called upon to find all extensions listening for the specified
+	* event, and to obtain additional template fragments. All such
+	* template fragments will be compiled and included in the generated
+	* compiled template code for the current template being compiled.
+	*
+	* The above means that whenever an extension is enabled or disabled,
+	* template cache should be cleared in order to update the compiled
+	* template code for the active set of template event listeners.
+	*
+	* This also means that extensions cannot return different template
+	* fragments at different times. Once templates are compiled, changing
+	* such template fragments would have no effect.
+	*
+	* @param string $tag_args EVENT tag arguments, as a string - for EVENT this is the event name
+	* @return string compiled template code
+	*/
+	private function compile_tag_event($tag_args)
+	{
+		if (!preg_match('/^\w+$/', $tag_args))
+		{
+			// The event location is improperly formatted,
+			if ($this->user)
+			{
+				trigger_error($this->user->lang('ERR_TEMPLATE_EVENT_LOCATION', $tag_args), E_USER_ERROR);
+			}
+			else
+			{
+				trigger_error(sprintf('The specified template event location <em>[%s]</em> is improperly formatted.', $tag_args), E_USER_ERROR);
+			}
+		}
+		$location = $tag_args;
+
+		if ($this->extension_manager)
+		{
+			$finder = $this->extension_manager->get_finder();
+
+			$files = $finder
+				->extension_prefix($location)
+				->extension_suffix('.html')
+				->extension_directory("/styles/all/template")
+				->get_files();
+
+			foreach ($this->style_names as $style_name)
+			{
+				$more_files = $finder
+					->extension_prefix($location)
+					->extension_suffix('.html')
+					->extension_directory("/styles/" . $style_name . "/template")
+					->get_files();
+				if (!empty($more_files))
+				{
+					$files = array_merge($files, $more_files);
+					break;
+				}
+			}
+
+			$all_compiled = '';
+			foreach ($files as $file)
+			{
+				$compiled = $this->template_compile->compile_file($file);
+
+				if ($compiled === false)
+				{
+					if ($this->user)
+					{
+						trigger_error($this->user->lang('ERR_TEMPLATE_COMPILATION', phpbb_filter_root_path($file)), E_USER_ERROR);
+					}
+					else
+					{
+						trigger_error(sprintf('The file could not be compiled: %s', phpbb_filter_root_path($file)), E_USER_ERROR);
+					}
+				}
+
+				$all_compiled .= $compiled;
+			}
+			// Need spaces inside php tags as php cannot grok
+			// < ?php? > sans the spaces
+			return ' ?' . '>' . $all_compiled . '<?php ';
+		}
+	}
+
+	/**
 	* parse expression
 	* This is from Smarty
 	*/
diff --git a/phpBB/includes/template/locator.php b/phpBB/includes/template/locator.php
index 42db91efb2..f6fd20bcc2 100644
--- a/phpBB/includes/template/locator.php
+++ b/phpBB/includes/template/locator.php
@@ -39,7 +39,7 @@ interface phpbb_template_locator
 	* Sets the template filenames for handles. $filename_array
 	* should be a hash of handle => filename pairs.
 	*
-	* @param array $filname_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);
 
@@ -66,7 +66,7 @@ interface phpbb_template_locator
 	* 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 
+	* 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
diff --git a/phpBB/includes/template/template.php b/phpBB/includes/template/template.php
index 5396ddbfad..bbec768613 100644
--- a/phpBB/includes/template/template.php
+++ b/phpBB/includes/template/template.php
@@ -75,14 +75,32 @@ class phpbb_template
 	private $locator;
 
 	/**
+	* Extension manager.
+	*
+	* @var phpbb_extension_manager
+	*/
+	private $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
+	*/
+	private $style_names;
+
+	/**
 	* Constructor.
 	*
 	* @param string $phpbb_root_path phpBB root path
 	* @param user $user current user
 	* @param phpbb_template_locator $locator template locator
 	* @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_locator $locator, phpbb_template_context $context)
+	public function __construct($phpbb_root_path, $php_ext, $config, $user, phpbb_template_locator $locator, phpbb_template_context $context, phpbb_extension_manager $extension_manager = null)
 	{
 		$this->phpbb_root_path = $phpbb_root_path;
 		$this->php_ext = $php_ext;
@@ -90,12 +108,13 @@ class phpbb_template
 		$this->user = $user;
 		$this->locator = $locator;
 		$this->context = $context;
+		$this->extension_manager = $extension_manager;
 	}
 
 	/**
 	* Sets the template filenames for handles.
 	*
-	* @param array $filname_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)
 	{
@@ -105,6 +124,18 @@ class phpbb_template
 	}
 
 	/**
+	* Sets the style names corresponding to style hierarchy being compiled
+	* and/or rendered.
+	*
+	* @param array $style_names List of style names in inheritance tree order
+	* @return null
+	*/
+	public function set_style_names(array $style_names)
+	{
+		$this->style_names = $style_names;
+	}
+
+	/**
 	* Clears all variables and blocks assigned to this template.
 	*/
 	public function destroy()
@@ -282,7 +313,7 @@ class phpbb_template
 			return new phpbb_template_renderer_include($output_file, $this);
 		}
 
-		$compile = new phpbb_template_compile($this->config['tpl_allow_php'], $this->locator, $this->phpbb_root_path);
+		$compile = new phpbb_template_compile($this->config['tpl_allow_php'], $this->style_names, $this->locator, $this->phpbb_root_path, $this->extension_manager, $this->user);
 
 		if ($compile->compile_file_to_file($source_file, $output_file) !== false)
 		{
diff --git a/phpBB/install/index.php b/phpBB/install/index.php
index 09560946a6..2be5adaaac 100644
--- a/phpBB/install/index.php
+++ b/phpBB/install/index.php
@@ -215,7 +215,7 @@ $phpbb_style_path_provider = new phpbb_style_path_provider();
 $template = new phpbb_template($phpbb_root_path, $phpEx, $config, $user, $phpbb_style_resource_locator, new phpbb_template_context());
 $phpbb_style = new phpbb_style($phpbb_root_path, $phpEx, $config, $user, $phpbb_style_resource_locator, $phpbb_style_path_provider, $template);
 $phpbb_style->set_ext_dir_prefix('adm/');
-$phpbb_style->set_custom_style('admin', '../adm/style', '');
+$phpbb_style->set_custom_style('admin', '../adm/style', array(), '');
 $template->assign_var('T_ASSETS_PATH', '../assets');
 $template->assign_var('T_TEMPLATE_PATH', '../adm/style');
 
diff --git a/phpBB/install/install_update.php b/phpBB/install/install_update.php
index 7f40015002..d71752f9c6 100644
--- a/phpBB/install/install_update.php
+++ b/phpBB/install/install_update.php
@@ -131,7 +131,7 @@ class install_update extends module
 		}
 
 		// Set custom template again. ;)
-		$phpbb_style->set_custom_style('admin', '../adm/style', '');
+		$phpbb_style->set_custom_style('admin', '../adm/style', array(), '');
 
 		$template->assign_vars(array(
 			'S_USER_LANG'			=> $user->lang['USER_LANG'],
diff --git a/phpBB/language/en/common.php b/phpBB/language/en/common.php
index 2040fd2951..36ad925a98 100644
--- a/phpBB/language/en/common.php
+++ b/phpBB/language/en/common.php
@@ -186,6 +186,8 @@ $lang = array_merge($lang, array(
 	'ERR_CONNECTING_SERVER'				=> 'Error connecting to the server.',
 	'ERR_JAB_AUTH'						=> 'Could not authorise on Jabber server.',
 	'ERR_JAB_CONNECT'					=> 'Could not connect to Jabber server.',
+	'ERR_TEMPLATE_EVENT_LOCATION'		=> 'The specified template event location <em>[%s]</em> is improperly formatted.',
+	'ERR_TEMPLATE_COMPILATION'		=> 'The file could not be compiled: %s',
 	'ERR_UNABLE_TO_LOGIN'				=> 'The specified username or password is incorrect.',
 	'ERR_UNWATCHING'					=> 'An error occured while trying to unsubscribe.',
 	'ERR_WATCHING'						=> 'An error occured while trying to subscribe.',
diff --git a/phpBB/viewtopic.php b/phpBB/viewtopic.php
index 3fde5b5e03..bd2c7bea77 100644
--- a/phpBB/viewtopic.php
+++ b/phpBB/viewtopic.php
@@ -1353,7 +1353,7 @@ if (sizeof($attach_list))
 }
 
 $template->assign_vars(array(
-	'S_HAS_ATTACHMENTS' => !empty($attachments),
+	'S_HAS_ATTACHMENTS' => $topic_data['topic_attachment'],
 ));
 
 $methods = phpbb_gen_download_links('topic_id', $topic_id, $phpbb_root_path, $phpEx);
author	Nathaniel Guse <nathaniel.guse@gmail.com>	2012-12-12 16:30:50 -0600
committer	Nathaniel Guse <nathaniel.guse@gmail.com>	2012-12-12 16:30:50 -0600
commit	7ae5b62fc68017b6bdd5e55c9641e92a86a1f487 (patch)
tree	54e156815f13c40e9b880712de32ae13728ffdae /phpBB
parent	84284a9ccee7d5ccc658c3d1f751a5254b3b9175 (diff)
parent	9420647c43b300699afe6fe72f09d1746daf64a2 (diff)
download	forums-7ae5b62fc68017b6bdd5e55c9641e92a86a1f487.tar forums-7ae5b62fc68017b6bdd5e55c9641e92a86a1f487.tar.gz forums-7ae5b62fc68017b6bdd5e55c9641e92a86a1f487.tar.bz2 forums-7ae5b62fc68017b6bdd5e55c9641e92a86a1f487.tar.xz forums-7ae5b62fc68017b6bdd5e55c9641e92a86a1f487.zip