Merge ccbdfb49c7 into e34e1759c7

PHPBB3-15214

phpBB/phpbb/template/twig/environment.php

@@ -161,6 +161,16 @@ class environment extends \Twig\Environment
 		return $this->assets_bag;
 	}
 
+	/**
+	 * Gets the event dispatcher instance
+	 *
+	 * @return dispatcher_interface
+	 */
+	public function get_phpbb_dispatcher()
+	{
+		return $this->phpbb_dispatcher;
+	}
+
 	/**
 	* Get the namespace look up order
 	*

phpBB/phpbb/template/twig/node/event.php

@@ -24,9 +24,13 @@ class event extends \Twig\Node\Node
 	/** @var \phpbb\template\twig\environment */
 	protected $environment;
 
-	public function __construct(\Twig\Node\Expression\AbstractExpression $expr, \phpbb\template\twig\environment $environment, $lineno, $tag = null)
+	/** @var array */
+	protected $template_event_priority_array;
+
+	public function __construct(\Twig\Node\Expression\AbstractExpression $expr, \phpbb\template\twig\environment $environment, $lineno, $tag = null, $template_event_priority_array = [])
 	{
 		$this->environment = $environment;
+		$this->template_event_priority_array = $template_event_priority_array;
 
 		parent::__construct(array('expr' => $expr), array(), $lineno, $tag);
 	}
@@ -42,40 +46,49 @@ class event extends \Twig\Node\Node
 
 		$location = $this->listener_directory . $this->getNode('expr')->getAttribute('name');
 
+		$template_events = [];
+
+		// Group and sort extension template events in according to their priority (0 by default if not set)
 		foreach ($this->environment->get_phpbb_extensions() as $ext_namespace => $ext_path)
 		{
 			$ext_namespace = str_replace('/', '_', $ext_namespace);
+			$priority_key = $this->template_event_priority_array[$ext_namespace][$location] ?? 0;
+			$template_events[$priority_key][] = $ext_namespace;
+		}
+		krsort($template_events);
 
-			if ($this->environment->isDebug())
+		foreach ($template_events as $events)
+		{
+			foreach ($events as $ext_namespace)
 			{
-				// If debug mode is enabled, lets check for new/removed EVENT
+				if ($this->environment->isDebug())
-				//  templates on page load rather than at compile. This is
+				{
-				//  slower, but makes developing extensions easier (no need to
+					// If debug mode is enabled, lets check for new/removed EVENT
-				//  purge the cache when a new event template file is added)
+					//  templates on page load rather than at compile. This is
-				$compiler
+					//  slower, but makes developing extensions easier (no need to
-					->write("if (\$this->env->getLoader()->exists('@{$ext_namespace}/{$location}.html')) {\n")
+					//  purge the cache when a new event template file is added)
-					->indent()
+					$compiler
-				;
+						->write("if (\$this->env->getLoader()->exists('@{$ext_namespace}/{$location}.html')) {\n")
-			}
+						->indent();
+				}
 
-			if ($this->environment->isDebug() || $this->environment->getLoader()->exists('@' . $ext_namespace . '/' . $location . '.html'))
+				if ($this->environment->isDebug() || $this->environment->getLoader()->exists('@' . $ext_namespace . '/' . $location . '.html'))
-			{
+				{
-				$compiler
+					$compiler
-					->write("\$previous_look_up_order = \$this->env->getNamespaceLookUpOrder();\n")
+						->write("\$previous_look_up_order = \$this->env->getNamespaceLookUpOrder();\n")
 
-					// We set the namespace lookup order to be this extension first, then the main path
+						// 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->setNamespaceLookUpOrder(array('{$ext_namespace}', '__main__'));\n")
-					->write("\$this->env->loadTemplate(\$this->env->getTemplateClass('@{$ext_namespace}/{$location}.html'), '@{$ext_namespace}/{$location}.html')->display(\$context);\n")
+						->write("\$this->env->loadTemplate(\$this->env->getTemplateClass('@{$ext_namespace}/{$location}.html'), '@{$ext_namespace}/{$location}.html')->display(\$context);\n")
-					->write("\$this->env->setNamespaceLookUpOrder(\$previous_look_up_order);\n")
+						->write("\$this->env->setNamespaceLookUpOrder(\$previous_look_up_order);\n");
-				;
+				}
-			}
 
-			if ($this->environment->isDebug())
+				if ($this->environment->isDebug())
-			{
+				{
-				$compiler
+					$compiler
-					->outdent()
+						->outdent()
-					->write("}\n\n")
+						->write("}\n\n");
-				;
+				}
 			}
 		}
 	}

phpBB/phpbb/template/twig/tokenparser/event.php

@@ -18,6 +18,12 @@ class event extends \Twig\TokenParser\AbstractTokenParser
 	/** @var \phpbb\template\twig\environment */
 	protected $environment;
 
+	/** @var \phpbb\event\dispatcher_interface */
+	protected $phpbb_dispatcher;
+
+	/** @var array */
+	protected $template_event_priority_array;
+
 	/**
 	* Constructor
 	*
@@ -26,6 +32,53 @@ class event extends \Twig\TokenParser\AbstractTokenParser
 	public function __construct(\phpbb\template\twig\environment $environment)
 	{
 		$this->environment = $environment;
+		$this->phpbb_dispatcher = $this->environment->get_phpbb_dispatcher();
+
+		$template_event_priority_array = [];
+		/**
+		 * Allow assigning priority to template events
+		 *
+		 * The higher number - the higher tempate event listener priority value is.
+		 * In case of equal priority values, corresponding template event listeners will be handled in default compilation order.
+		 * If not set, template event listener priority will be assigned to the value of 0.
+		 *
+		 * @event core.twig_event_tokenparser_constructor
+		 * @var	array	template_event_priority_array	Array with template event priority assignments per extension namespace
+		 *		Usage:
+		 *		'<author>_<extension_name>' => [
+		 *			'event/<template_event_name>'		=> priority_number,
+		 *		],
+		 *
+		 *		Example:
+		 *		class template_event_order implements EventSubscriberInterface
+		 *		{
+		 *			static public function getSubscribedEvents()
+		 *			{
+		 *				return [
+		 *					'core.twig_event_tokenparser_constructor'	=> 'set_template_event_priority',
+		 *				];
+		 *			}
+		 *
+		 *			public function set_template_event_priority($event)
+		 *			{
+		 *				$template_event_priority_array = $event['template_event_priority_array'];
+		 *				$template_event_priority_array['vendor_name'] = [
+		 *					'event/navbar_header_quick_links_after' => -1,
+		 *				];
+		 *				$event['template_event_priority_array'] = $template_event_priority_array;
+		 *			}
+		 *		}
+		 *
+		 * @since 4.0.0-a1
+		 */
+		if ($this->phpbb_dispatcher)
+		{
+			$vars = ['template_event_priority_array'];
+			extract($this->phpbb_dispatcher->trigger_event('core.twig_event_tokenparser_constructor', compact($vars)));
+		}
+
+		$this->template_event_priority_array = $template_event_priority_array;
+		unset($template_event_priority_array);
 	}
 
 	/**
@@ -42,7 +95,7 @@ class event extends \Twig\TokenParser\AbstractTokenParser
 		$stream = $this->parser->getStream();
 		$stream->expect(\Twig\Token::BLOCK_END_TYPE);
 
-		return new \phpbb\template\twig\node\event($expr, $this->environment, $token->getLine(), $this->getTag());
+		return new \phpbb\template\twig\node\event($expr, $this->environment, $token->getLine(), $this->getTag(), $this->template_event_priority_array);
 	}
 
 	/**

tests/functional/extension_controller_test.php

@@ -16,8 +16,6 @@
 */
 class phpbb_functional_extension_controller_test extends phpbb_functional_test_case
 {
-	protected $phpbb_extension_manager;
-
 	private static $helper;
 
 	protected static $fixtures = array(

tests/functional/extension_global_lang_test.php

@@ -16,8 +16,6 @@
 */
 class phpbb_functional_extension_global_lang_test extends phpbb_functional_test_case
 {
-	protected $phpbb_extension_manager;
-
 	private static $helper;
 
 	protected static $fixtures = array(

tests/functional/extension_module_test.php

@@ -17,8 +17,6 @@ require_once __DIR__ . '/../../phpBB/includes/acp/acp_modules.php';
 */
 class phpbb_functional_extension_module_test extends phpbb_functional_test_case
 {
-	protected $phpbb_extension_manager;
-
 	private static $helper;
 
 	protected static $fixtures = array(

tests/functional/extension_permission_lang_test.php

@@ -16,8 +16,6 @@
 */
 class phpbb_functional_extension_permission_lang_test extends phpbb_functional_test_case
 {
-	protected $phpbb_extension_manager;
-
 	private static $helper;
 
 	protected static $fixtures = array(

tests/functional/extension_template_event_order_test.php

@@ -0,0 +1,91 @@
+<?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.
+*
+*/
+
+/**
+* @group functional
+*/
+class phpbb_functional_extension_template_event_order_test extends phpbb_functional_test_case
+{
+	static private $helper;
+
+	static protected $fixtures = [
+		'./',
+	];
+
+	static public function setUpBeforeClass(): void
+	{
+		parent::setUpBeforeClass();
+
+		self::$helper = new phpbb_test_case_helpers(__CLASS__);
+		self::$helper->copy_ext_fixtures(__DIR__ . '/fixtures/ext/', self::$fixtures);
+	}
+
+	static public function tearDownAfterClass(): void
+	{
+		parent::tearDownAfterClass();
+
+		self::$helper->restore_original_ext_dir();
+	}
+
+	protected function setUp(): void
+	{
+		parent::setUp();
+
+		$this->purge_cache();
+	}
+
+	protected function tearDown(): void
+	{
+		$this->uninstall_ext('foo/bar');
+		$this->uninstall_ext('foo/foo');
+
+		parent::tearDown();
+	}
+
+	protected static function setup_extensions()
+	{
+		return ['foo/bar', 'foo/foo'];
+	}
+
+	/**
+	* Check a controller for extension foo/bar.
+	*/
+	public function test_template_event_order()
+	{
+		global $phpbb_root_path;
+
+		$crawler = self::request('GET', 'index.php');
+		$quick_links_menu = $crawler->filter('ul[role="menu"]')->eq(0);
+		$quick_links_menu_nodes_count = (int) $quick_links_menu->filter('li')->count();
+		// Ensure foo/foo template event goes before foo/bar one
+		$this->assertStringContainsString('FOO_FOO_QUICK_LINK', $quick_links_menu->filter('li')->eq($quick_links_menu_nodes_count - 4)->filter('span')->text());
+		$this->assertStringContainsString('FOO_BAR_QUICK_LINK', $quick_links_menu->filter('li')->eq($quick_links_menu_nodes_count - 3)->filter('span')->text());
+
+		// Change template events order to default, put foo/bar event before foo/foo one
+		$this->disable_ext('foo/bar');
+		$this->disable_ext('foo/foo');
+
+		$this->assertTrue(copy(__DIR__ . '/fixtures/ext/foo/bar/event/template_event_order_higher.php', $phpbb_root_path . 'ext/foo/bar/event/template_event_order.php'));
+		$this->assertTrue(copy(__DIR__ . '/fixtures/ext/foo/foo/event/template_event_order_lower.php', $phpbb_root_path . 'ext/foo/foo/event/template_event_order.php'));
+
+		$this->install_ext('foo/bar');
+		$this->install_ext('foo/foo');
+
+		$crawler = self::request('GET', 'index.php');
+		$quick_links_menu = $crawler->filter('ul[role="menu"]')->eq(0);
+		$quick_links_menu_nodes_count = (int) $quick_links_menu->filter('li')->count();
+		// Ensure foo/foo template event goes before foo/bar one
+		$this->assertStringContainsString('FOO_BAR_QUICK_LINK', $quick_links_menu->filter('li')->eq($quick_links_menu_nodes_count - 4)->filter('span')->text());
+		$this->assertStringContainsString('FOO_FOO_QUICK_LINK', $quick_links_menu->filter('li')->eq($quick_links_menu_nodes_count - 3)->filter('span')->text());
+	}
+}

tests/functional/fixtures/ext/foo/bar/config/services.yml

@@ -14,7 +14,13 @@ services:
         class: foo\bar\event\permission
         tags:
             - { name: event.listener }
+
     foo_bar.listener.user_setup:
         class: foo\bar\event\user_setup
         tags:
             - { name: event.listener }
+
+    foo_bar.listener.template_event_order:
+        class: foo\bar\event\template_event_order
+        tags:
+            - { name: event.listener }

tests/functional/fixtures/ext/foo/bar/event/template_event_order.php

@@ -0,0 +1,38 @@
+<?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 foo\bar\event;
+
+/**
+* Event listener
+*/
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+class template_event_order implements EventSubscriberInterface
+{
+	static public function getSubscribedEvents()
+	{
+		return array(
+			'core.twig_event_tokenparser_constructor'	=> 'set_template_event_priority',
+		);
+	}
+
+	public function set_template_event_priority($event)
+	{
+		$template_event_priority_array = $event['template_event_priority_array'];
+		$template_event_priority_array['foo_bar'] = [
+			'event/navbar_header_quick_links_after' => -1,
+		];
+		$event['template_event_priority_array'] = $template_event_priority_array;
+	}
+}

tests/functional/fixtures/ext/foo/bar/event/template_event_order_higher.php

@@ -0,0 +1,38 @@
+<?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 foo\bar\event;
+
+/**
+* Event listener
+*/
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+class template_event_order implements EventSubscriberInterface
+{
+	static public function getSubscribedEvents()
+	{
+		return array(
+			'core.twig_event_tokenparser_constructor'	=> 'set_template_event_priority',
+		);
+	}
+
+	public function set_template_event_priority($event)
+	{
+		$template_event_priority_array = $event['template_event_priority_array'];
+		$template_event_priority_array['foo_bar'] = [
+			'event/navbar_header_quick_links_after' => 1,
+		];
+		$event['template_event_priority_array'] = $template_event_priority_array;
+	}
+}

tests/functional/fixtures/ext/foo/bar/styles/prosilver/template/event/navbar_header_quick_links_after.html

@@ -0,0 +1 @@
+<li><span>{{ lang('FOO_BAR_QUICK_LINK') }}</span></li>

tests/functional/fixtures/ext/foo/foo/config/services.yml

@@ -1,3 +1,8 @@
 services:
     foo_foo.controller:
         class: foo\foo\controller\controller
+
+    foo_foo.listener.template_event_order:
+        class: foo\foo\event\template_event_order
+        tags:
+            - { name: event.listener }

tests/functional/fixtures/ext/foo/foo/event/template_event_order.php

@@ -0,0 +1,38 @@
+<?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 foo\foo\event;
+
+/**
+* Event listener
+*/
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+class template_event_order implements EventSubscriberInterface
+{
+	static public function getSubscribedEvents()
+	{
+		return array(
+			'core.twig_event_tokenparser_constructor'	=> 'set_template_event_priority',
+		);
+	}
+
+	public function set_template_event_priority($event)
+	{
+		$template_event_priority_array = $event['template_event_priority_array'];
+		$template_event_priority_array['foo_foo'] = [
+			'event/navbar_header_quick_links_after' => 1,
+		];
+		$event['template_event_priority_array'] = $template_event_priority_array;
+	}
+}

tests/functional/fixtures/ext/foo/foo/event/template_event_order_lower.php

@@ -0,0 +1,38 @@
+<?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 foo\foo\event;
+
+/**
+* Event listener
+*/
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+class template_event_order implements EventSubscriberInterface
+{
+	static public function getSubscribedEvents()
+	{
+		return array(
+			'core.twig_event_tokenparser_constructor'	=> 'set_template_event_priority',
+		);
+	}
+
+	public function set_template_event_priority($event)
+	{
+		$template_event_priority_array = $event['template_event_priority_array'];
+		$template_event_priority_array['foo_foo'] = [
+			'event/navbar_header_quick_links_after' => -1,
+		];
+		$event['template_event_priority_array'] = $template_event_priority_array;
+	}
+}

tests/functional/fixtures/ext/foo/foo/styles/prosilver/template/event/navbar_header_quick_links_after.html

@@ -0,0 +1 @@
+<li><span>{{ lang('FOO_FOO_QUICK_LINK') }}</span></li>

tests/functional/metadata_manager_test.php

@@ -16,8 +16,6 @@
 */
 class phpbb_functional_metadata_manager_test extends phpbb_functional_test_case
 {
-	protected $phpbb_extension_manager;
-
 	private static $helper;
 
 	protected static $fixtures = array(

tests/test_framework/phpbb_functional_test_case.php

@@ -644,7 +644,7 @@ class phpbb_functional_test_case extends phpbb_test_case
 
 		$meta_refresh = $crawler->filter('meta[http-equiv="refresh"]');
 
-		// Wait for extension to be fully enabled
+		// Wait for extension to be fully disabled
 		while (count($meta_refresh))
 		{
 			preg_match('#url=.+/(adm+.+)#', $meta_refresh->attr('content'), $match);