ManageBans::action_edittrigger() - Code Metrics - elkarte/Elkarte - Measure and Improve Code Quality continuously with Scrutinizer

ManageBans::action_edittrigger() C
last analyzed 2025-12-20 23:04 UTC

↳ Parent: ManageBans
Complexity

Conditions	11
Paths	21
Size

Total Lines	110
Code Lines	61
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	132
Importance

Changes
Metric	Value
cc	11
eloc	61
nc	21
nop	0
dl	0
loc	110
ccs	0
cts	82
cp	0
crap	132
rs	6.7042
c	0
b	0
f	0
How to fix Long Method Complexity

<?php

/**
 * Controls execution for admin actions in the bans area
 *
 * @package   ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause (see accompanying LICENSE.txt file)
 *
 * @version 2.0 Beta 1
 *
 */

namespace ElkArte\AdminController;

use ElkArte\AbstractController;
use ElkArte\Action;
use ElkArte\Errors\ErrorContext;
use ElkArte\Exceptions\Exception;
use ElkArte\Helper\Util;
use ElkArte\Languages\Txt;

/**
 * This class controls execution for admin actions in the bans area
 * of the admin panel.
 *
 * @package Bans
 */
class ManageBans extends AbstractController
{
	/**
	 * Ban center. The main entrance point for all ban center functions.
	 *
	 * What it does:
	 *
	 * - It is accessed by ?action=admin;area=ban.
	 * - It chooses a function based on the 'sa' parameter, like many others.
	 * - The default sub-action is action_list().
	 * - It requires the ban_members permission.
	 * - It initializes the admin tabs.
	 *
	 * @event integrate_manage_bans
	 * @uses ManageBans template.
	 */
	public function action_index()
	{
		global $context, $txt;

		theme()->getTemplates()->load('ManageBans');
		require_once(SUBSDIR . '/Bans.subs.php');

		$subActions = [
			'add' => [$this, 'action_edit', 'permission' => 'manage_bans'],
			'browse' => [$this, 'action_browse', 'permission' => 'manage_bans'],
			'edittrigger' => [$this, 'action_edittrigger', 'permission' => 'manage_bans'],
			'edit' => [$this, 'action_edit', 'permission' => 'manage_bans'],
			'list' => [$this, 'action_list', 'permission' => 'manage_bans'],
			'log' => [$this, 'action_log', 'permission' => 'manage_bans'],
		];

		// Start up the controller
		$action = new Action('manage_bans');

		// Default the sub-action to 'view banlist'.
		$subAction = $action->initialize($subActions, 'list');

		// Make the call to integrate-manage_bans
		call_integration_hook('integrate_manage_bans', [&$subActions]);

		// Prepare some items for the template
		$context['page_title'] = $txt['ban_title'];
		$context['sub_action'] = $subAction;

		// Tabs for browsing the different ban functions.
		$context[$context['admin_menu_name']]['object']->prepareTabData([
			'title' => 'ban_title',
			'help' => 'ban_members',
			'description' => 'ban_description',
			'tabs' => [
				'list' => [
					'description' => $txt['ban_description'],
					'href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'list']),
					'selected' => $subAction === 'list' || $subAction === 'edit' || $subAction === 'edittrigger',
				],
				'add' => [
					'description' => $txt['ban_description'],
					'href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'add']),
				],
				'browse' => [
					'description' => $txt['ban_trigger_browse_description'],
					'href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'browse']),
				],
				'log' => [
					'description' => $txt['ban_log_description'],
					'href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'log']),
					'is_last' => true,
				],
			],
		]);

		// Call the right function for this sub-action.
		$action->dispatch($subAction);
	}

	/**
	 * Shows a list of bans currently set.
	 *
	 * What it does:
	 *
	 * - It is accessed by ?action=admin;area=ban;sa=list.
	 * - It removes expired bans.
	 * - It allows sorting on different criteria.
	 * - It also handles removal of selected ban items.
	 *
	 * @uses the main ManageBans template.
	 */
	public function action_list(): void
	{
		global $txt, $context;

		require_once(SUBSDIR . '/Bans.subs.php');

		// User pressed the 'remove selection button'.
		if (!empty($this->_req->post->removeBans) && !empty($this->_req->post->remove) && is_array($this->_req->post->remove))
		{
			checkSession();

			// Make sure every entry is a proper integer.
			$to_remove = array_map('intval', $this->_req->post->remove);

			// Unban them all!
			removeBanGroups($to_remove);
			removeBanTriggers($to_remove);

			// No more caching this ban!
			updateSettings(['banLastUpdated' => time()]);

			// Some members might be unbanned now. Update the members table.
			updateBanMembers();
		}

		// Create a date string so we don't overload them with date info.
		if (preg_match('~%[AaBbCcDdeGghjmuYy](?:[^%]*%[AaBbCcDdeGghjmuYy])*~', $this->user->time_format, $matches) == 0 || empty($matches[0]))
		if (preg_match('~%[AaBbCcDdeGghjmuYy](?:[^%]*%[AaBbCcDdeGghjmuYy])*~', /** @scrutinizer ignore-type */ $this->user->time_format, $matches) == 0 || empty($matches[0]))
		{
			$context['ban_time_format'] = $this->user->time_format;
		}
		else
		{
			$context['ban_time_format'] = $matches[0];
		}

		// Let's build a nice "create list" to show them the bans
		$listOptions = [
			'id' => 'ban_list',
			'title' => $txt['ban_title'],
			'items_per_page' => 20,
			'base_href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'list']),
			'default_sort_col' => 'added',
			'default_sort_dir' => 'desc',
			'get_items' => [
				'function' => 'list_getBans',
			],
			'get_count' => [
				'function' => 'list_getNumBans',
			],
			'no_items_label' => $txt['ban_no_entries'],
			'columns' => [
				'name' => [
					'header' => [
						'value' => $txt['ban_name'],
					],
					'data' => [
						'db' => 'name',
					],
					'sort' => [
						'default' => 'bg.name',
						'reverse' => 'bg.name DESC',
					],
				],
				'notes' => [
					'header' => [
						'value' => $txt['ban_notes'],
					],
					'data' => [
						'db' => 'notes',
						'class' => 'smalltext',
					],
					'sort' => [
						'default' => 'LENGTH(bg.notes) > 0 DESC, bg.notes',
						'reverse' => 'LENGTH(bg.notes) > 0, bg.notes DESC',
					],
				],
				'reason' => [
					'header' => [
						'value' => $txt['ban_reason'],
					],
					'data' => [
						'db' => 'reason',
						'class' => 'smalltext',
					],
					'sort' => [
						'default' => 'LENGTH(bg.reason) > 0 DESC, bg.reason',
						'reverse' => 'LENGTH(bg.reason) > 0, bg.reason DESC',
					],
				],
				'added' => [
					'header' => [
						'value' => $txt['ban_added'],
					],
					'data' => [
						'function' => static function ($rowData) {
							global $context;
							return standardTime($rowData['ban_time'], empty($context['ban_time_format']) ? true : $context['ban_time_format']);
						},
					],
					'sort' => [
						'default' => 'bg.ban_time',
						'reverse' => 'bg.ban_time DESC',
					],
				],
				'expires' => [
					'header' => [
						'value' => $txt['ban_expires'],
					],
					'data' => [
						'function' => static function ($rowData) {
							global $txt;
							// This ban never expires...whahaha.
							if ($rowData['expire_time'] === null)
							{
								return $txt['never'];
							}
							// This ban has already expired.
							if ($rowData['expire_time'] < time())
							{
								return sprintf('<span class="error">%1$s</span>', $txt['ban_expired']);
							}
							// Still need to wait a few days for this ban to expire.
							else
							{
								return sprintf('%1$d&nbsp;%2$s', ceil(($rowData['expire_time'] - time()) / (60 * 60 * 24)), $txt['ban_days']);
							}
						},
					],
					'sort' => [
						'default' => 'COALESCE(bg.expire_time, 1=1) DESC, bg.expire_time DESC',
						'reverse' => 'COALESCE(bg.expire_time, 1=1), bg.expire_time',
					],
				],
				'num_triggers' => [
					'header' => [
						'value' => $txt['ban_triggers'],
						'class' => 'centertext',
					],
					'data' => [
						'db' => 'num_triggers',
						'class' => 'centertext'
					],
					'sort' => [
						'default' => 'num_triggers DESC',
						'reverse' => 'num_triggers',
					],
				],
				'actions' => [
					'header' => [
						'value' => $txt['ban_actions'],
					],
					'data' => [
						'sprintf' => [
							'format' => '<a href="' . getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'edit', 'bg' => '%1$d']) . '">' . $txt['modify'] . '</a>',
							'params' => [
								'id_ban_group' => false,
							],
						],
					],
				],
				'check' => [
					'header' => [
						'value' => '<input type="checkbox" onclick="invertAll(this, this.form);" class="input_check" />',
					],
					'data' => [
						'sprintf' => [
							'format' => '<input type="checkbox" name="remove[]" value="%1$d" class="input_check" />',
							'params' => [
								'id_ban_group' => false,
							],
						],
					],
				],
			],
			'form' => [
				'href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'list']),
			],
			'additional_rows' => [
				[
					'class' => 'submitbutton flow_flex_additional_row',
					'position' => 'below_table_data',
					'value' => '<input type="submit" name="removeBans" value="' . $txt['ban_remove_selected'] . '" onclick="return confirm(\'' . $txt['ban_remove_selected_confirm'] . '\');" />',
				],
			],
		];

		createList($listOptions);
	}

	/**
	 * This function is behind the screen for adding new bans and modifying existing ones.
	 *
	 * Adding new bans:
	 *  - is accessed by ?action=admin;area=ban;sa=add.
	 *  - uses the ban_edit sub template of the ManageBans template.
	 *
	 * Modifying existing bans:
	 *  - Is accessed by ?action=admin;area=ban;sa=edit;bg=x
	 *  - Uses the ban_edit sub template of the ManageBans template.
	 *  - Shows a list of ban triggers for the specified ban.
	 *
	 * @event integrate_list_ban_items
	 */
	public function action_edit(): void
	{
		global $txt, $modSettings, $context;

		require_once(SUBSDIR . '/Bans.subs.php');

		$ban_errors = ErrorContext::context('ban', 1);

		// Saving a new or edited ban?
		if ((isset($this->_req->post->add_ban) || isset($this->_req->post->modify_ban) || isset($this->_req->post->remove_selection)) && !$ban_errors->hasErrors())
		{
			$this->action_edit2();
		}

		$ban_group_id = $context['ban']['id'] ?? $this->_req->getQuery('bg', 'intval', 0);

		// Template needs this to show errors using JavaScript
		Txt::load('Errors');
		createToken('admin-bet');
		$context['form_url'] = getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'edit']);

		// Prepare any errors found in the template to show
		$context['ban_errors'] = [
			'errors' => $ban_errors->prepareErrors(),
			'type' => $ban_errors->getErrorType() == 0 ? 'minor' : 'serious',
			'title' => $txt['ban_errors_detected'],
		];

		if (!$ban_errors->hasErrors())
		{
			// If we're editing an existing ban, get it from the database.
			if (!empty($ban_group_id))
			{
				$context['ban_group_id'] = $ban_group_id;

				// Setup for a createlist
				$listOptions = [
					'id' => 'ban_items',
					'base_href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'edit', 'bg' => $ban_group_id]),
					'no_items_label' => $txt['ban_no_triggers'],
					'items_per_page' => $modSettings['defaultMaxMessages'],
					'get_items' => [
						'function' => 'list_getBanItems',
						'params' => [
							'ban_group_id' => $ban_group_id,
						],
					],
					'get_count' => [
						'function' => 'list_getNumBanItems',
						'params' => [
							'ban_group_id' => $ban_group_id,
						],
					],
					'columns' => [
						'type' => [
							'header' => [
								'value' => $txt['ban_banned_entity'],
								'style' => 'width: 60%;',
							],
							'data' => [
								'function' => static function ($ban_item) {
									global $txt;

									if (in_array($ban_item['type'], ['ip', 'hostname', 'email']))
									{
										return '<strong>' . $txt[$ban_item['type']] . ':</strong>&nbsp;' . $ban_item[$ban_item['type']];
									}

									if ($ban_item['type'] === 'user')
									{
										return '<strong>' . $txt['username'] . ':</strong>&nbsp;' . $ban_item['user']['link'];
									}

									return '<strong>' . $txt['unknown'] . ':</strong>&nbsp;' . $ban_item['no_bantype_selected'];
								},
							],
						],
						'hits' => [
							'header' => [
								'value' => $txt['ban_hits'],
								'style' => 'width: 15%;text-align: center',
							],
							'data' => [
								'db' => 'hits',
								'class' => 'centertext'
							],
						],
						'id' => [
							'header' => [
								'value' => $txt['ban_actions'],
								'style' => 'width: 15%;',
							],
							'data' => [
								'function' => static function ($ban_item) {
									global $txt, $context;
									return '<a href="' . getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'edittrigger', 'bg' => $context['ban']['id'], 'bi' => $ban_item['id']]) . '">' . $txt['ban_edit_trigger'] . '</a>';
								},
							],
						],
						'checkboxes' => [
							'header' => [
								'value' => '<input type="checkbox" onclick="invertAll(this, this.form, \'ban_items\');" class="input_check" />',
								'style' => 'width: 5%;',
							],
							'data' => [
								'sprintf' => [
									'format' => '<input type="checkbox" name="ban_items[]" value="%1$d" class="input_check" />',
									'params' => [
										'id' => false,
									],
								],
							],
						],
					],
					'form' => [
						'href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'edit', 'bg' => $ban_group_id]),
					],
					'additional_rows' => [
						[
							'position' => 'below_table_data',
							'class' => 'submitbutton',
							'value' => '
								<input type="submit" name="remove_selection" value="' . $txt['ban_remove_selected_triggers'] . '" class="right_submit" />
								<a class="linkbutton floatright" href="' . getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'edittrigger', 'bg' => $ban_group_id]) . '">' . $txt['ban_add_trigger'] . '</a>
								<input type="hidden" name="bg" value="' . $ban_group_id . '" />
								<input type="hidden" name="' . $context['session_var'] . '" value="' . $context['session_id'] . '" />
								<input type="hidden" name="' . $context['admin-bet_token_var'] . '" value="' . $context['admin-bet_token'] . '" />',
						],
					],
				];
				createList($listOptions);
			}
			// Not an existing one, then it's probably new.
			else
			{
				$context['ban'] = [
					'id' => 0,
					'name' => '',
					'expiration' => [
						'status' => 'never',
						'days' => 0
					],
					'reason' => '',
					'notes' => '',
					'ban_days' => 0,
					'cannot' => [
						'access' => true,
						'post' => false,
						'register' => false,
						'login' => false,
					],
					'is_new' => true,
				];
				$context['ban_suggestions'] = [
					'main_ip' => '',
					'hostname' => '',
					'email' => '',
					'member' => [
						'id' => 0,
					],
				];

				// Overwrite some of the default form values if a user ID was given.
				if ($this->_req->hasQuery('u'))
				{
					$uid = $this->_req->getQuery('u', 'intval', 0);
					if ($uid > 0)
					{
						$context['ban_suggestions'] = array_merge($context['ban_suggestions'], getMemberData($uid));
					}

					if (!empty($context['ban_suggestions']['member']['id']))
					{
						$context['ban_suggestions']['href'] = getUrl('profile', ['action' => 'profile', 'u' => $context['ban_suggestions']['member']['id'], 'name' => $context['ban_suggestions']['member']['name']]);
						$context['ban_suggestions']['member']['link'] = '<a href="' . $context['ban_suggestions']['href'] . '">' . $context['ban_suggestions']['member']['name'] . '</a>';

						// Default the ban name to the name of the banned member.
						$context['ban']['name'] = $context['ban_suggestions']['member']['name'];

						// @todo: there should be a better solution...
						// used to lock the "Ban on Username" input when banning from profile
						$context['ban']['from_user'] = true;

						// Would be nice if we could also ban the hostname.
						if ((preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/', $context['ban_suggestions']['main_ip']) == 1 || isValidIPv6($context['ban_suggestions']['main_ip'])) && empty($modSettings['disableHostnameLookup']))
						{
							$context['ban_suggestions']['hostname'] = host_from_ip($context['ban_suggestions']['main_ip']);
						}

						$context['ban_suggestions']['other_ips'] = banLoadAdditionalIPs($context['ban_suggestions']['member']['id']);
					}
				}
				else
				{
					$context['use_autosuggest'] = true;
					loadJavascriptFile('suggest.js', ['defer' => true]);
				}
			}
		}

		// Set the right template
		$context['sub_template'] = 'ban_edit';

		// A couple of text strings we *may* need
		theme()->addJavascriptVar([
			'txt_ban_name_empty' => $txt['ban_name_empty'],
			'txt_ban_restriction_empty' => $txt['ban_restriction_empty']], true
		);

		// And a bit of JavaScript to enable/disable some fields
		theme()->addInlineJavascript('fUpdateStatus();', true);
	}

	/**
	 * This function handles submitted forms that add, modify, or remove ban triggers.
	 */
	public function action_edit2(): void
	{
		global $context;

		require_once(SUBSDIR . '/Bans.subs.php');

		// Check with security first
		checkSession();
		validateToken('admin-bet');

		$ban_errors = ErrorContext::context('ban', 1);

		// Adding or editing a ban group
		if (isset($this->_req->post->add_ban) || isset($this->_req->post->modify_ban))
		{
			$ban_info = [];

			// Let's collect all the information we need
			$ban_info['id'] = $this->_req->getQuery('bg', 'intval', 0);
			if (empty($ban_info['id']))
			{
				$ban_info['id'] = $this->_req->getPost('bg', 'intval', 0);
			}

			$ban_info['is_new'] = empty($ban_info['id']);
			$ban_info['expire_date'] = $this->_req->getPost('expire_date', 'intval', 0);
			$ban_info['expiration'] = [
				'status' => isset($this->_req->post->expiration) && in_array($this->_req->post->expiration, ['never', 'one_day', 'expired']) ? $this->_req->post->expiration : 'never',
				'days' => $ban_info['expire_date'],
			];
			$ban_info['db_expiration'] = $ban_info['expiration']['status'] === 'never' ? 'NULL' : ($ban_info['expiration']['status'] == 'one_day' ? time() + 24 * 60 * 60 * $ban_info['expire_date'] : 0);
			$ban_info['full_ban'] = empty($this->_req->post->full_ban) ? 0 : 1;
			$ban_info['reason'] = $this->_req->getPost('reason', 'Util::htmlspecialchars[ENT_QUOTES]', '');
			$ban_info['name'] = $this->_req->getPost('ban_name', 'Util::htmlspecialchars[ENT_QUOTES]', '');
			$ban_info['notes'] = $this->_req->getPost('notes', 'Util::htmlspecialchars[ENT_QUOTES]', '');
			$ban_info['notes'] = str_replace(["\r", "\n", '  '], ['', '<br />', '&nbsp; '], $ban_info['notes']);
			$ban_info['cannot']['access'] = empty($ban_info['full_ban']) ? 0 : 1;
			$ban_info['cannot']['post'] = !empty($ban_info['full_ban']) || empty($this->_req->post->cannot_post) ? 0 : 1;
			$ban_info['cannot']['register'] = !empty($ban_info['full_ban']) || empty($this->_req->post->cannot_register) ? 0 : 1;
			$ban_info['cannot']['login'] = !empty($ban_info['full_ban']) || empty($this->_req->post->cannot_login) ? 0 : 1;

			$ban_group_id = empty($ban_info['id']) ? insertBanGroup($ban_info) : updateBanGroup($ban_info);

			if ($ban_group_id !== false)
			{
				$ban_info['id'] = $ban_group_id;
				$ban_info['is_new'] = false;
			}

			$context['ban'] = $ban_info;
		}

		// Update the triggers associated with this ban
		if (isset($this->_req->post->ban_suggestions, $ban_info['id']))
		{
			$saved_triggers = saveTriggers((array) $this->_req->post, $ban_info['id'], $this->_req->getQuery('u', 'intval', 0), $this->_req->getQuery('bi', 'intval', 0));
			$context['ban_suggestions']['saved_triggers'] = $saved_triggers;
		}

		// Something went wrong somewhere, ban info or triggers, ... Oh well, let's go back.
		if ($ban_errors->hasErrors())
		{
			// Ensure ban_suggestions is always an array to avoid string offset errors below.
			if (!empty($saved_triggers) && is_array($saved_triggers))
			{
				$context['ban_suggestions'] = $saved_triggers;
			}
			else
			{
				$context['ban_suggestions'] = [
					'main_ip' => '',
					'hostname' => '',
					'email' => '',
					'member' => ['id' => 0],
				];
			}
			$context['ban']['from_user'] = true;

			// They may have entered a name not using the member select box
			if ($this->_req->hasQuery('u'))
			{
				$uid = $this->_req->getQuery('u', 'intval', 0);
				if ($uid > 0)
				{
					$context['ban_suggestions'] = array_merge($context['ban_suggestions'], getMemberData($uid));
				}
			}
			elseif ($this->_req->hasQuery('user'))
			{
				$context['ban']['from_user'] = false;
				$context['use_autosuggest'] = true;
				if (!isset($context['ban_suggestions']['member']) || !is_array($context['ban_suggestions']['member']))
				{
					$context['ban_suggestions']['member'] = ['id' => 0];
				}
				$context['ban_suggestions']['member']['name'] = $this->_req->getQuery('user', 'trim|strval', '');
			}

			// Not strictly necessary, but it's nice
			if (!empty($context['ban_suggestions']['member']['id']))
			{
				$context['ban_suggestions']['other_ips'] = banLoadAdditionalIPs($context['ban_suggestions']['member']['id']);
			}

			$this->action_edit();
			return;
		}

		if (isset($this->_req->post->ban_items))
		{
			$ban_group_id = $this->_req->getQuery('bg', 'intval', 0);
			$ban_items = array_map('intval', $this->_req->post->ban_items);

			removeBanTriggers($ban_items, $ban_group_id);
		}

		// Register the last modified date.
		updateSettings(['banLastUpdated' => time()]);

		// Update the member table to represent the new ban situation.
		updateBanMembers();

		// Go back to an appropriate spot
		redirectexit('action=admin;area=ban;sa=' . (isset($this->_req->post->add_ban) ? 'list' : 'edit;bg=' . ($ban_group_id ?? 0)));
	}

	/**
	 * This handles the listing of ban log entries and allows their deletion.
	 *
	 * What it does:
	 *
	 * - Shows a list of logged access attempts by banned users.
	 * - It is accessed by ?action=admin;area=ban;sa=log.
	 * - Allows sorting of several columns.
	 * - Handles deletion of (a selection of) log entries.
	 */
	public function action_log(): void
	{
		global $context, $txt;

		require_once(SUBSDIR . '/Bans.subs.php');

		// Delete one or more entries.
		if (!empty($this->_req->post->removeAll)
			|| (!empty($this->_req->post->removeSelected) && !empty($this->_req->post->remove)))
		{
			checkSession();
			validateToken('admin-bl');

			// 'Delete all entries' button was pressed.
			if (!empty($this->_req->post->removeAll))
			{
				removeBanLogs();
			}
			// 'Delete selection' button was pressed.
			else
			{
				$to_remove = array_map('intval', $this->_req->post->remove);
				removeBanLogs($to_remove);
			}
		}

		// Build a nice log list for viewing
		$listOptions = [
			'id' => 'ban_log',
			'title' => $txt['ban_log'],
			'items_per_page' => 30,
			'base_href' => $context['admin_area'] === 'ban' ? getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'log']) : getUrl('admin', ['action' => 'admin', 'area' => 'logs', 'sa' => 'banlog']),
			'default_sort_col' => 'date',
			'get_items' => [
				'function' => 'list_getBanLogEntries',
			],
			'get_count' => [
				'function' => 'list_getNumBanLogEntries',
			],
			'no_items_label' => $txt['ban_log_no_entries'],
			'columns' => [
				'ip' => [
					'header' => [
						'value' => $txt['ban_log_ip'],
					],
					'data' => [
						'sprintf' => [
							'format' => '<a href="' . getUrl('admin', ['action' => 'trackip', 'searchip' => '%1$s']) . '">%1$s</a>',
							'params' => [
								'ip' => false,
							],
						],
					],
					'sort' => [
						'default' => 'lb.ip',
						'reverse' => 'lb.ip DESC',
					],
				],
				'email' => [
					'header' => [
						'value' => $txt['ban_log_email'],
					],
					'data' => [
						'db_htmlsafe' => 'email',
					],
					'sort' => [
						'default' => "lb.email = '', lb.email",
						'reverse' => "lb.email != '', lb.email DESC",
					],
				],
				'member' => [
					'header' => [
						'value' => $txt['ban_log_member'],
					],
					'data' => [
						'sprintf' => [
							'format' => '<a href="' . getUrl('profile', ['action' => 'profile', 'u' => '%1$d', 'name' => '%2$s']) . '">%2$s</a>',
							'params' => [
								'id_member' => false,
								'real_name' => false,
							],
						],
					],
					'sort' => [
						'default' => 'COALESCE(mem.real_name, 1=1), mem.real_name',
						'reverse' => 'COALESCE(mem.real_name, 1=1) DESC, mem.real_name DESC',
					],
				],
				'date' => [
					'header' => [
						'value' => $txt['ban_log_date'],
					],
					'data' => [
						'function' => static fn($rowData) => standardTime($rowData['log_time']),
					],
					'sort' => [
						'default' => 'lb.log_time DESC',
						'reverse' => 'lb.log_time',
					],
				],
				'check' => [
					'header' => [
						'value' => '<input type="checkbox" onclick="invertAll(this, this.form);" class="input_check" />',
						'class' => 'centertext',
					],
					'data' => [
						'sprintf' => [
							'format' => '<input type="checkbox" name="remove[]" value="%1$d" class="input_check" />',
							'params' => [
								'id_ban_log' => false,
							],
						],
						'class' => 'centertext',
					],
				],
			],
			'form' => [
				'href' => $context['admin_area'] === 'ban' ? getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'log']) : getUrl('admin', ['action' => 'admin', 'area' => 'logs', 'sa' => 'banlog']),
				'include_start' => true,
				'include_sort' => true,
				'token' => 'admin-bl',
			],
			'additional_rows' => [
				[
					'class' => 'submitbutton',
					'position' => 'bottom_of_list',
					'value' => '
						<input type="submit" name="removeSelected" value="' . $txt['ban_log_remove_selected'] . '" onclick="return confirm(\'' . $txt['ban_log_remove_selected_confirm'] . '\');" />
						<input type="submit" name="removeAll" value="' . $txt['ban_log_remove_all'] . '" onclick="return confirm(\'' . $txt['ban_log_remove_all_confirm'] . '\');" class="right_submit" />',
				],
			],
		];

		createToken('admin-bl');

		// Build the list
		createList($listOptions);

		$context['page_title'] = $txt['ban_log'];
	}

	/**
	 * This function handles the ins and outs of the screen for adding new ban
	 * triggers or modifying existing ones.
	 *
	 * - Adding new ban triggers:
	 *   - is accessed by ?action=admin;area=ban;sa=edittrigger;bg=x
	 *   - uses the ban_edit_trigger sub template of ManageBans.
	 *
	 * - Editing existing ban triggers:
	 *   - is accessed by ?action=admin;area=ban;sa=edittrigger;bg=x;bi=y
	 *   - uses the ban_edit_trigger sub template of ManageBans.
	 *
	 * @uses sub template ban_edit_trigger
	 */
	public function action_edittrigger(): void
	{
		global $context;

		require_once(SUBSDIR . '/Bans.subs.php');

		$ban_group = $this->_req->get('bg', 'intval', 0);
		$ban_id = $this->_req->get('bi', 'intval', 0);

		if (empty($ban_group))
		{
			throw new Exception('ban_not_found', false);
		}

		// Adding a new trigger
		if (isset($this->_req->post->add_new_trigger) && !empty($this->_req->post->ban_suggestions))
		{
			saveTriggers((array) $this->_req->post, $ban_group, 0, $ban_id);
			redirectexit('action=admin;area=ban;sa=edit;bg=' . $ban_group);
		}
		// Edit an existing trigger with new / updated details
		elseif (isset($this->_req->post->edit_trigger) && !empty($this->_req->post->ban_suggestions))
		{
			// The first replaces the old one, the others are added new
			// (simplification, otherwise it would require another query and some work...)
			$dummy = (array) $this->_req->post;
			$dummy['ban_suggestions'] = (array) array_shift($this->_req->post->ban_suggestions);
			saveTriggers($dummy, $ban_group, 0, $ban_id);
			if ($this->_req->post->ban_suggestions !== [])
			{
				saveTriggers((array) $this->_req->post, $ban_group);
			}

			redirectexit('action=admin;area=ban;sa=edit;bg=' . $ban_group);
		}
		// Removing a ban trigger by clearing the checkbox
		elseif (isset($this->_req->post->edit_trigger))
		{
			removeBanTriggers($ban_id);
			redirectexit('action=admin;area=ban;sa=edit;bg=' . $ban_group);
		}

		// No id supplied; this must be a new trigger being added
		if (empty($ban_id))
		{
			$context['ban_trigger'] = [
				'id' => 0,
				'group' => $ban_group,
				'ip' => [
					'value' => '',
					'selected' => true,
				],
				'hostname' => [
					'selected' => false,
					'value' => '',
				],
				'email' => [
					'value' => '',
					'selected' => false,
				],
				'banneduser' => [
					'value' => '',
					'selected' => false,
				],
				'is_new' => true,
			];
		}
		// Otherwise it is an existing trigger they want to edit
		else
		{
			$ban_row = banDetails($ban_id, $ban_group);
			if (empty($ban_row))
			{
				throw new Exception('ban_not_found', false);
			}

			$row = $ban_row[$ban_id];

			// Load it up for the template
			$context['ban_trigger'] = [
				'id' => $row['id_ban'],
				'group' => $row['id_ban_group'],
				'ip' => [
					'value' => empty($row['ip_low1']) ? '' : range2ip([$row['ip_low1'], $row['ip_low2'], $row['ip_low3'], $row['ip_low4'], $row['ip_low5'], $row['ip_low6'], $row['ip_low7'], $row['ip_low8']], [$row['ip_high1'], $row['ip_high2'], $row['ip_high3'], $row['ip_high4'], $row['ip_high5'], $row['ip_high6'], $row['ip_high7'], $row['ip_high8']]),
					'selected' => !empty($row['ip_low1']),
				],
				'hostname' => [
					'value' => str_replace('%', '*', $row['hostname']),
					'selected' => !empty($row['hostname']),
				],
				'email' => [
					'value' => str_replace('%', '*', $row['email_address']),
					'selected' => !empty($row['email_address'])
				],
				'banneduser' => [
					'value' => $row['member_name'],
					'selected' => !empty($row['member_name'])
				],
				'is_new' => false,
			];
		}

		// The template uses the autosuggest functions
		loadJavascriptFile('suggest.js', ['defer' => true]);

		// Template we will use
		$context['sub_template'] = 'ban_edit_trigger';
		$context['form_url'] = getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'edittrigger']);

		createToken('admin-bet');
	}

	/**
	 * This handles the screen for showing the banned entities
	 *
	 * What it does:
	 *
	 * - It is accessed by ?action=admin;area=ban;sa=browse
	 * - It uses sub-tabs for browsing by IP, hostname, email, or username.
	 *
	 * @uses ManageBans template, browse_triggers sub template.
	 */
	public function action_browse(): void
	{
		global $modSettings, $context, $txt;

		require_once(SUBSDIR . '/Bans.subs.php');

		if (!empty($this->_req->post->remove_triggers) && !empty($this->_req->post->remove) && is_array($this->_req->post->remove))
		{
			checkSession();

			// Make sure every entry is a proper integer.
			$to_remove = array_map('intval', $this->_req->post->remove);

			removeBanTriggers($to_remove);

			// Rehabilitate some members.
			if ($this->_req->query->entity === 'member')
			{
				updateBanMembers();
			}

			// Make sure the ban cache is refreshed.
			updateSettings(['banLastUpdated' => time()]);
		}

		$context['selected_entity'] = isset($this->_req->query->entity) && in_array($this->_req->query->entity, ['ip', 'hostname', 'email', 'member']) ? $this->_req->query->entity : 'ip';

		$listOptions = [
			'id' => 'ban_trigger_list',
			'title' => $txt['ban_trigger_browse'],
			'items_per_page' => $modSettings['defaultMaxMessages'],
			'base_href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'browse', 'entity' => $context['selected_entity']]),
			'default_sort_col' => 'banned_entity',
			'no_items_label' => $txt['ban_no_triggers'],
			'get_items' => [
				'function' => 'list_getBanTriggers',
				'params' => [
					$context['selected_entity'],
				],
			],
			'get_count' => [
				'function' => 'list_getNumBanTriggers',
				'params' => [
					$context['selected_entity'],
				],
			],
			'columns' => [
				'banned_entity' => [
					'header' => [
						'value' => $txt['ban_banned_entity'],
					],
				],
				'ban_name' => [
					'header' => [
						'value' => $txt['ban_name'],
					],
					'data' => [
						'sprintf' => [
							'format' => '<a href="' . getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'edit', 'bg' => '%1$d']) . '">%2$s</a>',
							'params' => [
								'id_ban_group' => false,
								'name' => false,
							],
						],
					],
					'sort' => [
						'default' => 'bg.name',
						'reverse' => 'bg.name DESC',
					],
				],
				'hits' => [
					'header' => [
						'value' => $txt['ban_hits'],
					],
					'data' => [
						'db' => 'hits',
					],
					'sort' => [
						'default' => 'bi.hits DESC',
						'reverse' => 'bi.hits',
					],
				],
				'check' => [
					'header' => [
						'value' => '<input type="checkbox" onclick="invertAll(this, this.form);" class="input_check" />',
						'class' => 'centertext',
					],
					'data' => [
						'sprintf' => [
							'format' => '<input type="checkbox" name="remove[]" value="%1$d" class="input_check" />',
							'params' => [
								'id_ban' => false,
							],
						],
						'class' => 'centertext',
					],
				],
			],
			'form' => [
				'href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'browse', 'entity' => $context['selected_entity']]),
				'include_start' => true,
				'include_sort' => true,
			],
			'additional_rows' => [
				[
					'class' => 'submitbutton flow_flex_additional_row',
					'position' => 'below_table_data',
					'value' => '<input type="submit" name="remove_triggers" value="' . $txt['ban_remove_selected_triggers'] . '" onclick="return confirm(\'' . $txt['ban_remove_selected_triggers_confirm'] . '\');" />',
				],
			],
			'list_menu' => [
				'show_on' => 'top',
				'class' => 'flow_flex_right',
				'links' => [
					[
						'href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'browse', 'entity' => 'ip']),
						'is_selected' => $context['selected_entity'] === 'ip',
						'label' => $txt['ip']
					],
					[
						'href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'browse', 'entity' => 'hostname']),
						'is_selected' => $context['selected_entity'] === 'hostname',
						'label' => $txt['hostname']
					],
					[
						'href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'browse', 'entity' => 'email']),
						'is_selected' => $context['selected_entity'] === 'email',
						'label' => $txt['email']
					],
					[
						'href' => getUrl('admin', ['action' => 'admin', 'area' => 'ban', 'sa' => 'browse', 'entity' => 'member']),
						'is_selected' => $context['selected_entity'] === 'member',
						'label' => $txt['username']
					]
				],
			],
		];

		// Specific data for the first column depending on the selected entity.
		if ($context['selected_entity'] === 'ip')
		{
			$listOptions['columns']['banned_entity']['data'] = [
				'function' => static fn($rowData) => range2ip([
					$rowData['ip_low1'],
					$rowData['ip_low2'],
					$rowData['ip_low3'],
					$rowData['ip_low4'],
					$rowData['ip_low5'],
					$rowData['ip_low6'],
					$rowData['ip_low7'],
					$rowData['ip_low8']
				], [
					$rowData['ip_high1'],
					$rowData['ip_high2'],
					$rowData['ip_high3'],
					$rowData['ip_high4'],
					$rowData['ip_high5'],
					$rowData['ip_high6'],
					$rowData['ip_high7'],
					$rowData['ip_high8']
				]),
			];
			$listOptions['columns']['banned_entity']['sort'] = [
				'default' => 'bi.ip_low1, bi.ip_high1, bi.ip_low2, bi.ip_high2, bi.ip_low3, bi.ip_high3, bi.ip_low4, bi.ip_high4, bi.ip_low5, bi.ip_high5, bi.ip_low6, bi.ip_high6, bi.ip_low7, bi.ip_high7, bi.ip_low8, bi.ip_high8',
				'reverse' => 'bi.ip_low1 DESC, bi.ip_high1 DESC, bi.ip_low2 DESC, bi.ip_high2 DESC, bi.ip_low3 DESC, bi.ip_high3 DESC, bi.ip_low4 DESC, bi.ip_high4 DESC, bi.ip_low5 DESC, bi.ip_high5 DESC, bi.ip_low6 DESC, bi.ip_high6 DESC, bi.ip_low7 DESC, bi.ip_high7 DESC, bi.ip_low8 DESC, bi.ip_high8 DESC',
			];
		}
		elseif ($context['selected_entity'] === 'hostname')
		{
			$listOptions['columns']['banned_entity']['data'] = [
				'function' => static fn($rowData) => strtr(Util::htmlspecialchars($rowData['hostname']), ['%' => '*']),
			];
			$listOptions['columns']['banned_entity']['sort'] = [
				'default' => 'bi.hostname',
				'reverse' => 'bi.hostname DESC',
			];
		}
		elseif ($context['selected_entity'] === 'email')
		{
			$listOptions['columns']['banned_entity']['data'] = [
				'function' => static fn($rowData) => strtr(Util::htmlspecialchars($rowData['email_address']), ['%' => '*']),
			];
			$listOptions['columns']['banned_entity']['sort'] = [
				'default' => 'bi.email_address',
				'reverse' => 'bi.email_address DESC',
			];
		}
		elseif ($context['selected_entity'] === 'member')
		{
			$listOptions['columns']['banned_entity']['data'] = [
				'sprintf' => [
					'format' => '<a href="' . getUrl('profile', ['action' => 'profile', 'u' => '%1$d']) . '">%2$s</a>',
					'params' => [
						'id_member' => false,
						'real_name' => false,
					],
				],
			];
			$listOptions['columns']['banned_entity']['sort'] = [
				'default' => 'mem.real_name',
				'reverse' => 'mem.real_name DESC',
			];
		}

		// Create the list.
		createList($listOptions);
	}
}

elkarte / Elkarte

ManageBans::action_edittrigger() C last analyzed 2025-12-20 23:04 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

ManageBans::action_edittrigger() C
last analyzed 2025-12-20 23:04 UTC
