* @license GPL-3.0
* @link https://iplocationblock.com/
* @copyright 2021 darkog
* @copyright 2013-2019 tokkonopapa
*/
class IP_Location_Block_Admin_Tab {
public static function tab_setup( $context, $tab ) {
$options = IP_Location_Block::get_option();
$plugin_slug = IP_Location_Block::PLUGIN_NAME; // 'ip-location-block'
// common descriptions
$common = array(
'' . __( '(comma separated)', 'ip-location-block' ) . '',
'' . __( '(comma or RET separated)', 'ip-location-block' ) . '',
'',
'',
__( 'Help', 'ip-location-block' ),
__( 'Before adding as “Exception”, please click on “” button (if exists) attached to the following list to confirm that the blocked request is not malicious.', 'ip-location-block' ),
__( 'Open CIDR calculator for IPv4 / IPv6.', 'ip-location-block' ),
);
/**
* Register a setting and its sanitization callback.
* @link https://codex.wordpress.org/Function_Reference/register_setting
*
* register_setting( $option_group, $option_name, $sanitize_callback );
*
* @param string $option_group A settings group name.
* @param string $option_name The name of an option to sanitize and save.
* @param string $sanitize_callback A callback function that sanitizes option values.
*
* @since 0.2.7.0
*/
register_setting(
$option_slug = IP_Location_Block::PLUGIN_NAME, // 'ip-location-block'
$option_name = IP_Location_Block::OPTION_NAME, // 'ip_location_block_settings'
array( $context, 'validate_settings' )
);
/**
* Add new section to a new page inside the existing page.
* @link https://codex.wordpress.org/Function_Reference/add_settings_section
*
* add_settings_section( $id, $title, $callback, $page );
*
* @param string $id String for use in the 'id' attribute of tags.
* @param string $title Title of the section.
* @param string $callback Function that fills the section with the desired content.
* @param string $page The menu page on which to display this section.
*
* @since 0.2.7.0
*/
/*----------------------------------------*
* Validation rules and behavior
*----------------------------------------*/
add_settings_section(
$section = $plugin_slug . '-validation-rule',
array(
__( 'Validation rules and behavior', 'ip-location-block' ),
'' . $common[4] . ''
),
null,
$option_slug
);
/**
* Register a settings field to the settings page and section.
* @link https://codex.wordpress.org/Function_Reference/add_settings_field
*
* add_settings_field( $id, $title, $callback, $page, $section, $args );
*
* @param string $id String for use in the 'id' attribute of tags.
* @param string $title Title of the field.
* @param string $callback Function that fills the field with the desired inputs.
* @param string $page The menu page on which to display this field.
* @param string $section The section of the settings page in which to show the box.
* @param array $args Additional arguments that are passed to the $callback function.
*/
// Get the country code of client
$key = IP_Location_Block::get_geolocation( $val = IP_Location_Block::get_ip_address( $options ) );
add_settings_field(
$option_name . '_ip_client',
__( 'Your IP address / Country', 'ip-location-block' ),
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'html',
'option' => $option_name,
'field' => 'ip_client',
'value' => '' . esc_html( $key['ip'] . ' / ' . ( $key['code'] && isset( $key['provider'] ) ? $key['code'] . ' (' . $key['provider'] . ')' : __( 'n/a', 'ip-location-block' ) ) ) . '',
'after' => ' ' . __( 'Scan country code', 'ip-location-block' ) . '',
)
);
if ( $key = IP_Location_Block_Util::get_server_ip() && $key !== $val && ! IP_Location_Block_Util::is_private_ip( $key ) ):
// Get the country code of server
$key = IP_Location_Block::get_geolocation( $_SERVER['SERVER_ADDR'] );
add_settings_field(
$option_name . '_ip_server',
__( 'Server IP address / Country', 'ip-location-block' ),
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'html',
'option' => $option_name,
'field' => 'ip_server',
'value' => '' . esc_html( $key['ip'] . ' / ' . ( $key['code'] && isset( $key['provider'] ) ? $key['code'] . ' (' . $key['provider'] . ')' : __( 'n/a', 'ip-location-block' ) ) ) . '',
'after' => ' ' . __( 'Scan country code', 'ip-location-block' ) . '',
)
);
endif;
// If the matching rule is not initialized, then add a caution
$rule = array(
- 1 => null,
0 => __( 'Whitelist', 'ip-location-block' ),
1 => __( 'Blacklist', 'ip-location-block' ),
);
$rule_desc = array(
__( 'Please select either “Whitelist” or “Blacklist”.', 'ip-location-block' ),
__( 'Whitelist of country code or pattern', 'ip-location-block' ) . ' (Supported formats)',
__( 'Blacklist of country code or pattern', 'ip-location-block' ) . ' (Supported formats)',
);
// Matching rule
add_settings_field(
$option_name . '_matching_rule',
'' . __( 'Matching rule', 'ip-location-block' ) . '',
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'select',
'option' => $option_name,
'field' => 'matching_rule',
'value' => $options['matching_rule'],
'list' => $rule,
'desc' => array(
- 1 => $rule_desc[0],
0 => __( 'A request from which the country code or IP address is NOT in the whitelist will be blocked.', 'ip-location-block' ),
1 => __( 'A request from which the country code or IP address is in the blacklist will be blocked.', 'ip-location-block' ),
),
'before' => '',
)
);
// Country code for matching rule (ISO 3166-1 alpha-2)
add_settings_field(
$option_name . '_white_list',
$rule_desc[1],
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'text',
'option' => $option_name,
'field' => 'white_list',
'value' => $options['white_list'],
'after' => $common[0],
'class' => $options['matching_rule'] == 0 ? '' : 'ip-location-block-hide',
)
);
add_settings_field(
$option_name . '_black_list',
$rule_desc[2],
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'text',
'option' => $option_name,
'field' => 'black_list',
'value' => $options['black_list'],
'after' => $common[0],
'class' => $options['matching_rule'] == 1 ? '' : 'ip-location-block-hide',
)
);
// Use AS number
$providers = array_keys( IP_Location_Block_Provider::get_providers_by_feature( 'asn' ) );
$description = '
' . sprintf( __( 'Important: Currently supported providers are: %s. If using this feature make sure ONLY those providers are enabled.', 'ip-location-block' ), implode( ', ', $providers ) ) . '
';
$description .= '
' . sprintf( __( 'Some useful tools to find ASN are introduced in “%s”.', 'ip-location-block' ), 'Utilizing AS number' ) . '
';
add_settings_field(
$option_name . '_use_asn',
__( 'Use Autonomous System Number', 'ip-location-block' ) .
' (ASN)',
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'checkbox',
'option' => $option_name,
'field' => 'use_asn',
'value' => isset( $options['use_asn'] ) ? 1 === (int) $options['use_asn'] : 0,
'after' => $description
)
);
// $_SERVER keys to retrieve extra IP addresses
add_settings_field(
$option_name . '_validation_proxy',
__( '$_SERVER keys to retrieve extra IP addresses', 'ip-location-block' ),
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'text',
'option' => $option_name,
'field' => 'validation',
'sub-field' => 'proxy',
'value' => $options['validation']['proxy'],
'placeholder' => IP_Location_Block_Util::get_proxy_var(),
'after' => $common[0],
)
);
// White list of extra IP addresses prior to country code (CIDR, ASN)
add_settings_field(
$option_name . '_extra_ips_white_list',
__( 'Whitelist of extra IP addresses prior to country code/pattern', 'ip-location-block' ) .
' (CIDR' .
', ASN)' .
'',
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'textarea',
'option' => $option_name,
'field' => 'extra_ips',
'sub-field' => 'white_list',
'value' => $options['extra_ips']['white_list'],
'placeholder' => '192.168.0.0/16,2001:db8::/96,AS1234',
'after' => $common[1],
)
);
// Black list of extra IP addresses prior to country code (CIDR, ASN)
add_settings_field(
$option_name . '_extra_ips_black_list',
__( 'Blacklist of extra IP addresses prior to country code/pattern', 'ip-location-block' ) .
' (CIDR' .
', ASN)' .
'',
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'textarea',
'option' => $option_name,
'field' => 'extra_ips',
'sub-field' => 'black_list',
'value' => $options['extra_ips']['black_list'],
'placeholder' => '192.168.0.0/16,2001:db8::/96,AS1234',
'after' => $common[1],
)
);
// Bad signatures
add_settings_field(
$option_name . '_signature',
__( 'Bad signatures in query ()', 'ip-location-block' ),
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'textarea',
'option' => $option_name,
'field' => 'signature',
'value' => $options['signature'],
'after' => $common[1],
)
);
// Prevent malicious upload - white list of file extention and MIME type
$list = '
\n",
)
);
$list = array(
1 => __( 'Block by location', 'ip-location-block' ),
);
$desc = array(
1 => __( 'It will block a request related to the services for both “non-logged in user” and “logged-in user”.', 'ip-location-block' ),
);
// Max failed login attempts per IP address
add_settings_field(
$option_name . '_login_fails',
'
' . __( 'Max failed login attempts per IP address', 'ip-location-block' ) . '
'
)
);
array_unshift( $list, __( 'Disable', 'ip-location-block' ) );
$desc = array(
__( 'Regardless of the country code, it will block a malicious request to %s⋯/*.php.', 'ip-location-block' ),
__( 'Select the item which causes unintended blocking in order to exclude from the validation target. Grayed item indicates “INACTIVE”.', 'ip-location-block' ),
__( 'It configures “%s” to validate a direct request to the PHP file which does not load WordPress core. Make sure to deny direct access to the hidden files beginning with a dot by the server\'s configuration.', 'ip-location-block' ),
__( 'Sorry, but your server type is not supported.', 'ip-location-block' ),
__( 'You need to click “Save Changes” button for imported settings to take effect.', 'ip-location-block' ),
);
// Get all the plugins
$exception = '';
$installed = get_plugins(); // @since 1.5.0
$activated = get_site_option( 'active_sitewide_plugins' ); // @since 0.2.8.0
! is_array( $activated ) and $activated = array();
$activated = array_merge( $activated, array_fill_keys( get_option( 'active_plugins' ), true ) );
// Make a list of installed plugins
foreach ( $installed as $key => $val ) {
$active = isset( $activated[ $key ] );
$key = explode( '/', $key, 2 );
$key = esc_attr( $key[0] );
$exception .= '\n";
}
// Plugins area
$val = esc_html( $path['plugins'] );
add_settings_field(
$option_name . '_validation_plugins',
sprintf( $dfn, $val . '…/*.php', __( 'Plugins area', 'ip-location-block' ) ),
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'select',
'option' => $option_name,
'field' => 'validation',
'sub-field' => 'plugins',
'value' => $options['validation']['plugins'],
'list' => $list,
'desc' => array(),
'after' => '
' . __( 'Database source of SQLite for “Live update”', 'ip-location-block' ) . '
',
array( $context, 'callback_field' ),
$option_slug,
$section,
array(
'type' => 'select',
'option' => $option_name,
'field' => 'live_update',
'sub-field' => 'in_memory',
'value' => extension_loaded( 'pdo_sqlite' ) ? $options['live_update']['in_memory'] : - 1,
'class' => 'ip-location-block-subitem-parent',
'list' => array(
- 1 => null,
0 => __( 'Ordinary file', 'ip-location-block' ),
1 => __( 'In-Memory', 'ip-location-block' ),
),
'desc' => array(
- 1 => __( 'PDO_SQLITE driver not available', 'ip-location-block' ),
0 => __( 'It takes a few tens of milliseconds as overhead. It can be safely used without conflict with other plugins.', 'ip-location-block' ),
1 => __( 'It takes a few milliseconds as overhead. There is a possibility of conflict with other plugins using this method.', 'ip-location-block' ),
),
)
);
// Reset data source of live log
add_settings_field(
$option_name . '_reset_live',
'
', __( 'GeoLite2 / Maxmind and IP2Location will fetch the local databases, others will pass an IP address to the 3rd parties\' API via HTTP.', 'ip-location-block' ), '
', "\n",
'
', __( 'Please select the appropriate APIs to fit the privacy law / regulation in your country / region.', 'ip-location-block' ), '
', "\n",
'
', __( 'Important: Use the IP Loation Block provider want better precision (City Level & State Level blocking), premium support, affordable price and more features. Features like "State Level" and "City Level" blocking require the IP Location Block provider and are NOT compatible with other providers.', 'ip-location-block' ), '
', "\n",
'
', "\n";
}
public static function note_database() {
// https://pecl.php.net/package/phar
if ( ! version_compare( PHP_VERSION, '5.4.0', '>=' ) || ! class_exists( 'PharData', false ) ) {
echo
'
', "\n",
'
', sprintf( __( 'Maxmind GeoLite2 databases and APIs need PHP version 5.4.0+ and %sPECL phar 2.0.0+%s.', 'ip-location-block' ), '', '' ), '
', "\n",
'
', "\n";
}
}
public static function note_public() {
echo
'
', "\n",
'
', sprintf( __( 'Please refer to "%sCompatibility with cache plugins%s" for to read more about caching plugins compatibility.', 'ip-location-block' ), '', '' ), '
', "\n",
'
', "\n";
}
public static function note_privacy() {
}
}