ElkArte\sources\subs\SettingsFormAdapter\InlinePermissions

Complexity

Total Complexity

34

Size/Duplication

Total Lines	288
Duplicated Lines	2.78 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

95.71%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getPermissions()	0	4	1
A	setPermissions()	0	22	1
A	getExcludedGroups()	0	4	1
A	setExcludedGroups()	0	4	1
A	__construct()	0	9	1
C	save()	0	37	8
C	prepare()	0	82	10
B	prepareContext()	8	22	4
C	filterIllegalPermissions()	0	29	7

<?php

/**
 * Functions to support the permissions controller
 *
 * @name      ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause
 *
 * @version 1.1 Release Candidate 2
 */

namespace ElkArte\sources\subs\SettingsFormAdapter;

/**
 * Class to initialize inline permissions sub-form and save its settings
 */
class InlinePermissions extends Adapter
{
	/**
	 * @var array
	 */
	private $permissions = array();

	/**
	 * @var string[]
	 */
	private $permissionList = array();

	/**
	 * @var string[]
	 */
	private $illegal_permissions = array();

	/**
	 * @var string[]
	 */
	private $illegal_guest_permissions = array();

	/**
	 * @var int[]
	 */
	private $excluded_groups = array();

	private $permissionsObject;
	private $db;

	/**
	 * @return string[]
	 */
	public function getPermissions()
	{
		return $this->permissions;
	}

	/**
	 * @param string[] $permissions
	 */
	public function setPermissions($permissions)
	{
		$this->permissions = $permissions;

		// Load the permission list
		$this->permissionList = array_map(
			function ($permission)
			{
				return $permission[1];
			}, $this->permissions
		);

		// Load the permission settings that guests cannot have
		$this->illegal_guest_permissions = array_intersect(
			array_map(
				function ($permission)
				{
					return str_replace(array('_any', '_own'), '', $permission[1]);
				}, $this->permissions
			), $this->permissionsObject->getIllegalGuestPermissions()
		);
	}

	/**
	 * @return int[]
	 */
	public function getExcludedGroups()
	{
		return $this->excluded_groups;
	}

	/**
	 * @param int[] $excluded_groups
	 */
	public function setExcludedGroups($excluded_groups)
	{
		$this->excluded_groups = $excluded_groups;
	}

	/**
	 * InlinePermissions constructor.
	 */
	public function __construct()
	{
		$this->db = database();

		// Make sure they can't do certain things,
		// unless they have the right permissions.
		$this->permissionsObject = new \Permissions;
		$this->illegal_permissions = $this->permissionsObject->getIllegalPermissions();
	}

	/**
	 * Save the permissions of a form containing inline permissions.
	 */
	public function save()
	{
		// No permissions? Not a great deal to do here.
		if (!allowedTo('manage_permissions'))
		{
			return;
		}
		$insertRows = array();
		foreach ($this->permissionList as $permission)
		{
			if (!isset($_POST[$permission]))
			{
				continue;
			}

			foreach ($_POST[$permission] as $id_group => $value)
			{
				if (in_array($value, array('on', 'deny')) && !in_array($permission, $this->illegal_permissions))
				{
					$insertRows[] = array($permission, (int) $id_group, $value == 'on' ? 1 : 0);
				}
			}
		}

		// Remove the old permissions...
		$this->permissionsObject->deletePermissions($this->permissionList);

		// ...and replace them with new ones.
		require_once(SUBSDIR . '/ManagePermissions.subs.php');
		replacePermission($insertRows);

		// Do a full child update.
		$this->permissionsObject->updateChild(array(), -1);

		// Just in case we cached this.
		updateSettings(array('settings_updated' => time()));
	}

	/**
	 * Initialize a form with inline permissions settings.
	 * It loads a context variables for each permission.
	 * This function is used by several settings screens to set specific permissions.
	 *
	 * @uses ManagePermissions language
	 * @uses ManagePermissions template
	 */
	public function prepare()
	{
		global $modSettings;

		// No permissions? Not a great deal to do here.
		if (!allowedTo('manage_permissions'))
		{
			return;
		}

		// Load the permission settings for guests
		foreach ($this->permissions as $permission)
		{
			$this->context[$permission[1]] = array(
				-1 => array(
					'id' => -1,
					'is_postgroup' => false,
					'status' => 'off',
				),
				0 => array(
					'id' => 0,
					'is_postgroup' => false,
					'status' => 'off',
				),
			);
		}

		$request = $this->db->query('', '
			SELECT id_group, CASE WHEN add_deny = {int:denied} THEN {string:deny} ELSE {string:on} END AS status, permission
			FROM {db_prefix}permissions
			WHERE id_group IN (-1, 0)
				AND permission IN ({array_string:permissions})',
			array(
				'denied' => 0,
				'permissions' => $this->permissionList,
				'deny' => 'deny',
				'on' => 'on',
			)
		);
		while ($row = $this->db->fetch_assoc($request))
		{
			$this->context[$row['permission']][$row['id_group']]['status'] = $row['status'];
		}
		$this->db->free_result($request);

		$request = $this->db->query('', '
			SELECT mg.id_group, mg.group_name, mg.min_posts, COALESCE(p.add_deny, -1) AS status, p.permission
			FROM {db_prefix}membergroups AS mg
				LEFT JOIN {db_prefix}permissions AS p ON (p.id_group = mg.id_group AND p.permission IN ({array_string:permissions}))
			WHERE mg.id_group NOT IN (1, 3)
				AND mg.id_parent = {int:not_inherited}' . (empty($modSettings['permission_enable_postgroups']) ? '
				AND mg.min_posts = {int:min_posts}' : '') . '
			ORDER BY mg.min_posts, CASE WHEN mg.id_group < {int:newbie_group} THEN mg.id_group ELSE 4 END, mg.group_name',
			array(
				'not_inherited' => -2,
				'min_posts' => -1,
				'newbie_group' => 4,
				'permissions' => $this->permissionList,
			)
		);
		while ($row = $this->db->fetch_assoc($request))
		{
			// Initialize each permission as being 'off' until proven otherwise.
			foreach ($this->permissions as $permission)
			{
				if (!isset($this->context[$permission[1]][$row['id_group']]))
				{
					$this->context[$permission[1]][$row['id_group']] = array(
						'id' => $row['id_group'],
						'name' => $row['group_name'],
						'is_postgroup' => $row['min_posts'] != -1,
						'status' => 'off',
					);
				}
			}

			$this->context[$row['permission']][$row['id_group']]['status'] = empty($row['status']) ? 'deny' : ($row['status'] == 1 ? 'on' : 'off');
		}
		$this->db->free_result($request);
		$this->filterIllegalPermissions();
		$this->prepareContext();
	}

	/**
	 * Prepare the template by loading context
	 * variables for each permission.
	 *
	 * @uses ManagePermissions template
	 * @uses ManagePermissions languuge
	 */
	protected function prepareContext()
	{
		global $context, $txt;

		loadTemplate('ManagePermissions');
		loadLanguage('ManagePermissions');

		// Load the names for guests
		foreach ($this->permissions as $permission)
		{
			if (isset($this->context[$permission[1]][-1]))
			{
				$this->context[$permission[1]][-1]['name'] = $txt['membergroups_guests'];
			}
			if (isset($this->context[$permission[1]][0]))
			{
				$this->context[$permission[1]][0]['name'] = $txt['membergroups_members'];
			}
		}

		$context['permissions'] = $this->context;
	}

	/**
	 * Some permissions cannot be given to certain groups. Remove them.
	 */
	private function filterIllegalPermissions()
	{
		foreach ($this->permissions as $permission)
		{
			$excluded_groups = $this->excluded_groups;
			if (isset($permission['excluded_groups']))
			{
				$excluded_groups += $permission['excluded_groups'];
			}
			foreach ($excluded_groups as $group)
			{
				if (isset($this->context[$permission[1]][$group]))
				{
					unset($this->context[$permission[1]][$group]);
				}
			}
			// Is this permission one that guests can't have?
			if (in_array($permission[1], $this->illegal_guest_permissions))
			{
				unset($this->context[$permission[1]][-1]);
			}

			// Is this permission outright disabled?
			if (in_array($permission[1], $this->illegal_permissions))
			{
				unset($this->context[$permission[1]]);
			}
		}
	}
}