# defender-security/3.1.0/src/controller/nf-lockout.php

Defender Security – Malware Scanner, Login Security & Firewall, version 3.1.0. 227 lines.

- Page: https://pluginprobe.com/plugins/defender-security/3.1.0/code/src/controller/nf-lockout.php
- Raw: https://pluginprobe.com/plugins/defender-security/3.1.0/raw/src/controller/nf-lockout.php
- Modified: 2022-03-14T09:29:00+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/defender-security/3.1.0/code/src/controller/nf-lockout.php#L10-L20`.

```php
<?php

namespace WP_Defender\Controller;

use Calotes\Component\Request;
use Calotes\Component\Response;
use WP_Defender\Component\Blacklist_Lockout;
use WP_Defender\Component\Config\Config_Hub_Helper;
use WP_Defender\Controller;
use WP_Defender\Model\Setting\Notfound_Lockout;
use WP_Defender\Traits\IP;
use WP_Defender\Traits\Setting;

/**
 * Class Nf_Lockout
 * @package WP_Defender\Controller
 */
class Nf_Lockout extends Controller {
	use IP, Setting;

	/**
	 * @var string
	 */
	protected $slug = 'wdf-ip-lockout';

	/**
	 * @var \WP_Defender\Component\Notfound_Lockout
	 */
	protected $service;

	/**
	 * @var Notfound_Lockout
	 */
	protected $model;

	/**
	 * @var string
	 */
	protected $module_name;

	public function __construct() {
		$this->register_routes();
		$this->module_name = __( '404 Detection', 'wpdef' );
		add_action( 'defender_enqueue_assets', array( &$this, 'enqueue_assets' ) );
		$this->model   = wd_di()->get( Notfound_Lockout::class );
		$this->service = wd_di()->get( \WP_Defender\Component\Notfound_Lockout::class );
		$service       = wd_di()->get( Blacklist_Lockout::class );
		if ( $this->model->enabled && ! $service->is_ip_whitelisted( $this->get_user_ip() ) ) {
			$this->service->add_hooks();
		}
	}

	/**
	 * Queue assets and require data
	 */
	public function enqueue_assets() {
		if ( ! $this->is_page_active() ) {
			return;
		}
		wp_localize_script( 'def-iplockout', 'nf_lockout', $this->data_frontend() );
	}

	/**
	 * @defender_route
	 */
	public function save_settings( Request $request ) {
		$data        = $request->get_data( $this->request_filter_rules() );
		$old_enabled = (bool) $this->model->enabled;

		$this->model->import( $data );
		if ( $this->model->validate() ) {
			$this->model->save();
			Config_Hub_Helper::set_clear_active_flag();

			return new Response( true, array_merge( [
				'message' => $this->get_update_message( $data, $old_enabled, $this->module_name ),
			], $this->data_frontend() ) );
		}

		return new Response( false, [
			'message' => $this->model->get_formatted_errors()
		] );
	}

	/**
	 * All the variables that we will show on frontend, both in the main page, or dashboard widget.
	 *
	 * @return array
	 */
	public function data_frontend() {
		return array_merge( [
			'model'       => $this->model->export(),
			'module_name' => $this->module_name,
		], $this->dump_routes_and_nonces() );
	}

	/**
	 * Export the data of this module, we will use this for export to HUB, create a preset etc.
	 */
	public function to_array() {}

	private function adapt_data( $data ) {
		$adapted_data = array();
		if ( isset( $data['detect_404'] ) ) {
			$adapted_data['enabled'] = $data['detect_404'];
		}
		if ( isset( $data['detect_404_threshold'] ) ) {
			$adapted_data['attempt'] = $data['detect_404_threshold'];
		}
		if ( isset( $data['detect_404_timeframe'] ) ) {
			$adapted_data['timeframe'] = $data['detect_404_timeframe'];
		}
		if ( isset( $data['detect_404_lockout_duration'] ) ) {
			$adapted_data['duration'] = $data['detect_404_lockout_duration'];
		}
		if ( isset( $data['detect_404_lockout_duration_unit'] ) ) {
			$adapted_data['duration_unit'] = $data['detect_404_lockout_duration_unit'];
		}
		if ( isset( $data['detect_404_lockout_ban'] ) ) {
			$adapted_data['lockout_type'] = 'permanent' === $data['detect_404_lockout_ban'] ? 'permanent' : 'timeframe';
		}
		if ( isset( $data['detect_404_blacklist'] ) ) {
			$adapted_data['blacklist'] = $data['detect_404_blacklist'];
		}
		if ( isset( $data['detect_404_whitelist'] ) ) {
			$adapted_data['whitelist'] = $data['detect_404_whitelist'];
		}
		if ( isset( $data['detect_404_lockout_message'] ) ) {
			$adapted_data['lockout_message'] = $data['detect_404_lockout_message'];
		}
		if ( isset( $data['detect_404_logged'] ) ) {
			$adapted_data['detect_logged'] = $data['detect_404_logged'];
		}

		return array_merge( $data, $adapted_data );
	}

	/**
	 * Import the data of other source into this, it can be when HUB trigger the import, or user apply a preset.
	 * @param array $data
	 *
	 * @return mixed
	 */
	public function import_data( $data ) {
		if ( ! empty( $data ) ) {
			$data = $this->adapt_data( $data );
		} else {

			return;
		}

		$model = $this->model;
		$model->import( $data );
		if ( $model->validate() ) {
			$model->save();
		}
	}

	/**
	 * Remove all settings, configs generated in this container runtime.
	 */
	public function remove_settings() {}

	/**
	 * Remove all data.
	 */
	public function remove_data() {}

	/**
	 * @return array
	 */
	public function export_strings() {
		return [];
	}

	/**
	 * Rules for request data
	 *
	 * @return array
	 */
	private function request_filter_rules() {
		return [
			'enabled'         => [
				'type' => 'boolean'
			],
			'attempt'         => [
				'type'     => 'int',
				'sanitize' => 'sanitize_text_field'
			],
			'duration'        => [
				'type'     => 'int',
				'sanitize' => 'sanitize_text_field'
			],
			'duration_unit'   => [
				'type'     => 'string',
				'sanitize' => 'sanitize_text_field'
			],
			'lockout_message' => [
				'type'     => 'string',
				'sanitize' => 'sanitize_text_field'
			],
			'lockout_type'    => [
				'type'     => 'string',
				'sanitize' => 'sanitize_text_field'
			],
			'timeframe'       => [
				'type'     => 'int',
				'sanitize' => 'sanitize_text_field'
			],
			'blacklist'       => [
				'type'     => 'string',
				'sanitize' => 'sanitize_textarea_field'
			],
			'whitelist'       => [
				'type'     => 'string',
				'sanitize' => [
					'rawurldecode',
					'sanitize_textarea_field'
				]
			],
			'detect_logged'   => [
				'type' => 'boolean'
			]
		];
	}
}

```