Setup.php

<?php

/**
 * IP Block Protection - a XenForo 2 add-on.
 *
 * @copyright 2026 ip-block.com
 * @license   GNU General Public License v2.0 only
 */

namespace IpBlock\Protection;

use XF\AddOn\AbstractSetup;
use XF\AddOn\StepRunnerInstallTrait;
use XF\AddOn\StepRunnerUninstallTrait;
use XF\AddOn\StepRunnerUpgradeTrait;

/**
 * Install / upgrade / uninstall handler.
 *
 * Creates the "IP Block" option group, all options and their master phrases so
 * the add-on is configurable from Admin CP -> Options immediately after install,
 * then removes everything cleanly on uninstall.
 *
 * (The controller_pre_dispatch code-event listener is registered declaratively
 *  in _data/code_event_listeners.xml, imported automatically on install.)
 */
class Setup extends AbstractSetup
{
	use StepRunnerInstallTrait;
	use StepRunnerUpgradeTrait;
	use StepRunnerUninstallTrait;

	const GROUP_ID = 'ipBlock';
	const ADDON_ID = 'IpBlock/Protection';

	/**
	 * Option definitions: id => [editFormat, dataType, defaultValue, editFormatParams].
	 *
	 * block_action uses a plain textbox that accepts "redirect" or "message";
	 * the Checker treats any value other than "message" as "redirect", so the
	 * behaviour is always well defined.
	 *
	 * @return array
	 */
	protected function optionDefs()
	{
		return [
			'ipBlockEnabled'      => ['onoff',    'boolean', '0',   ''],
			'ipBlockSiteId'       => ['textbox',  'string',  '',    ''],
			'ipBlockApiKey'       => ['textbox',  'string',  '',    ''],
			'ipBlockApiUrl'       => ['textbox',  'string',  'https://api.ip-block.com/v1/check', ''],
			'ipBlockFailOpen'     => ['onoff',    'boolean', '1',   ''],
			'ipBlockCacheTtl'     => ['spinbox',  'posint',  '300', 'min=0'],
			'ipBlockBehindProxy'  => ['onoff',    'boolean', '0',   ''],
			'ipBlockBlockAction'  => ['textbox',  'string',  'redirect', ''],
			'ipBlockBlockMessage' => ['textarea', 'string',  'Access to this site has been denied.', ''],
			'ipBlockWhitelist'    => ['textarea', 'string',  '',    ''],
		];
	}

	// -------------------------------------------------------------------------
	// Install
	// -------------------------------------------------------------------------

	public function installStep1()
	{
		// Option group + its master title phrase.
		/** @var \XF\Entity\OptionGroup $group */
		$group = $this->app->em()->create('XF:OptionGroup');
		$group->group_id      = self::GROUP_ID;
		$group->display_order = 1000;
		$group->debug_only    = false;
		$group->advanced      = false;
		$group->addon_id      = self::ADDON_ID;
		$group->save();

		$this->createPhrase('option_group.' . self::GROUP_ID, 'IP Block');
	}

	public function installStep2()
	{
		$displayOrder = 10;

		foreach ($this->optionDefs() as $optionId => $def)
		{
			list($editFormat, $dataType, $default, $params) = $def;

			/** @var \XF\Entity\Option $option */
			$option = $this->app->em()->create('XF:Option');
			$option->option_id          = $optionId;
			$option->option_value       = $default;
			$option->default_value      = $default;
			$option->edit_format        = $editFormat;
			$option->edit_format_params = $params;
			$option->data_type          = $dataType;
			$option->sub_options        = [];
			$option->advanced           = false;
			$option->addon_id           = self::ADDON_ID;
			$option->setRelations([self::GROUP_ID => $displayOrder]);
			$option->save();

			$this->createPhrase('option.' . $optionId, $this->titleFor($optionId));
			$this->createPhrase('option_explain.' . $optionId, $this->explainFor($optionId));

			$displayOrder += 10;
		}
	}

	// -------------------------------------------------------------------------
	// Upgrade - nothing to migrate for 1.0.0
	// -------------------------------------------------------------------------

	// -------------------------------------------------------------------------
	// Uninstall
	// -------------------------------------------------------------------------

	public function uninstallStep1()
	{
		$db        = $this->db();
		$optionIds = array_keys($this->optionDefs());
		$quoted    = $db->quote($optionIds);

		$db->delete('xf_option_group_relation', "option_id IN ($quoted)");
		$db->delete('xf_option', "option_id IN ($quoted)");
		$db->delete('xf_option_group', 'group_id = ?', self::GROUP_ID);
	}

	public function uninstallStep2()
	{
		$db     = $this->db();
		$titles = ['option_group.' . self::GROUP_ID];

		foreach (array_keys($this->optionDefs()) as $optionId)
		{
			$titles[] = 'option.' . $optionId;
			$titles[] = 'option_explain.' . $optionId;
		}

		$db->delete('xf_phrase', 'title IN (' . $db->quote($titles) . ') AND language_id = 0');
	}

	// -------------------------------------------------------------------------
	// Helpers
	// -------------------------------------------------------------------------

	/**
	 * Create a master (language_id 0) phrase owned by this add-on.
	 */
	protected function createPhrase($title, $text)
	{
		/** @var \XF\Entity\Phrase $phrase */
		$phrase = $this->app->em()->create('XF:Phrase');
		$phrase->language_id = 0;
		$phrase->title       = $title;
		$phrase->phrase_text = $text;
		$phrase->addon_id    = self::ADDON_ID;
		$phrase->save();
	}

	protected function titleFor($optionId)
	{
		$titles = [
			'ipBlockEnabled'      => 'Enable IP screening',
			'ipBlockSiteId'       => 'Site ID',
			'ipBlockApiKey'       => 'API key',
			'ipBlockApiUrl'       => 'API URL',
			'ipBlockFailOpen'     => 'Fail open',
			'ipBlockCacheTtl'     => 'Cache lifetime (seconds)',
			'ipBlockBehindProxy'  => 'Behind a proxy / CDN',
			'ipBlockBlockAction'  => 'Block action (redirect | message)',
			'ipBlockBlockMessage' => 'Block message',
			'ipBlockWhitelist'    => 'IP whitelist',
		];

		return isset($titles[$optionId]) ? $titles[$optionId] : $optionId;
	}

	protected function explainFor($optionId)
	{
		$explains = [
			'ipBlockEnabled'      => 'Screen every front-end request against ip-block.com. The Admin CP is never screened.',
			'ipBlockSiteId'       => 'Your ip-block.com site identifier.',
			'ipBlockApiKey'       => 'Your ip-block.com API key. Sent in the request body.',
			'ipBlockApiUrl'       => 'The screening endpoint. Leave as default unless instructed otherwise.',
			'ipBlockFailOpen'     => 'If the API times out or errors, allow the visitor (recommended). Disable to block on failure.',
			'ipBlockCacheTtl'     => 'How long a decision is cached (keyed by IP + user agent + referrer). 0 = check every request.',
			'ipBlockBehindProxy'  => 'Enable when behind Cloudflare or another reverse proxy so the real IP is read from CF-Connecting-IP / X-Forwarded-For.',
			'ipBlockBlockAction'  => 'Enter "redirect" to send blocked visitors to ip-block.com, or "message" to return an HTTP 403 with the message below.',
			'ipBlockBlockMessage' => 'Message returned with the 403 response when the block action is "message".',
			'ipBlockWhitelist'    => 'One IP address per line. Whitelisted IPs are always allowed and never sent to the API.',
		];

		return isset($explains[$optionId]) ? $explains[$optionId] : '';
	}
}