<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Settings\Captcha;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Admin\Notice;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* CAPTCHA setting page.

[7] Fix | Delete

*

[8] Fix | Delete

* @since 1.8.0

[9] Fix | Delete

*/

[10] Fix | Delete

class Page {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Slug identifier for admin page view.

[14] Fix | Delete

*

[15] Fix | Delete

* @since 1.8.0

[16] Fix | Delete

*

[17] Fix | Delete

* @var string

[18] Fix | Delete

*/

[19] Fix | Delete

const VIEW = 'captcha';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Saved CAPTCHA settings.

[23] Fix | Delete

*

[24] Fix | Delete

* @since 1.8.0

[25] Fix | Delete

*

[26] Fix | Delete

* @var array

[27] Fix | Delete

*/

[28] Fix | Delete

private $settings;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* All available captcha types.

[32] Fix | Delete

*

[33] Fix | Delete

* @since 1.8.0

[34] Fix | Delete

*

[35] Fix | Delete

* @var array

[36] Fix | Delete

*/

[37] Fix | Delete

private $captchas;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Initialize class.

[41] Fix | Delete

*

[42] Fix | Delete

* @since 1.8.0

[43] Fix | Delete

*/

[44] Fix | Delete

public function init() {

[45] Fix | Delete

[46] Fix | Delete

// Only load if we are actually on the settings page.

[47] Fix | Delete

if ( ! wpforms_is_admin_page( 'settings' ) ) {

[48] Fix | Delete

return;

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

// Listen the previous reCAPTCHA page and safely redirect from it.

[52] Fix | Delete

if ( wpforms_is_admin_page( 'settings', 'recaptcha' ) ) {

[53] Fix | Delete

wp_safe_redirect( add_query_arg( 'view', self::VIEW, admin_url( 'admin.php?page=wpforms-settings' ) ) );

[54] Fix | Delete

exit;

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

$this->init_settings();

[58] Fix | Delete

$this->hooks();

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* Init CAPTCHA settings.

[63] Fix | Delete

*

[64] Fix | Delete

* @since 1.8.0

[65] Fix | Delete

*/

[66] Fix | Delete

public function init_settings() {

[67] Fix | Delete

[68] Fix | Delete

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

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Filter available captcha for the settings page.

[72] Fix | Delete

*

[73] Fix | Delete

* @since 1.8.0

[74] Fix | Delete

*

[75] Fix | Delete

* @param array $captcha Array where key is captcha name and value is captcha class instance.

[76] Fix | Delete

* @param array $settings Array of settings.

[77] Fix | Delete

*/

[78] Fix | Delete

$this->captchas = apply_filters(

[79] Fix | Delete

'wpforms_admin_settings_captcha_page_init_settings_available_captcha',

[80] Fix | Delete

[

[81] Fix | Delete

'hcaptcha' => new HCaptcha(),

[82] Fix | Delete

'recaptcha' => new ReCaptcha(),

[83] Fix | Delete

'turnstile' => new Turnstile(),

[84] Fix | Delete

],

[85] Fix | Delete

$this->settings

[86] Fix | Delete

);

[87] Fix | Delete

[88] Fix | Delete

foreach ( $this->captchas as $captcha ) {

[89] Fix | Delete

$captcha->init();

[90] Fix | Delete

}

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Hooks.

[95] Fix | Delete

*

[96] Fix | Delete

* @since 1.8.0

[97] Fix | Delete

*/

[98] Fix | Delete

public function hooks() {

[99] Fix | Delete

[100] Fix | Delete

add_filter( 'wpforms_settings_tabs', [ $this, 'register_settings_tabs' ], 5, 1 );

[101] Fix | Delete

add_filter( 'wpforms_settings_defaults', [ $this, 'register_settings_fields' ], 5, 1 );

[102] Fix | Delete

add_action( 'wpforms_settings_updated', [ $this, 'updated' ] );

[103] Fix | Delete

add_action( 'wpforms_settings_enqueue', [ $this, 'enqueues' ] );

[104] Fix | Delete

add_action( 'admin_enqueue_scripts', [ $this, 'apply_noconflict' ], 9999 );

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Register CAPTCHA settings tab.

[109] Fix | Delete

*

[110] Fix | Delete

* @since 1.8.0

[111] Fix | Delete

*

[112] Fix | Delete

* @param array $tabs Admin area tabs list.

[113] Fix | Delete

*

[114] Fix | Delete

* @return array

[115] Fix | Delete

*/

[116] Fix | Delete

public function register_settings_tabs( $tabs ) {

[117] Fix | Delete

[118] Fix | Delete

$captcha = [

[119] Fix | Delete

self::VIEW => [

[120] Fix | Delete

'name' => esc_html__( 'CAPTCHA', 'wpforms-lite' ),

[121] Fix | Delete

'form' => true,

[122] Fix | Delete

'submit' => esc_html__( 'Save Settings', 'wpforms-lite' ),

[123] Fix | Delete

],

[124] Fix | Delete

];

[125] Fix | Delete

[126] Fix | Delete

return wpforms_array_insert( $tabs, $captcha, 'email' );

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Register CAPTCHA settings fields.

[131] Fix | Delete

*

[132] Fix | Delete

* @since 1.8.0

[133] Fix | Delete

*

[134] Fix | Delete

* @param array $settings Admin area settings list.

[135] Fix | Delete

*

[136] Fix | Delete

* @return array

[137] Fix | Delete

*/

[138] Fix | Delete

public function register_settings_fields( $settings ) {

[139] Fix | Delete

[140] Fix | Delete

$settings[ self::VIEW ] = [

[141] Fix | Delete

self::VIEW . '-heading' => [

[142] Fix | Delete

'id' => self::VIEW . '-heading',

[143] Fix | Delete

'content' => '<h4>' . esc_html__( 'CAPTCHA', 'wpforms-lite' ) . '</h4><p>' . esc_html__( 'A CAPTCHA is an anti-spam technique which helps to protect your website from spam and abuse while letting real people pass through with ease.', 'wpforms-lite' ) . '</p>',

[144] Fix | Delete

'type' => 'content',

[145] Fix | Delete

'no_label' => true,

[146] Fix | Delete

'class' => [ 'wpforms-setting-captcha-heading', 'section-heading' ],

[147] Fix | Delete

],

[148] Fix | Delete

self::VIEW . '-provider' => [

[149] Fix | Delete

'id' => self::VIEW . '-provider',

[150] Fix | Delete

'type' => 'radio',

[151] Fix | Delete

'default' => 'none',

[152] Fix | Delete

'options' => [

[153] Fix | Delete

'hcaptcha' => 'hCaptcha',

[154] Fix | Delete

'recaptcha' => 'reCAPTCHA',

[155] Fix | Delete

'turnstile' => 'Turnstile',

[156] Fix | Delete

'none' => esc_html__( 'None', 'wpforms-lite' ),

[157] Fix | Delete

],

[158] Fix | Delete

'desc' => sprintf(

[159] Fix | Delete

wp_kses( /* translators: %s - WPForms.com CAPTCHA comparison page URL. */

[160] Fix | Delete

__( 'Not sure which service is right for you? <a href="%s" target="_blank" rel="noopener noreferrer">Check out our comparison</a> for more details.', 'wpforms-lite' ),

[161] Fix | Delete

[

[162] Fix | Delete

'a' => [

[163] Fix | Delete

'href' => [],

[164] Fix | Delete

'target' => [],

[165] Fix | Delete

'rel' => [],

[166] Fix | Delete

],

[167] Fix | Delete

]

[168] Fix | Delete

),

[169] Fix | Delete

esc_url( wpforms_utm_link( 'https://wpforms.com/docs/setup-captcha-wpforms/', 'Settings - Captcha', 'Captcha Comparison Documentation' ) )

[170] Fix | Delete

),

[171] Fix | Delete

],

[172] Fix | Delete

];

[173] Fix | Delete

[174] Fix | Delete

// Add settings fields for each of available captcha types.

[175] Fix | Delete

foreach ( $this->captchas as $captcha ) {

[176] Fix | Delete

$settings[ self::VIEW ] = array_merge( $settings[ self::VIEW ], $captcha->get_settings_fields() );

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

$settings[ self::VIEW ] = array_merge(

[180] Fix | Delete

$settings[ self::VIEW ],

[181] Fix | Delete

[

[182] Fix | Delete

'recaptcha-noconflict' => [

[183] Fix | Delete

'id' => 'recaptcha-noconflict',

[184] Fix | Delete

'name' => esc_html__( 'No-Conflict Mode', 'wpforms-lite' ),

[185] Fix | Delete

'desc' => esc_html__( 'Forcefully remove other CAPTCHA occurrences in order to prevent conflicts. Only enable this option if your site is having compatibility issues or instructed by support.', 'wpforms-lite' ),

[186] Fix | Delete

'type' => 'toggle',

[187] Fix | Delete

'status' => true,

[188] Fix | Delete

],

[189] Fix | Delete

self::VIEW . '-preview' =>

[190] Fix | Delete

[

[191] Fix | Delete

'id' => self::VIEW . '-preview',

[192] Fix | Delete

'name' => esc_html__( 'Preview', 'wpforms-lite' ),

[193] Fix | Delete

'content' => '<p class="desc wpforms-captcha-preview-desc">' . esc_html__( 'Please save settings to generate a preview of your CAPTCHA here.', 'wpforms-lite' ) . '</p>',

[194] Fix | Delete

'type' => 'content',

[195] Fix | Delete

'class' => [ 'wpforms-hidden' ],

[196] Fix | Delete

],

[197] Fix | Delete

]

[198] Fix | Delete

);

[199] Fix | Delete

[200] Fix | Delete

if (

[201] Fix | Delete

$this->settings['provider'] === 'hcaptcha' ||

[202] Fix | Delete

$this->settings['provider'] === 'turnstile' ||

[203] Fix | Delete

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

[204] Fix | Delete

) {

[205] Fix | Delete

[206] Fix | Delete

// phpcs:disable WPForms.PHP.ValidateHooks.InvalidHookName

[207] Fix | Delete

[208] Fix | Delete

/**

[209] Fix | Delete

* Modify captcha settings data.

[210] Fix | Delete

*

[211] Fix | Delete

* @since 1.6.4

[212] Fix | Delete

*

[213] Fix | Delete

* @param array $data Array of settings.

[214] Fix | Delete

*/

[215] Fix | Delete

$data = apply_filters(

[216] Fix | Delete

'wpforms_admin_pages_settings_captcha_data',

[217] Fix | Delete

[

[218] Fix | Delete

'sitekey' => $this->settings['site_key'],

[219] Fix | Delete

'theme' => $this->settings['theme'],

[220] Fix | Delete

]

[221] Fix | Delete

);

[222] Fix | Delete

// phpcs:enable WPForms.PHP.ValidateHooks.InvalidHookName

[223] Fix | Delete

[224] Fix | Delete

// Prepare HTML for CAPTCHA preview.

[225] Fix | Delete

$placeholder_description = $settings[ self::VIEW ][ self::VIEW . '-preview' ]['content'];

[226] Fix | Delete

$captcha_description = esc_html__( 'This CAPTCHA is generated using your site and secret keys. If an error is displayed, please double-check your keys.', 'wpforms-lite' );

[227] Fix | Delete

$captcha_preview = sprintf(

[228] Fix | Delete

'<div class="wpforms-captcha-container" style="pointer-events:none!important;cursor:default!important;">

[229] Fix | Delete

<div %s></div>

[230] Fix | Delete

<input type="text" name="wpforms-captcha-hidden" class="wpforms-recaptcha-hidden" style="position:absolute!important;clip:rect(0,0,0,0)!important;height:1px!important;width:1px!important;border:0!important;overflow:hidden!important;padding:0!important;margin:0!important;">

[231] Fix | Delete

</div>',

[232] Fix | Delete

wpforms_html_attributes( '', [ 'wpforms-captcha', 'wpforms-captcha-' . $this->settings['provider'] ], $data )

[233] Fix | Delete

);

[234] Fix | Delete

[235] Fix | Delete

$settings[ self::VIEW ][ self::VIEW . '-preview' ]['content'] = sprintf(

[236] Fix | Delete

'<div class="wpforms-captcha-preview">

[237] Fix | Delete

%1$s <p class="desc">%2$s</p>

[238] Fix | Delete

</div>

[239] Fix | Delete

<div class="wpforms-captcha-placeholder wpforms-hidden">%3$s</div>',

[240] Fix | Delete

$captcha_preview,

[241] Fix | Delete

$captcha_description,

[242] Fix | Delete

$placeholder_description

[243] Fix | Delete

);

[244] Fix | Delete

$settings[ self::VIEW ][ self::VIEW . '-preview' ]['class'] = [];

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

return $settings;

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

/**

[251] Fix | Delete

* Re-init CAPTCHA settings when plugin settings were updated.

[252] Fix | Delete

*

[253] Fix | Delete

* @since 1.8.0

[254] Fix | Delete

*/

[255] Fix | Delete

public function updated() {

[256] Fix | Delete

[257] Fix | Delete

$this->init_settings();

[258] Fix | Delete

$this->notice();

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

/**

[262] Fix | Delete

* Display notice about the CAPTCHA preview.

[263] Fix | Delete

*

[264] Fix | Delete

* @since 1.8.0

[265] Fix | Delete

*/

[266] Fix | Delete

private function notice() {

[267] Fix | Delete

[268] Fix | Delete

if ( ! wpforms_is_admin_page( 'settings', self::VIEW ) || ! $this->is_captcha_preview_ready() ) {

[269] Fix | Delete

return;

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

Notice::info( esc_html__( 'A preview of your CAPTCHA is displayed below. Please view to verify the CAPTCHA settings are correct.', 'wpforms-lite' ) );

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

/**

[276] Fix | Delete

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

[277] Fix | Delete

*

[278] Fix | Delete

* @since 1.8.0

[279] Fix | Delete

*

[280] Fix | Delete

* @return bool

[281] Fix | Delete

*/

[282] Fix | Delete

private function is_captcha_preview_ready() {

[283] Fix | Delete

[284] Fix | Delete

$current_captcha = $this->get_current_captcha();

[285] Fix | Delete

[286] Fix | Delete

if ( ! $current_captcha ) {

[287] Fix | Delete

return false;

[288] Fix | Delete

}

[289] Fix | Delete

[290] Fix | Delete

return $current_captcha->is_captcha_preview_ready();

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

/**

[294] Fix | Delete

* Enqueue assets for the CAPTCHA settings page.

[295] Fix | Delete

*

[296] Fix | Delete

* @since 1.8.0

[297] Fix | Delete

*/

[298] Fix | Delete

public function enqueues() {

[299] Fix | Delete

[300] Fix | Delete

$current_captcha = $this->get_current_captcha();

[301] Fix | Delete

[302] Fix | Delete

if ( ! $current_captcha ) {

[303] Fix | Delete

return;

[304] Fix | Delete

}

[305] Fix | Delete

[306] Fix | Delete

$current_captcha->enqueues();

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

/**

[310] Fix | Delete

* Get current active captcha object.

[311] Fix | Delete

*

[312] Fix | Delete

* @since 1.8.0

[313] Fix | Delete

*

[314] Fix | Delete

* @return object|string

[315] Fix | Delete

*/

[316] Fix | Delete

private function get_current_captcha() {

[317] Fix | Delete

[318] Fix | Delete

return ! empty( $this->captchas[ $this->settings['provider'] ] ) ? $this->captchas[ $this->settings['provider'] ] : '';

[319] Fix | Delete

}

[320] Fix | Delete

[321] Fix | Delete

/**

[322] Fix | Delete

* Use the CAPTCHA no-conflict mode.

[323] Fix | Delete

*

[324] Fix | Delete

* When enabled in the WPForms settings, forcefully remove all other

[325] Fix | Delete

* CAPTCHA enqueues to prevent conflicts. Filter can be used to target

[326] Fix | Delete

* specific pages, etc.

[327] Fix | Delete

*

[328] Fix | Delete

* @since 1.6.4

[329] Fix | Delete

*/

[330] Fix | Delete

public function apply_noconflict() {

[331] Fix | Delete

[332] Fix | Delete

if (

[333] Fix | Delete

! wpforms_is_admin_page( 'settings', self::VIEW ) ||

[334] Fix | Delete

empty( wpforms_setting( 'recaptcha-noconflict' ) ) ||

[335] Fix | Delete

[336] Fix | Delete

/**

[337] Fix | Delete

* Allow/disallow applying non-conflict mode for captcha scripts.

[338] Fix | Delete

*

[339] Fix | Delete

* @since 1.6.4

[340] Fix | Delete

*

[341] Fix | Delete

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

[342] Fix | Delete

*/

[343] Fix | Delete

! apply_filters( 'wpforms_admin_settings_captcha_apply_noconflict', true ) // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[344] Fix | Delete

) {

[345] Fix | Delete

return;

[346] Fix | Delete

}

[347] Fix | Delete

[348] Fix | Delete

$scripts = wp_scripts();

[349] Fix | Delete

$urls = [ 'google.com/recaptcha', 'gstatic.com/recaptcha', 'hcaptcha.com/1', 'challenges.cloudflare.com/turnstile' ];

[350] Fix | Delete

[351] Fix | Delete

foreach ( $scripts->queue as $handle ) {

[352] Fix | Delete

[353] Fix | Delete

// Skip the WPForms JavaScript assets.

[354] Fix | Delete

if (

[355] Fix | Delete

! isset( $scripts->registered[ $handle ] ) ||

[356] Fix | Delete

false !== strpos( $scripts->registered[ $handle ]->handle, 'wpforms' )

[357] Fix | Delete

) {

[358] Fix | Delete

return;

[359] Fix | Delete

}

[360] Fix | Delete

[361] Fix | Delete

foreach ( $urls as $url ) {

[362] Fix | Delete

if ( false !== strpos( $scripts->registered[ $handle ]->src, $url ) ) {

[363] Fix | Delete

wp_dequeue_script( $handle );

[364] Fix | Delete

wp_deregister_script( $handle );

[365] Fix | Delete

break;

[366] Fix | Delete

}

[367] Fix | Delete

}

[368] Fix | Delete

}

[369] Fix | Delete

}

[370] Fix | Delete

}

[371] Fix | Delete

[372] Fix | Delete