Consent Manager Integration

config/services.yml

@@ -6,6 +6,7 @@ services:
         class: phpbb\viglink\event\listener
         arguments:
             - '@config'
+            - '@language'
             - '@template'
         tags:
             - { name: event.listener }

event/listener.php

@@ -20,18 +20,25 @@ class listener implements EventSubscriberInterface
 	/** @var \phpbb\config\config $config Config object */
 	protected $config;
 
+	protected $language;
+
 	/** @var \phpbb\template\template $template Template object */
 	protected $template;
 
+	/** @var string|null Cached VigLink API key */
+	protected $viglink_key;
+
 	/**
 	 * Constructor
 	 *
 	 * @param \phpbb\config\config     $config   Config object
+	 * @param \phpbb\language\language $language Language object
 	 * @param \phpbb\template\template $template Template object
 	 */
-	public function __construct(\phpbb\config\config $config, \phpbb\template\template $template)
+	public function __construct(\phpbb\config\config $config, \phpbb\language\language $language, \phpbb\template\template $template)
 	{
 		$this->config = $config;
+		$this->language = $language;
 		$this->template = $template;
 	}
 
@@ -42,6 +49,7 @@ public static function getSubscribedEvents()
 	{
 		return array(
 			'core.viewtopic_post_row_after'		=> 'display_viglink',
+			'phpbb.consentmanager.collect_registrations' => 'register_viglink',
 		);
 	}
 
@@ -52,6 +60,44 @@ public static function getSubscribedEvents()
 	 */
 	public function display_viglink()
 	{
+		$viglink_key = $this->get_viglink_key();
+
+		$this->template->assign_vars(array(
+			'VIGLINK_ENABLED'	=> $this->config['viglink_enabled'] && $viglink_key,
+			'VIGLINK_API_KEY'	=> $viglink_key,
+			'VIGLINK_SUB_ID'	=> md5(urlencode($this->config['viglink_api_siteid']) . $this->config['questionnaire_unique_id']),
+		));
+	}
+
+	/**
+	 * Register Viglink with Consent Manager when available.
+	 *
+	 * @param \phpbb\event\data|array $event The event object or event data
+	 * @return void
+	 */
+	public function register_viglink($event)
+	{
+		if (!$this->config['viglink_enabled'] || empty($this->get_viglink_key()))
+		{
+			return;
+		}
+
+		$this->language->add_lang('viglink_common', 'phpbb/viglink');
+
+		$event['consent_manager']->register('phpbb.viglink', [
+			'label'		=> $this->language->lang('VIGLINK'),
+			'category'	=> 'marketing',
+			'description' => $this->language->lang('VIGLINK_DESCRIPTION'),
+		]);
+	}
+
+	protected function get_viglink_key()
+	{
+		if ($this->viglink_key !== null)
+		{
+			return $this->viglink_key;
+		}
+
 		$viglink_key = '';
 
 		if ($this->config['allow_viglink_phpbb'] && $this->config['phpbb_viglink_api_key'])
@@ -60,10 +106,6 @@ public function display_viglink()
 			$viglink_key = $this->config['phpbb_viglink_api_key'];
 		}
 
-		$this->template->assign_vars(array(
-			'VIGLINK_ENABLED'	=> $this->config['viglink_enabled'] && $viglink_key,
-			'VIGLINK_API_KEY'	=> $viglink_key,
-			'VIGLINK_SUB_ID'	=> md5(urlencode($this->config['viglink_api_siteid']) . $this->config['questionnaire_unique_id']),
-		));
+		return $this->viglink_key = $viglink_key;
 	}
 }

language/en/viglink_common.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ *
+ * VigLink extension for the phpBB Forum Software package.
+ *
+ * @copyright (c) 2026 phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+
+/**
+ * DO NOT CHANGE
+ */
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+if (empty($lang) || !is_array($lang))
+{
+	$lang = array();
+}
+
+// DEVELOPERS PLEASE NOTE
+//
+// All language files should use UTF-8 as their encoding and the files must not contain a BOM.
+//
+// Placeholders can now contain order information, e.g. instead of
+// 'Page %s of %s' you can (and should) write 'Page %1$s of %2$s', this allows
+// translators to re-order the output of data while ensuring it remains correct
+//
+// You do not need this where single placeholders are used, e.g. 'Message %d' is fine
+// equally where a string contains only two placeholders which are used to wrap text
+// in a url you again do not need to specify an order e.g., 'Click %sHERE%s' is fine
+//
+// Some characters you may want to copy&paste:
+// ’ » “ ” …
+//
+
+$lang = array_merge($lang, array(
+	'VIGLINK'				=> 'VigLink',
+	'VIGLINK_DESCRIPTION'	=> 'Uses third‑party cookies to personalise content and enable site monetisation.',
+));

styles/all/template/event/overall_footer_after.html

@@ -1,5 +1,5 @@
 {% if VIGLINK_ENABLED %}
-<script>
+<script{% if S_CONSENTMANAGER_MARKETING_ENABLED %} type="text/plain" data-consent-category="marketing"{% endif %}>
 	var vglnk = {
 		key: '{{ VIGLINK_API_KEY|e("js") }}',
 		sub_id: '{{ VIGLINK_SUB_ID|e("js") }}'

tests/event/listener_test.php

@@ -15,6 +15,9 @@ class listener_test extends \phpbb_test_case
 	/** @var \phpbb\config\config */
 	protected $config;
 
+	/** @var \phpbb\language\language */
+	protected $language;
+
 	/** @var \phpbb\viglink\event\listener */
 	protected $listener;
 
@@ -28,6 +31,8 @@ protected function setUp(): void
 	{
 		parent::setUp();
 
+		global $phpbb_root_path, $phpEx;
+
 		// Load/Mock classes required by the event listener class
 		$this->config = new \phpbb\config\config(array(
 			'viglink_enabled' => 1,
@@ -36,6 +41,9 @@ protected function setUp(): void
 		));
 		$this->template = $this->getMockBuilder('\phpbb\template\template')
 			->getMock();
+
+		$lang_loader = new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx);
+		$this->language = new \phpbb\language\language($lang_loader);
 	}
 
 	/**
@@ -45,6 +53,7 @@ protected function set_listener()
 	{
 		$this->listener = new \phpbb\viglink\event\listener(
 			$this->config,
+			$this->language,
 			$this->template
 		);
 	}
@@ -65,6 +74,7 @@ public function test_getSubscribedEvents()
 	{
 		self::assertEquals(array(
 			'core.viewtopic_post_row_after',
+			'phpbb.consentmanager.collect_registrations',
 		), array_keys(\phpbb\viglink\event\listener::getSubscribedEvents()));
 	}
 
@@ -128,4 +138,53 @@ public function test_display_viglink($allow_viglink_phpbb, $phpbb_api_key, $expe
 		$dispatcher->addListener('core.viewtopic_post_row_after', array($this->listener, 'display_viglink'));
 		$dispatcher->trigger_event('core.viewtopic_post_row_after');
 	}
+
+	public function register_marketing_data()
+	{
+		return [
+			'enabled' => [true, 1],
+			'disabled' => [false, 0],
+		];
+	}
+
+	/**
+	 * @dataProvider register_marketing_data
+	 */
+	public function test_register_analytics($enabled, $expected_calls)
+	{
+		$this->config['viglink_enabled'] = $this->config['allow_viglink_phpbb'] = $this->config['phpbb_viglink_api_key'] = $enabled;
+		$this->set_listener();
+
+		$consent_manager = new consent_manager_double();
+
+		$this->listener->register_viglink([
+			'consent_manager' => $consent_manager,
+		]);
+
+		self::assertCount($expected_calls, $consent_manager->registrations);
+
+		if ($expected_calls)
+		{
+			self::assertSame('phpbb.viglink', $consent_manager->registrations[0]['id']);
+			self::assertSame([
+				'label' => $this->language->lang('VIGLINK'),
+				'category' => 'marketing',
+				'description' => $this->language->lang('VIGLINK_DESCRIPTION'),
+			], $consent_manager->registrations[0]['definition']);
+		}
+	}
+}
+
+class consent_manager_double
+{
+	/** @var array */
+	public $registrations = [];
+
+	public function register($id, array $definition)
+	{
+		$this->registrations[] = [
+			'id' => $id,
+			'definition' => $definition,
+		];
+	}
 }