Merge pull request #17 from Crizz0/issue/16

Add ACP permission for ToU ACP pages

Author: Crizz0

acp/tou_info.php

@@ -19,15 +19,18 @@ function module()
 			'title'		=> 'ACP_TOU_TITLE',
 			'modes'		=> array(
 				'settings'	=> array(
-						'title' => 'ACP_TOU_SETTINGS',
-						'cat' => array('ACP_TOU_TITLE')
+					'title' => 'ACP_TOU_SETTINGS',
+					'auth' => 'ext_phpbbde/tou && acl_a_tou_manage',
+					'cat' => array('ACP_TOU_TITLE')
 					),
 				'tousetup'	=> array(
 					'title' => 'ACP_TOU_TOUSETUP',
+					'auth' => 'ext_phpbbde/tou && acl_a_tou_manage',
 					'cat' => array('ACP_TOU_TITLE')
 				),
 				'ppsetup'	=> array(
 					'title' => 'ACP_TOU_PPSETUP',
+					'auth' => 'ext_phpbbde/tou && acl_a_tou_manage',
 					'cat' => array('ACP_TOU_TITLE')
 				),
 			),

config/services.yml

@@ -25,3 +25,9 @@ services:
             - '@controller.helper'
             - '%core.root_path%'
             - '%core.php_ext%'
+    phpbbde.tou.listener:
+        class: phpbbde\tou\event\permission_listener
+        arguments:
+            - '@auth'
+        tags:
+            - { name: event.listener }

event/permission_listener.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ *
+ * @package phpBB.de Terms of use
+ * @copyright (c) 2020 https://www.phpBB.de, Crizzo
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+ *
+ */
+
+namespace phpbbde\tou\event;
+
+/**
+ * @ignore
+ */
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * Event listener
+ */
+class permission_listener implements EventSubscriberInterface
+{
+	/** @var \phpbb\auth\auth */
+	protected $auth;
+
+	/**
+	 * Constructor
+	 *
+	 * @param \phpbb\template\template $template Template object
+	 */
+	public function __construct(\phpbb\auth\auth $auth)
+	{
+		$this->auth = $auth;
+	}
+
+	static public function getSubscribedEvents()
+	{
+		return array(
+			'core.permissions' => 'permissions',
+		);
+	}
+
+	/**
+	 * Add permissions
+	 *
+	 * @param	object	$event	The event object
+	 * @return	null
+	 * @access	public
+	 */
+	public function permissions($event)
+	{
+		$permissions = $event['permissions'];
+		$permissions['a_tou_manage'] = array('lang' => 'ACL_A_TOU_MANAGE', 'cat' => 'misc');
+		$event['permissions'] = $permissions;
+	}
+}

language/de/permissions_tou.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ *
+ * Terms of Use extension for the phpBB Forum Software package.
+ *
+ * @copyright (c) 2020 Crizzo <https://www.phpBB.de>
+ * @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();
+}
+
+$lang = array_merge($lang, array(
+	'ACL_A_TOU_MANAGE' => 'Kann “Terms of Use“ verwalten',
+));

language/en/permissions_tou.php

@@ -0,0 +1,26 @@
+<?php
+/**
+*
+* Terms of Use extension for the phpBB Forum Software package.
+*
+* @copyright (c) 2020 Crizzo <https://www.phpBB.de>
+* @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();
+}
+
+$lang = array_merge($lang, array(
+	'ACL_A_TOU_MANAGE' => 'Can manage “Terms of Use“',
+));

migrations/v110.php

@@ -51,9 +51,35 @@ public function update_data()
 			array('config_text.add', array('tou_custom_pp_uid', '')),
 			array('config_text.add', array('tou_custom_pp_bitfield', '')),
 			array('config_text.add', array('tou_custom_pp_flags', OPTION_FLAG_BBCODE + OPTION_FLAG_SMILIES + OPTION_FLAG_LINKS)),
-
+			// Add permissions
+			array('permission.add', array('a_tou_manage', true)),
+			// Add config version
 			array('config.add', array('tou_ext_version', '1.1.0')),
 		);
+
+		// Check if admin role exists and assign permission to admin role
+		if ($this->role_exists('ROLE_ADMIN_FULL'))
+		{
+			$data[] = array('permission.permission_set', array('ROLE_ADMIN_FULL', 'a_tou_manage', 'role', true));
+		}
 		return $data;
 	}
+
+	/**
+	 * Checks whether the given role does exist or not.
+	 *
+	 * @param String $role the name of the role
+	 * @return true if the role exists, false otherwise
+	 * Source: https://github.com/paul999/mention/
+	 */
+	private function role_exists($role)
+	{
+		$sql = 'SELECT role_id
+		FROM ' . ACL_ROLES_TABLE . "
+		WHERE role_name = '" . $this->db->sql_escape($role) . "'";
+		$result = $this->db->sql_query_limit($sql, 1);
+		$role_id = $this->db->sql_fetchfield('role_id');
+		$this->db->sql_freeresult($result);
+		return $role_id;
+	}
 }