Ammend privacy policy regarding embedded content

Author: iMattPro

event/main_listener.php

@@ -70,6 +70,7 @@ public static function getSubscribedEvents()
 			'core.message_parser_check_message'			=> [['check_signature'], ['check_magic_urls'], ['check_bbcode_enabled']],
 			'core.text_formatter_s9e_parser_setup'		=> [['disable_media_embed'], ['setup_cache_dir']],
 			'core.page_header' 							=> 'setup_media_configs',
+			'core.page_footer_after'					=> 'append_agreement',
 		];
 	}
 
@@ -365,4 +366,21 @@ protected function get_siteIds()
 
 		return $siteIds ? json_decode($siteIds, true) : [];
 	}
+
+	/**
+	 * Appends additional language to the privacy policy agreement text.
+	 *
+	 * @return void
+	 */
+	public function append_agreement()
+	{
+		if (!$this->template->retrieve_var('S_AGREEMENT') || ($this->template->retrieve_var('AGREEMENT_TITLE') !== $this->language->lang('PRIVACY')))
+		{
+			return;
+		}
+
+		$this->language->add_lang('info_ucp_mediaembed', 'phpbb/mediaembed');
+
+		$this->template->append_var('AGREEMENT_TEXT', $this->language->lang('MEDIA_EMBED_PRIVACY_POLICY', $this->config['sitename']));
+	}
 }

language/en/info_ucp_mediaembed.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ *
+ * phpBB Media Embed PlugIn extension for the phpBB Forum Software package.
+ *
+ * @copyright (c) 2016 phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+if (empty($lang) || !is_array($lang))
+{
+	$lang = [];
+}
+
+$lang = array_merge($lang, [
+	'MEDIA_EMBED_PRIVACY_POLICY' => '
+		<br><br>
+		<h3>Embedded Content from Other Websites</h3>
+		“%1$s” may include posts or content that contain embedded material from external websites, including but not limited to YouTube, Facebook, Twitter, and similar platforms. Embedded content from these external sites behaves in the same way as if you had visited the originating website directly.
+		<br><br>These external websites may collect data about you, use cookies, embed additional third-party tracking, and monitor your interaction with the embedded content, including tracking your interaction if you have an account and are logged in to that website.
+		<br><br>Please note that such activity is beyond the control of “%1$s” and is governed by the privacy policies and terms of service of the respective external websites. We encourage you to review the privacy and cookie policies of any third-party services you interact with through embedded content.
+	',
+]);

tests/event/listener_test.php

@@ -133,6 +133,7 @@ public function test_getSubscribedEvents()
 			'core.message_parser_check_message',
 			'core.text_formatter_s9e_parser_setup',
 			'core.page_header',
+			'core.page_footer_after',
 		], array_keys(\phpbb\mediaembed\event\main_listener::getSubscribedEvents()));
 	}
 
@@ -512,6 +513,53 @@ public function test_setup_cache_dir($cache)
 		}
 	}
 
+	/**
+	 * Data for test_append_agreement
+	 *
+	 * @return array
+	 */
+	public function append_agreement_data()
+	{
+		return [
+			[false, 'PRIVACY', 0], // No agreement
+			[true, 'TERMS', 0], // Wrong title
+			[true, 'PRIVACY', 1], // Correct conditions
+		];
+	}
+
+	/**
+	 * Test the append_agreement method
+	 *
+	 * @dataProvider append_agreement_data
+	 * @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)
+	{
+		$this->config['sitename'] = 'Test Forum';
+
+		$this->template->expects(self::atMost(2))
+			->method('retrieve_var')
+			->withConsecutive(['S_AGREEMENT'], ['AGREEMENT_TITLE'])
+			->willReturnOnConsecutiveCalls($s_agreement, $this->language->lang($agreement_title));
+
+		if ($expected_append_calls > 0)
+		{
+			$this->template->expects(self::once())
+				->method('append_var')
+				->with('AGREEMENT_TEXT', $this->language->lang('MEDIA_EMBED_PRIVACY_POLICY', 'Test Forum'));
+		}
+		else
+		{
+			$this->template->expects(self::never())
+				->method('append_var');
+		}
+
+		$listener = $this->get_listener();
+		$listener->append_agreement();
+	}
+
 	protected function mock_s9e_parser()
 	{
 		return $this->getMockBuilder('s9e\\TextFormatter\\Parser')