<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Adds integration for ipbase.com IP lookup service

[2] Fix | Delete

*

[3] Fix | Delete

* @package ZeroSpam

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

namespace ZeroSpam\Modules\ipbase;

[7] Fix | Delete

[8] Fix | Delete

// Security Note: Blocks direct access to the plugin PHP files.

[9] Fix | Delete

defined( 'ABSPATH' ) || die();

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* ipbase

[13] Fix | Delete

*/

[14] Fix | Delete

class ipbase {

[15] Fix | Delete

/**

[16] Fix | Delete

* Constructor

[17] Fix | Delete

*/

[18] Fix | Delete

public function __construct() {

[19] Fix | Delete

add_action( 'init', array( $this, 'init' ) );

[20] Fix | Delete

}

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Fires after WordPress has finished loading but before any headers are sent

[24] Fix | Delete

*/

[25] Fix | Delete

public function init() {

[26] Fix | Delete

add_filter( 'zerospam_setting_sections', array( $this, 'sections' ) );

[27] Fix | Delete

add_filter( 'zerospam_settings', array( $this, 'settings' ), 10, 1 );

[28] Fix | Delete

add_filter( 'zero_spam_ip_address_details', array( $this, 'ip_address_details' ), 10, 2 );

[29] Fix | Delete

add_filter( 'zerospam_log_record', array( $this, 'log_record' ) );

[30] Fix | Delete

}

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Log record filter.

[34] Fix | Delete

*

[35] Fix | Delete

* @param array $record DB record entry.

[36] Fix | Delete

*/

[37] Fix | Delete

public function log_record( $record ) {

[38] Fix | Delete

$location = self::ip_address_details( $record['user_ip'] );

[39] Fix | Delete

if ( $location ) {

[40] Fix | Delete

[41] Fix | Delete

$location = json_decode( wp_json_encode( $location ), true );

[42] Fix | Delete

[43] Fix | Delete

if ( ! empty( $location['country_code'] ) ) {

[44] Fix | Delete

$record['country'] = $location['country_code'];

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

if ( ! empty( $location['country_name'] ) ) {

[48] Fix | Delete

$record['country_name'] = $location['country_name'];

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

if ( ! empty( $location['region_code'] ) ) {

[52] Fix | Delete

$record['region'] = $location['region_code'];

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

if ( ! empty( $location['region_name'] ) ) {

[56] Fix | Delete

$record['region_name'] = $location['region_name'];

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

if ( ! empty( $location['city'] ) ) {

[60] Fix | Delete

$record['city'] = $location['city'];

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

if ( ! empty( $location['latitude'] ) ) {

[64] Fix | Delete

$record['latitude'] = $location['latitude'];

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

if ( ! empty( $location['longitude'] ) ) {

[68] Fix | Delete

$record['longitude'] = $location['longitude'];

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

if ( ! empty( $location['postal'] ) ) {

[72] Fix | Delete

$record['zip'] = $location['postal'];

[73] Fix | Delete

}

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

return $record;

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Admin setting sections

[81] Fix | Delete

*

[82] Fix | Delete

* @param array $sections Array of admin setting sections.

[83] Fix | Delete

*/

[84] Fix | Delete

public function sections( $sections ) {

[85] Fix | Delete

$sections['ipbase'] = array(

[86] Fix | Delete

'title' => __( 'ipbase (geolocation)', 'zero-spam' ),

[87] Fix | Delete

'icon' => 'modules/ipbase/icon-ipbase.svg',

[88] Fix | Delete

);

[89] Fix | Delete

[90] Fix | Delete

return $sections;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Admin settings

[95] Fix | Delete

*

[96] Fix | Delete

* @param array $settings Array of available settings.

[97] Fix | Delete

*/

[98] Fix | Delete

public function settings( $settings ) {

[99] Fix | Delete

$options = get_option( 'zero-spam-ipbase' );

[100] Fix | Delete

[101] Fix | Delete

$settings['ipbase_api_key'] = array(

[102] Fix | Delete

'title' => __( 'API Key', 'zero-spam' ),

[103] Fix | Delete

'desc' => sprintf(

[104] Fix | Delete

wp_kses(

[105] Fix | Delete

/* translators: %1$s: Replaced with the ipbase URL */

[106] Fix | Delete

__( 'Enter your ipbase API key. Don\'t have an API key? <a href="%1$s" target="_blank" rel="noopener noreferrer"><strong>Get one for free!</strong></a>', 'zero-spam' ),

[107] Fix | Delete

array(

[108] Fix | Delete

'strong' => array(),

[109] Fix | Delete

'a' => array(

[110] Fix | Delete

'target' => array(),

[111] Fix | Delete

'href' => array(),

[112] Fix | Delete

'rel' => array(),

[113] Fix | Delete

),

[114] Fix | Delete

)

[115] Fix | Delete

),

[116] Fix | Delete

esc_url( 'https://app.ipbase.com/register' )

[117] Fix | Delete

),

[118] Fix | Delete

'module' => 'ipbase',

[119] Fix | Delete

'type' => 'text',

[120] Fix | Delete

'field_class' => 'regular-text',

[121] Fix | Delete

'placeholder' => __( 'Enter your ipbase API key.', 'zero-spam' ),

[122] Fix | Delete

'value' => ! empty( $options['ipbase_api_key'] ) ? $options['ipbase_api_key'] : false,

[123] Fix | Delete

);

[124] Fix | Delete

[125] Fix | Delete

$settings['ipbase_api_timeout'] = array(

[126] Fix | Delete

'title' => __( 'API Timeout', 'zero-spam' ),

[127] Fix | Delete

'module' => 'ipbase',

[128] Fix | Delete

'type' => 'number',

[129] Fix | Delete

'field_class' => 'small-text',

[130] Fix | Delete

'suffix' => __( 'seconds', 'zero-spam' ),

[131] Fix | Delete

'placeholder' => __( '5', 'zero-spam' ),

[132] Fix | Delete

'desc' => __( 'Controls how long to wait for the api to return a response, 5 seconds is recommended. Too high could result in degraded performance, too low & it won\'t have time to respond.', 'zero-spam' ),

[133] Fix | Delete

'value' => ! empty( $options['ipbase_api_timeout'] ) ? $options['ipbase_api_timeout'] : 5,

[134] Fix | Delete

'recommended' => 5,

[135] Fix | Delete

);

[136] Fix | Delete

[137] Fix | Delete

$settings['ipbase_cache'] = array(

[138] Fix | Delete

'title' => __( 'Cache Expiration', 'zero-spam' ),

[139] Fix | Delete

'module' => 'ipbase',

[140] Fix | Delete

'type' => 'number',

[141] Fix | Delete

'field_class' => 'small-text',

[142] Fix | Delete

'suffix' => __( 'day(s)', 'zero-spam' ),

[143] Fix | Delete

'placeholder' => __( 'Number of days', 'zero-spam' ),

[144] Fix | Delete

'desc' => __( 'Controls how long IP data is cached, 30 days is recommended. Too low could result in degraded performance.', 'zero-spam' ),

[145] Fix | Delete

'value' => ! empty( $options['ipbase_cache'] ) ? $options['ipbase_cache'] : 30,

[146] Fix | Delete

'recommended' => 30,

[147] Fix | Delete

);

[148] Fix | Delete

[149] Fix | Delete

return $settings;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Returns an IP addresses' details

[154] Fix | Delete

*

[155] Fix | Delete

* @param string $ip_address_details IP address details.

[156] Fix | Delete

*/

[157] Fix | Delete

public function ip_address_details( $ip_address, $ip_address_details = [] ) {

[158] Fix | Delete

$response_mapping = array(

[159] Fix | Delete

'country_code' => 'country_code',

[160] Fix | Delete

'country_name' => 'country_name',

[161] Fix | Delete

'region_code' => 'region_code',

[162] Fix | Delete

'region_name' => 'region_name',

[163] Fix | Delete

'city' => 'city',

[164] Fix | Delete

'zip_code' => 'zip',

[165] Fix | Delete

'time_zone' => 'timezone',

[166] Fix | Delete

'latitude' => 'latitude',

[167] Fix | Delete

'longitude' => 'longitude',

[168] Fix | Delete

);

[169] Fix | Delete

[170] Fix | Delete

$api_response = self::query_ip_address( $ip_address );

[171] Fix | Delete

if ( $api_response ) {

[172] Fix | Delete

foreach ( $response_mapping as $api_key => $details_key ) {

[173] Fix | Delete

if ( ! empty( $api_response[ $api_key ] ) ) {

[174] Fix | Delete

$ip_address_details[ $details_key ] = sanitize_text_field( $api_response[ $api_key ] );

[175] Fix | Delete

}

[176] Fix | Delete

}

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

return $ip_address_details;

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

/**

[183] Fix | Delete

* Query an IP address

[184] Fix | Delete

*

[185] Fix | Delete

* @param string $ip_address IP address to query.

[186] Fix | Delete

*/

[187] Fix | Delete

public static function query_ip_address( $ip_address ) {

[188] Fix | Delete

$plugin_settings = \ZeroSpam\Core\Settings::get_settings();

[189] Fix | Delete

[190] Fix | Delete

if ( empty( $plugin_settings['ipbase_api_key']['value'] ) || ! rest_is_ip_address( $ip_address ) ) {

[191] Fix | Delete

return false;

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

$queried_cache_key = \ZeroSpam\Core\Utilities::cache_key(

[195] Fix | Delete

array(

[196] Fix | Delete

'ipinfo',

[197] Fix | Delete

$ip_address,

[198] Fix | Delete

)

[199] Fix | Delete

);

[200] Fix | Delete

[201] Fix | Delete

$result = wp_cache_get( $queried_cache_key );

[202] Fix | Delete

if ( false === $result ) {

[203] Fix | Delete

$endpoint = esc_url( "https://api.ipbase.com/json/$ip_address?apikey=" . $plugin_settings['ipbase_api_key']['value'] );

[204] Fix | Delete

[205] Fix | Delete

$response_timeout = 5;

[206] Fix | Delete

if ( ! empty( $settings['ipbase_api_timeout'] ) ) {

[207] Fix | Delete

$response_timeout = intval( $settings['ipbase_api_timeout']['value'] );

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

$response = \ZeroSpam\Core\Utilities::remote_get( $endpoint, array( 'timeout' => $response_timeout ) );

[211] Fix | Delete

if ( $response ) {

[212] Fix | Delete

$result = json_decode( $response, true );

[213] Fix | Delete

[214] Fix | Delete

if ( empty( $result ) || ! empty( $result['message'] ) ) {

[215] Fix | Delete

\ZeroSpam\Core\Utilities::log( 'ipbase_api: ' . $result['message'] );

[216] Fix | Delete

return false;

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

$cache_expiration = 14 * DAY_IN_SECONDS;

[220] Fix | Delete

if ( ! empty( $settings['ipbase_cache']['value'] ) ) {

[221] Fix | Delete

$expiration = $settings['ipbase_cache']['value'] * DAY_IN_SECONDS;

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

wp_cache_set( $cache_key, $result, 'zerospam', $expiration );

[225] Fix | Delete

}

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

return $result;

[229] Fix | Delete

}

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete