<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Ipstack class

[2] Fix | Delete

*

[3] Fix | Delete

* @package ZeroSpam

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

namespace ZeroSpam\Modules;

[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

* Ipstack

[13] Fix | Delete

*/

[14] Fix | Delete

class ipstack {

[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( 'zerospam_log_record', array( $this, 'log_record' ) );

[29] Fix | Delete

}

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Admin setting sections

[33] Fix | Delete

*

[34] Fix | Delete

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

[35] Fix | Delete

*/

[36] Fix | Delete

public function sections( $sections ) {

[37] Fix | Delete

$sections['ipstack'] = array(

[38] Fix | Delete

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

[39] Fix | Delete

'icon' => 'assets/img/icon-ipstack.svg',

[40] Fix | Delete

);

[41] Fix | Delete

[42] Fix | Delete

return $sections;

[43] Fix | Delete

}

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Admin settings

[47] Fix | Delete

*

[48] Fix | Delete

* @param array $settings Array of available settings.

[49] Fix | Delete

*/

[50] Fix | Delete

public function settings( $settings ) {

[51] Fix | Delete

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

[52] Fix | Delete

[53] Fix | Delete

$settings['ipstack_api'] = array(

[54] Fix | Delete

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

[55] Fix | Delete

'desc' => sprintf(

[56] Fix | Delete

wp_kses(

[57] Fix | Delete

/* translators: %1$s: Replaced with the ipstack URL, %2$s: Replaced with the ipstack product URL */

[58] Fix | Delete

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

[59] Fix | Delete

array(

[60] Fix | Delete

'strong' => array(),

[61] Fix | Delete

'a' => array(

[62] Fix | Delete

'target' => array(),

[63] Fix | Delete

'href' => array(),

[64] Fix | Delete

'rel' => array(),

[65] Fix | Delete

),

[66] Fix | Delete

)

[67] Fix | Delete

),

[68] Fix | Delete

esc_url( 'https://ipstack.com?fpr=zerospam' ),

[69] Fix | Delete

esc_url( 'https://ipstack.com/product?fpr=zerospam' )

[70] Fix | Delete

),

[71] Fix | Delete

'section' => 'ipstack',

[72] Fix | Delete

'module' => 'ipstack',

[73] Fix | Delete

'type' => 'text',

[74] Fix | Delete

'field_class' => 'regular-text',

[75] Fix | Delete

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

[76] Fix | Delete

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

[77] Fix | Delete

);

[78] Fix | Delete

[79] Fix | Delete

$settings['ipstack_timeout'] = array(

[80] Fix | Delete

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

[81] Fix | Delete

'section' => 'ipstack',

[82] Fix | Delete

'module' => 'ipstack',

[83] Fix | Delete

'type' => 'number',

[84] Fix | Delete

'field_class' => 'small-text',

[85] Fix | Delete

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

[86] Fix | Delete

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

[87] Fix | Delete

'desc' => __( 'Setting to high could result in degraded site performance, too low won\'t allow to API enough time to respond; recommended 5 seconds.', 'zero-spam' ),

[88] Fix | Delete

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

[89] Fix | Delete

'recommended' => 5,

[90] Fix | Delete

);

[91] Fix | Delete

[92] Fix | Delete

$settings['ipstack_cache'] = array(

[93] Fix | Delete

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

[94] Fix | Delete

'section' => 'ipstack',

[95] Fix | Delete

'module' => 'ipstack',

[96] Fix | Delete

'type' => 'number',

[97] Fix | Delete

'field_class' => 'small-text',

[98] Fix | Delete

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

[99] Fix | Delete

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

[100] Fix | Delete

'desc' => __( 'Setting to high could result in outdated information, too low could cause a decrease in performance; recommended 14 days.', 'zero-spam' ),

[101] Fix | Delete

'value' => ! empty( $options['ipstack_cache'] ) ? $options['ipstack_cache'] : 14,

[102] Fix | Delete

'recommended' => 14,

[103] Fix | Delete

);

[104] Fix | Delete

[105] Fix | Delete

return $settings;

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Log record filter.

[110] Fix | Delete

*

[111] Fix | Delete

* @param array $record DB record entry.

[112] Fix | Delete

*/

[113] Fix | Delete

public static function log_record( $record ) {

[114] Fix | Delete

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

[115] Fix | Delete

if ( $location ) {

[116] Fix | Delete

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

[117] Fix | Delete

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

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

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

[121] Fix | Delete

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

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

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

[125] Fix | Delete

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

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

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

[129] Fix | Delete

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

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

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

[133] Fix | Delete

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

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

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

[137] Fix | Delete

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

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

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

[141] Fix | Delete

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

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

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

[145] Fix | Delete

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

[146] Fix | Delete

}

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

return $record;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Get geolocation

[154] Fix | Delete

*

[155] Fix | Delete

* @param string $ip IP address.

[156] Fix | Delete

*/

[157] Fix | Delete

public static function get_geolocation( $ip ) {

[158] Fix | Delete

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

[159] Fix | Delete

[160] Fix | Delete

if ( empty( $settings['ipstack_api']['value'] ) ) {

[161] Fix | Delete

return false;

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

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

[165] Fix | Delete

array(

[166] Fix | Delete

'ipstack',

[167] Fix | Delete

$ip,

[168] Fix | Delete

)

[169] Fix | Delete

);

[170] Fix | Delete

[171] Fix | Delete

$result = wp_cache_get( $cache_key );

[172] Fix | Delete

if ( false === $result ) {

[173] Fix | Delete

$endpoint = 'http://api.ipstack.com/';

[174] Fix | Delete

$endpoint .= $ip . '?access_key=' . $settings['ipstack_api']['value'];

[175] Fix | Delete

[176] Fix | Delete

$timeout = 5;

[177] Fix | Delete

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

[178] Fix | Delete

$timeout = intval( $settings['ipstack_timeout']['value'] );

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

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

[182] Fix | Delete

if ( $response ) {

[183] Fix | Delete

$result = json_decode( $response, true );

[184] Fix | Delete

[185] Fix | Delete

if ( ! empty( $result ) && ! empty( $result['error'] ) ) {

[186] Fix | Delete

\ZeroSpam\Core\Utilities::log( 'ipstack: ' . wp_json_encode( $result['error'] ) );

[187] Fix | Delete

[188] Fix | Delete

return false;

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

$expiration = 14 * DAY_IN_SECONDS;

[192] Fix | Delete

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

[193] Fix | Delete

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

[194] Fix | Delete

}

[195] Fix | Delete

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

[196] Fix | Delete

}

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

return $result;

[200] Fix | Delete

}

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete