<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Settings\Captcha;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Base captcha settings class.

[5] Fix | Delete

*

[6] Fix | Delete

* @since 1.8.0

[7] Fix | Delete

*/

[8] Fix | Delete

abstract class Captcha {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Saved CAPTCHA settings.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 1.8.0

[14] Fix | Delete

*

[15] Fix | Delete

* @var array

[16] Fix | Delete

*/

[17] Fix | Delete

protected $settings;

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* List of required static properties.

[21] Fix | Delete

*

[22] Fix | Delete

* @since 1.8.0

[23] Fix | Delete

*

[24] Fix | Delete

* @var array

[25] Fix | Delete

*/

[26] Fix | Delete

private $required_static_properties = [

[27] Fix | Delete

'api_var',

[28] Fix | Delete

'slug',

[29] Fix | Delete

'url',

[30] Fix | Delete

];

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Initialize class.

[34] Fix | Delete

*

[35] Fix | Delete

* @since 1.8.0

[36] Fix | Delete

*/

[37] Fix | Delete

public function init() {

[38] Fix | Delete

[39] Fix | Delete

$this->settings = wp_parse_args( wpforms_get_captcha_settings(), [ 'provider' => 'none' ] );

[40] Fix | Delete

[41] Fix | Delete

foreach ( $this->required_static_properties as $property ) {

[42] Fix | Delete

if ( empty( static::${$property} ) ) {

[43] Fix | Delete

// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error

[44] Fix | Delete

trigger_error(

[45] Fix | Delete

sprintf(

[46] Fix | Delete

'The $%s static property is required for a %s class',

[47] Fix | Delete

esc_html( $property ),

[48] Fix | Delete

__CLASS__

[49] Fix | Delete

),

[50] Fix | Delete

E_USER_ERROR

[51] Fix | Delete

);

[52] Fix | Delete

}

[53] Fix | Delete

}

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Array of captcha settings fields.

[58] Fix | Delete

*

[59] Fix | Delete

* @since 1.8.0

[60] Fix | Delete

*

[61] Fix | Delete

* @return array[]

[62] Fix | Delete

*/

[63] Fix | Delete

abstract public function get_settings_fields();

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Get API request url for the captcha preview.

[67] Fix | Delete

*

[68] Fix | Delete

* @since 1.8.0

[69] Fix | Delete

*

[70] Fix | Delete

* @return string

[71] Fix | Delete

*/

[72] Fix | Delete

public function get_api_url() {

[73] Fix | Delete

[74] Fix | Delete

$url = static::$url;

[75] Fix | Delete

[76] Fix | Delete

if ( ! empty( $url ) ) {

[77] Fix | Delete

$url = add_query_arg( $this->get_api_url_query_arg(), $url );

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* Filter API URL.

[82] Fix | Delete

*

[83] Fix | Delete

* @since 1.6.4

[84] Fix | Delete

*

[85] Fix | Delete

* @param string $url API URL.

[86] Fix | Delete

* @param array $settings Captcha settings array.

[87] Fix | Delete

*/

[88] Fix | Delete

return apply_filters( 'wpforms_admin_settings_captcha_get_api_url', $url, $this->settings );

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

/**

[92] Fix | Delete

* Enqueue assets for the CAPTCHA settings page.

[93] Fix | Delete

*

[94] Fix | Delete

* @since 1.8.0

[95] Fix | Delete

*/

[96] Fix | Delete

public function enqueues() {

[97] Fix | Delete

[98] Fix | Delete

/**

[99] Fix | Delete

* Allow/disallow to enquire captcha settings.

[100] Fix | Delete

*

[101] Fix | Delete

* @since 1.6.4

[102] Fix | Delete

*

[103] Fix | Delete

* @param boolean $allow True/false. Default: false.

[104] Fix | Delete

*/

[105] Fix | Delete

$disable_enqueues = apply_filters( 'wpforms_admin_settings_captcha_enqueues_disable', false );

[106] Fix | Delete

[107] Fix | Delete

if ( $disable_enqueues || ! $this->is_captcha_preview_ready() ) {

[108] Fix | Delete

return;

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

$api_url = $this->get_api_url();

[112] Fix | Delete

$provider_name = $this->settings['provider'];

[113] Fix | Delete

$handle = "wpforms-settings-{$provider_name}";

[114] Fix | Delete

[115] Fix | Delete

// phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion

[116] Fix | Delete

wp_enqueue_script( $handle, $api_url, [ 'jquery' ], null, true );

[117] Fix | Delete

wp_add_inline_script( $handle, $this->get_inline_script() );

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

/**

[121] Fix | Delete

* Inline script for initialize captcha JS code.

[122] Fix | Delete

*

[123] Fix | Delete

* @since 1.8.0

[124] Fix | Delete

*

[125] Fix | Delete

* @return string

[126] Fix | Delete

*/

[127] Fix | Delete

protected function get_inline_script() {

[128] Fix | Delete

[129] Fix | Delete

return /** @lang JavaScript */

[130] Fix | Delete

'var wpformsSettingsCaptchaLoad = function() {

[131] Fix | Delete

jQuery( ".wpforms-captcha" ).each( function( index, el ) {

[132] Fix | Delete

var widgetID = ' . static::$api_var . '.render( el );

[133] Fix | Delete

jQuery( el ).attr( "data-captcha-id", widgetID );

[134] Fix | Delete

} );

[135] Fix | Delete

jQuery( document ).trigger( "wpformsSettingsCaptchaLoaded" );

[136] Fix | Delete

};';

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Check if CAPTCHA config is ready to display a preview.

[141] Fix | Delete

*

[142] Fix | Delete

* @since 1.8.0

[143] Fix | Delete

*

[144] Fix | Delete

* @return bool

[145] Fix | Delete

*/

[146] Fix | Delete

public function is_captcha_preview_ready() {

[147] Fix | Delete

[148] Fix | Delete

return (

[149] Fix | Delete

( $this->settings['provider'] === static::$slug || ( $this->settings['provider'] === 'recaptcha' && $this->settings['recaptcha_type'] === 'v2' ) ) &&

[150] Fix | Delete

! empty( $this->settings['site_key'] ) &&

[151] Fix | Delete

! empty( $this->settings['secret_key'] )

[152] Fix | Delete

);

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

/**

[156] Fix | Delete

* Retrieve query arguments for the CAPTCHA API URL.

[157] Fix | Delete

*

[158] Fix | Delete

* @since 1.8.0

[159] Fix | Delete

*

[160] Fix | Delete

* @return array

[161] Fix | Delete

*/

[162] Fix | Delete

protected function get_api_url_query_arg() {

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* Modify captcha api url parameters.

[166] Fix | Delete

*

[167] Fix | Delete

* @since 1.8.0

[168] Fix | Delete

*

[169] Fix | Delete

* @param array $params Array of parameters.

[170] Fix | Delete

* @param array $params Saved CAPTCHA settings.

[171] Fix | Delete

*/

[172] Fix | Delete

return (array) apply_filters(

[173] Fix | Delete

'wpforms_admin_settings_captcha_get_api_url_query_arg',

[174] Fix | Delete

[

[175] Fix | Delete

'onload' => 'wpformsSettingsCaptchaLoad',

[176] Fix | Delete

'render' => 'explicit',

[177] Fix | Delete

],

[178] Fix | Delete

$this->settings

[179] Fix | Delete

);

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

/**

[183] Fix | Delete

* Heading description.

[184] Fix | Delete

*

[185] Fix | Delete

* @since 1.8.0

[186] Fix | Delete

*

[187] Fix | Delete

* @return string

[188] Fix | Delete

*/

[189] Fix | Delete

public function get_field_desc() {

[190] Fix | Delete

[191] Fix | Delete

$content = wpforms_render( 'admin/settings/' . static::$slug . '-description' );

[192] Fix | Delete

[193] Fix | Delete

return wpforms_render( 'admin/settings/specific-note', [ 'content' => $content ], true );

[194] Fix | Delete

}

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete