Merge pull request #191 from iMattPro/ad-privacy-switch

Allow toggling ads privacy policy amendment

Author: iMattPro

adm/style/settings_ads.html

@@ -37,6 +37,11 @@ <h3>{{ lang('WARNING') }}</h3>
 			<dd><label><input type="radio" class="radio" id="enable_clicks" name="enable_clicks" value="1"{% if ENABLE_CLICKS %} checked{% endif %} /> {{ lang('YES') }}</label>
 				<label><input type="radio" class="radio" name="enable_clicks" value="0"{% if not ENABLE_CLICKS %} checked{% endif %} /> {{ lang('NO') }}</label></dd>
 		</dl>
+		<dl>
+			<dt><label for="show_agreement">{{ lang('SHOW_AGREEMENT') ~ lang('COLON') }}</label><br /><span>{{ lang('SHOW_AGREEMENT_EXPLAIN') }}</span></dt>
+			<dd><label><input type="radio" class="radio" id="show_agreement" name="show_agreement" value="1"{% if SHOW_AGREEMENT %} checked{% endif %} /> {{ lang('YES') }}</label>
+				<label><input type="radio" class="radio" name="show_agreement" value="0"{% if not SHOW_AGREEMENT %} checked{% endif %} /> {{ lang('NO') }}</label></dd>
+		</dl>
 	</fieldset>
 	<fieldset class="submit-buttons">
 		<input class="button1" type="submit" id="submit" name="submit" value="{{ lang('SUBMIT') }}" />&nbsp;

controller/admin_controller.php

@@ -123,6 +123,7 @@ public function mode_settings()
 				$this->config->set('phpbb_ads_adblocker_message', $this->request->variable('adblocker_message', 0));
 				$this->config->set('phpbb_ads_enable_views', $this->request->variable('enable_views', 0));
 				$this->config->set('phpbb_ads_enable_clicks', $this->request->variable('enable_clicks', 0));
+				$this->config->set('phpbb_ads_show_agreement', $this->request->variable('show_agreement', 0));
 
 				$this->success('ACP_AD_SETTINGS_SAVED');
 			}
@@ -136,6 +137,7 @@ public function mode_settings()
 			'AD_BLOCK_CONFIG'	=> $this->config['phpbb_ads_adblocker_message'],
 			'ENABLE_VIEWS'      => $this->config['phpbb_ads_enable_views'],
 			'ENABLE_CLICKS'     => $this->config['phpbb_ads_enable_clicks'],
+			'SHOW_AGREEMENT'    => $this->config['phpbb_ads_show_agreement'],
 		));
 	}
 

event/main_listener.php

@@ -284,7 +284,8 @@ protected function is_non_content_page()
 	 */
 	public function append_agreement()
 	{
-		if ((strpos($this->user->page['page_name'], 'ucp') !== 0)
+		if (!$this->config['phpbb_ads_show_agreement']
+			|| (strpos($this->user->page['page_name'], 'ucp') !== 0)
 			|| !$this->template->retrieve_var('S_AGREEMENT')
 			|| ($this->template->retrieve_var('AGREEMENT_TITLE') !== $this->language->lang('PRIVACY')))
 		{

language/en/acp.php

@@ -31,7 +31,7 @@
 	'AD_NOTE'					=> 'Notes',
 	'AD_NOTE_EXPLAIN'			=> 'Enter any notes for this advertisement. These notes are not shown anywhere except in the ACP and are optional.',
 	'AD_CODE'					=> 'Code',
-	'AD_CODE_EXPLAIN'			=> 'Enter the advertisement code here. All code must use HTML markup, BBCodes are not supported.',
+	'AD_CODE_EXPLAIN'			=> 'Enter the advertisement code here. All code must use HTML markup, BBCodes are not supported.<br><br>Note: If your ad code places cookies, collects user data, or tracks user behaviour (for example, ads from Google AdSense or other third-party ad networks), then you should enable the <strong>Advertising Disclosure</strong> in the <strong>Advertisement Management Settings</strong> panel to ensure compliance. If you are uncertain, it is recommended that you enable it.',
 	'ANALYSE_AD_CODE'			=> 'Analyse advertisement code',
 	'EVERYTHING_OK'				=> 'The code appears OK.',
 	'AD_BANNER'					=> 'Advertisement banner',
@@ -124,6 +124,8 @@
 	'ENABLE_VIEWS_EXPLAIN'			=> 'This will enable counting how many times every ad has been displayed. Note, that it adds extra load to the server, so if you do not need this feature, disable it.',
 	'ENABLE_CLICKS'					=> 'Count clicks',
 	'ENABLE_CLICKS_EXPLAIN'			=> 'This will enable counting how many times every ad has been clicked. Note, that it adds extra load to the server, so if you do not need this feature, disable it.',
+	'SHOW_AGREEMENT'				=> 'Advertising disclosure',
+	'SHOW_AGREEMENT_EXPLAIN'		=> 'Show details in the Privacy Policy about how third-party advertising and tracking technologies are used on this forum. This disclosure must be enabled if advertisements on your forum collect or track user information.',
 	'HIDE_GROUPS'					=> 'Hide advertisement for groups',
 	'HIDE_GROUPS_EXPLAIN'			=> 'Members of selected groups will not see this advertisement. Use CTRL+CLICK (or CMD+CLICK on Mac) to select/deselect more than one group.',
 

migrations/v20x/m5_add_privacy_setting.php

@@ -0,0 +1,43 @@
+<?php
+/**
+ *
+ * Advertisement management. An extension for the phpBB Forum Software package.
+ *
+ * @copyright (c) 2025 phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+
+namespace phpbb\ads\migrations\v20x;
+
+/**
+* Migration stage 5: Add setting to show privacy agreement
+*/
+class m5_add_privacy_setting extends \phpbb\db\migration\migration
+{
+	/**
+	 * {@inheritdoc
+	 */
+	public function effectively_installed()
+	{
+		$this->config->offsetExists('phpbb_ads_show_agreement');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public static function depends_on()
+	{
+		return ['\phpbb\ads\migrations\v20x\m4_admin_permission'];
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function update_data()
+	{
+		return [
+			['config.add', ['phpbb_ads_show_agreement', 0]],
+		];
+	}
+}

tests/controller/admin_controller_test.php

@@ -114,7 +114,7 @@ protected function setUp(): void
 		$this->analyser = $this->getMockBuilder('\phpbb\ads\analyser\manager')
 			->disableOriginalConstructor()
 			->getMock();
-		$this->controller_helper = $this->controller_helper = $this->getMockBuilder('\phpbb\controller\helper')
+		$this->controller_helper = $this->getMockBuilder('\phpbb\controller\helper')
 			->disableOriginalConstructor()
 			->getMock();
 		$this->root_path = $phpbb_root_path;
@@ -171,6 +171,7 @@ public function test_mode_settings_no_submit()
 				'AD_BLOCK_CONFIG'	=> $this->config['phpbb_ads_adblocker_message'],
 				'ENABLE_VIEWS'		=> $this->config['phpbb_ads_enable_views'],
 				'ENABLE_CLICKS'		=> $this->config['phpbb_ads_enable_clicks'],
+				'SHOW_AGREEMENT'	=> $this->config['phpbb_ads_show_agreement'],
 			));
 
 		$controller->mode_settings();
@@ -208,26 +209,29 @@ public function test_mode_settings_submit($valid_form, $adblocker_data, $hide_gr
 		if ($valid_form)
 		{
 			$this->request
-				->expects(self::exactly(3))
+				->expects(self::exactly(4))
 				->method('variable')
 				->withConsecutive(
 					['adblocker_message', 0],
 					['enable_views', 0],
-					['enable_clicks', 0]
+					['enable_clicks', 0],
+					['show_agreement', 0]
 				)
 				->willReturnOnConsecutiveCalls(
 					$adblocker_data,
 					1,
+					1,
 					1
 				);
 
 			$this->config
-				->expects(self::exactly(3))
+				->expects(self::exactly(4))
 				->method('set')
 				->withConsecutive(
 					['phpbb_ads_adblocker_message', $adblocker_data],
 					['phpbb_ads_enable_views', 1],
-					['phpbb_ads_enable_clicks', 1]
+					['phpbb_ads_enable_clicks', 1],
+					['phpbb_ads_show_agreement', 1]
 				);
 
 			$this->setExpectedTriggerError(E_USER_NOTICE, 'ACP_AD_SETTINGS_SAVED');

tests/event/amend_agreement_test.php

@@ -20,22 +20,25 @@ class amend_agreement_test extends main_listener_base
 	public function append_agreement_data()
 	{
 		return [
-			[false, 'PRIVACY', 0], // No agreement
-			[true, 'TERMS', 0], // Wrong title
-			[true, 'PRIVACY', 1], // Correct conditions
+			[true, false, 'PRIVACY', 0], // No agreement
+			[true, true, 'TERMS', 0], // Wrong title
+			[false, true, 'PRIVACY', 0], // don't display agreement
+			[true, true, 'PRIVACY', 1], // Correct conditions
 		];
 	}
 
 	/**
 	 * Test the append_agreement method
 	 *
 	 * @dataProvider append_agreement_data
+	 * @param bool $s_show S_SHOW template variable value
 	 * @param mixed $s_agreement S_AGREEMENT template variable value
 	 * @param mixed $agreement_title AGREEMENT_TITLE template variable value
 	 * @param int $expected_append_calls Expected append_var calls
 	 */
-	public function test_append_agreement($s_agreement, $agreement_title, $expected_append_calls)
+	public function test_append_agreement($s_show, $s_agreement, $agreement_title, $expected_append_calls)
 	{
+		$this->config['phpbb_ads_show_agreement'] = $s_show;
 		$this->config['sitename'] = 'Test Forum';
 		$this->user->page['page_name'] = 'ucp.php';
 

tests/functional/acp_settings_test.php

@@ -31,6 +31,7 @@ public function test_acp_settings()
 			'adblocker_message'	=> 1,
 			'enable_views'		=> 1,
 			'enable_clicks'		=> 1,
+			'show_agreement'	=> 1,
 		);
 		$form = $crawler->selectButton($this->lang('SUBMIT'))->form();
 		$crawler = self::submit($form, $form_data);
@@ -43,6 +44,7 @@ public function test_acp_settings()
 		self::assertEquals('1', $crawler->filter('option[selected]')->attr('value'));
 		self::assertEquals('1', $crawler->filter('input[name="enable_views"][checked]')->attr('value'));
 		self::assertEquals('1', $crawler->filter('input[name="enable_clicks"][checked]')->attr('value'));
+		self::assertEquals('1', $crawler->filter('input[name="show_agreement"][checked]')->attr('value'));
 	}
 
 	protected function get_settings_page()