Your IP : 216.73.216.44
<?php
namespace WP_Defender\Model\Setting;
use Calotes\Model\Setting;
use WP_Defender\Traits\IP;
/**
* Class Blacklist_Lockout
*
* @package WP_Defender\Model\Setting
*/
class Blacklist_Lockout extends Setting {
use IP;
protected $table = 'wd_blacklist_lockout_settings';
/**
* Store a list of IPs blocked from the site, the priority of this list is lower than whitelist.
*
* @var string
* @defender_property
*/
public $ip_blacklist = '';
/**
* Top priority, if an IP in this list, mean we never check any on them.
*
* @var string
* @defender_property
*/
public $ip_whitelist = '';
/**
* The message to show on frontend when a blocklisted IP access the site, recommend to use something generic,
* so we don't expose our intention.
*
* @var string
* @defender_property
* @sanitize sanitize_textarea_field
*/
public $ip_lockout_message = '';
/**
* This should be use if you don't want an IP from some country to access your site, the error message will refer to
* $ip_lockout_message.
*
* @var array
* @defender_property
*/
public $country_blacklist = [];
/**
* This uses when you want to block all and allow some countries, it will have less priority than the IP
* white/black above.
*
* @var array
* @defender_property
*/
public $country_whitelist = [];
/**
* Path to downloaded GeoDB.
* Important: This var doesn't support Union Types. So just 'string'.
*
* @var string
* @defender_property
*/
public $geodb_path = null;
/**
* MaxMind license key.
*
* @var string
* @defender_property
* @sanitize sanitize_text_field
*/
public $maxmind_license_key = '';
/**
* @return array
*/
public function get_default_values(): array {
return [
'message' => __( 'The administrator has blocked your IP from accessing this website.', 'wpdef' ),
];
}
protected function before_load(): void {
$default_values = $this->get_default_values();
$whitelist = $this->get_list( 'allowlist' );
$whitelist = array_filter( $whitelist );
$this->ip_whitelist = implode( PHP_EOL, $whitelist );
$this->ip_lockout_message = $default_values['message'];
}
/**
* Add an IP to the list, this should be the **ONLY** way to add an IP to a list.
*
* @param string $ip
* @param string $list blocklist|allowlist
*
* @return void
*/
public function add_to_list( $ip, $list ) {
$arr = $this->get_list( $list );
if ( $this->validate_ip( $ip ) ) {
$arr[] = trim( $ip );
$arr = array_unique( $arr );
if ( 'blocklist' === $list ) {
$this->ip_blacklist = implode( PHP_EOL, $arr );
} elseif ( 'allowlist' === $list ) {
$this->ip_whitelist = implode( PHP_EOL, $arr );
}
$this->save();
}
}
/**
* @param string $ip
* @param string $list
*
* @return bool
*/
public function is_ip_in_list( $ip, $list ): bool {
$arr = $this->get_list( $list );
if ( $this->validate_ip( $ip ) && in_array( $ip, $arr, true ) ) {
return true;
}
return false;
}
/**
* Remove IP from a list.
*
* @param string $ip
* @param string $list blocklist|allowlist
*
* @return void
*/
public function remove_from_list( $ip, $list ) {
$arr = $this->get_list( $list );
$key = array_search( $ip, $arr, true );
if ( false !== $key ) {
unset( $arr[ $key ] );
if ( 'blocklist' === $list ) {
$this->ip_blacklist = implode( PHP_EOL, $arr );
} elseif ( 'allowlist' === $list ) {
$this->ip_whitelist = implode( PHP_EOL, $arr );
}
$this->save();
}
}
/**
* We're going to use this for filter the IPs, as we use textarea to submit, so it can contain some un-valid IPs.
*/
protected function after_validate(): void {
$lists = [
'ip_blacklist' => $this->get_list( 'blocklist' ),
'ip_whitelist' => $this->get_list( 'allowlist' ),
];
$errors = [];
foreach ( $lists as $key => &$list ) {
foreach ( $list as $i => $v ) {
$messages = $this->display_validation_message( $v );
if ( ! empty( $messages ) ) {
unset( $list[ $i ] );
$errors = array_merge( $errors, $messages );
}
}
$this->$key = implode( PHP_EOL, array_filter( $list ) );
}
if ( ! empty( $errors ) ) {
$this->errors[] = __( 'Invalid IP addresses detected. Please fix the following errors:', 'wpdef' );
$this->errors = array_merge( $this->errors, $errors );
}
}
/**
* Get list of blocklisted or allowlisted IPs.
*
* @param string $type blocklist|allowlist.
*
* @return array
*/
public function get_list( $type = 'blocklist' ): array {
// The list should be always strings.
$list = ( 'blocklist' === $type ) ? $this->ip_blacklist : $this->ip_whitelist;
$arr = array_filter( explode( PHP_EOL, $list ) );
$arr = array_map( 'trim', $arr );
return array_map( 'strtolower', $arr );
}
/**
* Get list of blacklisted countries.
*
* @return array
*/
public function get_country_blacklist(): array {
return $this->country_blacklist;
}
/**
* Get list of whitelisted countries.
*
* @return array
*/
public function get_country_whitelist(): array {
return $this->country_whitelist;
}
/**
* Define settings labels.
*
* @return array
*/
public function labels(): array {
return [
'ip_blacklist' => __( 'IP Banning - IP Addresses Blocklist', 'wpdef' ),
'ip_whitelist' => __( 'IP Banning - IP Addresses Allowlist', 'wpdef' ),
'country_blacklist' => __( 'IP Banning - Country Allowlist', 'wpdef' ),
'country_whitelist' => __( 'IP Banning - Country Blocklist', 'wpdef' ),
'ip_lockout_message' => __( 'IP Banning - Lockout Message', 'wpdef' ),
'maxmind_license_key' => __( 'MaxMind license key', 'wpdef' ),
];
}
protected function after_load(): void {
if (
! empty( $this->geodb_path ) &&
is_string( $this->geodb_path ) &&
strlen( $this->geodb_path ) > 0
) {
$maxmind_relative_path = DIRECTORY_SEPARATOR .
'wp-defender' .
DIRECTORY_SEPARATOR .
'maxmind' .
DIRECTORY_SEPARATOR;
$upload_dir = wp_upload_dir()['basedir'];
$maxmind_base_dir = $upload_dir . $maxmind_relative_path;
preg_match( '#.*[\\\/](.*[\\\/].*)$#', $this->geodb_path, $matches );
$this->geodb_path = $maxmind_base_dir . $matches[1];
}
}
}