Add GDPR Option (anonymize IP)

Author: iMattPro

event/listener.php

@@ -68,6 +68,7 @@ public function load_google_analytics()
 		$this->template->assign_vars(array(
 			'GOOGLEANALYTICS_ID'		=> $this->config['googleanalytics_id'],
 			'GOOGLEANALYTICS_USER_ID'	=> $this->user->data['user_id'],
+			'S_ANONYMIZE_IP'			=> $this->config['ga_anonymize_ip'],
 		));
 	}
 
@@ -98,6 +99,12 @@ public function add_googleanalytics_configs($event)
 					'type'		=> 'text:40:20',
 					'explain'	=> true,
 				),
+				'ga_anonymize_ip' => array(
+					'lang'		=> 'ACP_GA_ANONYMIZE_IP',
+					'validate'	=> 'bool',
+					'type'		=> 'radio:yes_no',
+					'explain'	=> true,
+				),
 			);
 
 			// Add the new config vars after warnings_expire_days in the display_vars config array

language/en/googleanalytics_acp.php

@@ -42,4 +42,6 @@
 	'ACP_GOOGLEANALYTICS_ID'			=> 'Google Analytics ID',
 	'ACP_GOOGLEANALYTICS_ID_EXPLAIN'	=> 'Enter your Google Analytics ID code, e.g.: <samp>UA-0000000-00</samp>.<br /><br />Google Analytics can track your registered users across multiple devices and sessions, for a more accurate user count in your reports. To enable this enhanced functionality User ID tracking must be configured in your Google Analytics account. <a href="https://support.google.com/analytics/answer/3123666">Click for more information</a>.',
 	'ACP_GOOGLEANALYTICS_ID_INVALID'	=> '“%s” is not a valid Google Analytics ID code.<br />It should be in the form “UA-0000000-00”.',
+	'ACP_GA_ANONYMIZE_IP'				=> 'Turn on IP Anonymization',
+	'ACP_GA_ANONYMIZE_IP_EXPLAIN'		=> 'Enable this option if you want the data collected by Google Analytics to be compliant with the EU‘s General Data Protection Regulation (GDPR). Note that enabling this option may slightly reduce the accuracy of geographic reporting.',
 ));

migrations/v10x/m2_anonymize_ip.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ *
+ * Google Analytics extension for the phpBB Forum Software package.
+ *
+ * @copyright (c) 2018 phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ */
+
+namespace phpbb\googleanalytics\migrations\v10x;
+
+/**
+ * Migration stage 2: Add anonymize ip config option
+ */
+class m2_anonymize_ip extends \phpbb\db\migration\migration
+{
+	/**
+	 * {@inheritdoc}
+	 */
+	static public function depends_on()
+	{
+		return array('\phpbb\googleanalytics\migrations\v10x\m1_initial_data');
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function update_data()
+	{
+		return array(
+			array('config.add', array('ga_anonymize_ip', 0)),
+		);
+	}
+}

styles/all/template/event/overall_header_stylesheets_after.html

@@ -9,6 +9,9 @@
 	{% if S_REGISTERED_USER -%}
 	ga('set', 'userId', {{ GOOGLEANALYTICS_USER_ID }});
 	{% endif -%}
+	{% if S_ANONYMIZE_IP -%}
+	ga('set', 'anonymizeIp', true);
+	{% endif -%}
 	{% EVENT phpbb_googleanalytics_alter_ga_requirements -%}
 	ga('send', 'pageview');
 </script>

tests/event/listener_test.php

@@ -36,7 +36,10 @@ public function setUp()
 		global $phpbb_root_path, $phpEx;
 
 		// Load/Mock classes required by the event listener class
-		$this->config = new \phpbb\config\config(array('googleanalytics_id' => 'UA-000000-01'));
+		$this->config = new \phpbb\config\config(array(
+			'googleanalytics_id' => 'UA-000000-01',
+			'ga_anonymize_ip' => 0,
+		));
 		$this->template = $this->getMockBuilder('\phpbb\template\template')
 			->getMock();
 		$lang_loader = new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx);
@@ -91,6 +94,7 @@ public function test_load_google_analytics()
 			->with(array(
 				'GOOGLEANALYTICS_ID'		=> $this->config['googleanalytics_id'],
 				'GOOGLEANALYTICS_USER_ID'	=> $this->user->data['user_id'],
+				'S_ANONYMIZE_IP'			=> $this->config['ga_anonymize_ip'],
 			));
 
 		$dispatcher = new \Symfony\Component\EventDispatcher\EventDispatcher();
@@ -109,7 +113,7 @@ public function add_googleanalytics_configs_data()
 			array( // expected config and mode
 				'settings',
 				array('vars' => array('warnings_expire_days' => array())),
-				array('warnings_expire_days', 'legend_googleanalytics', 'googleanalytics_id'),
+				array('warnings_expire_days', 'legend_googleanalytics', 'googleanalytics_id', 'ga_anonymize_ip'),
 			),
 			array( // unexpected mode
 				'foobar',