From 7bbccd58a8564ae210c3e7ca0a0612921cf0bf68 Mon Sep 17 00:00:00 2001 From: Mike Letellier Date: Wed, 11 Nov 2026 10:31:37 -0400 Subject: [PATCH] fix(fields): handle unsupported captcha types Use the first configured supported provider when the saved CAPTCHA type is unavailable. Keep settings, builder previews, and scripts in sync without rewriting the saved selection. Guard invisible reCAPTCHA detection against missing APIs, missing widget IDs, and getResponse failures. --- classes/models/FrmSettings.php | 34 +++++- js/formidable.js | 10 +- js/formidable.min.js | 6 +- .../settings/test_FrmCaptchaFallback.php | 112 ++++++++++++++++++ 4 files changed, 152 insertions(+), 10 deletions(-) create mode 100644 tests/phpunit/settings/test_FrmCaptchaFallback.php diff --git a/classes/models/FrmSettings.php b/classes/models/FrmSettings.php index a5611e5d54..906c35e9f3 100644 --- a/classes/models/FrmSettings.php +++ b/classes/models/FrmSettings.php @@ -465,10 +465,6 @@ private function maybe_sanitize_global_setting( $value, $key, $filter_keys ) { * @return void */ private function fill_captcha_settings() { - if ( ! isset( $this->active_captcha ) ) { - $this->active_captcha = 'recaptcha'; - } - $privkey = ''; $re_lang = ''; @@ -507,6 +503,36 @@ private function fill_captcha_settings() { if ( ! isset( $this->re_threshold ) ) { $this->re_threshold = .5; } + + $this->set_supported_captcha(); + } + + /** + * Use a configured provider when the saved CAPTCHA type is unsupported. + * + * @since x.x + * + * @return void + */ + private function set_supported_captcha() { + $prefixes = array( + 'recaptcha' => '', + 'hcaptcha' => 'hcaptcha_', + 'turnstile' => 'turnstile_', + ); + + if ( array_key_exists( $this->active_captcha, $prefixes ) ) { + return; + } + + $this->active_captcha = 'recaptcha'; + + foreach ( $prefixes as $type => $prefix ) { + if ( ! empty( $this->{ $prefix . 'pubkey' } ) && ! empty( $this->{ $prefix . 'privkey' } ) ) { + $this->active_captcha = $type; + return; + } + } } /** diff --git a/js/formidable.js b/js/formidable.js index 060d1fab72..897402acbc 100644 --- a/js/formidable.js +++ b/js/formidable.js @@ -1035,12 +1035,16 @@ function frmFrontFormJS() { const recaptcha = form.querySelector( '.frm-g-recaptcha[data-size="invisible"], .g-recaptcha[data-size="invisible"]' ); if ( recaptcha ) { const recaptchaID = recaptcha.dataset.rid; - if ( recaptcha.dataset.saveAsSpam === '1' && - ( typeof grecaptcha === 'undefined' || recaptchaID === undefined ) ) { + if ( typeof grecaptcha === 'undefined' || recaptchaID === undefined ) { return false; } - const alreadyChecked = grecaptcha.getResponse( recaptchaID ); + let alreadyChecked; + try { + alreadyChecked = grecaptcha.getResponse( recaptchaID ); + } catch ( e ) { + return false; + } if ( alreadyChecked.length === 0 ) { return recaptcha; } diff --git a/js/formidable.min.js b/js/formidable.min.js index 0c28895746..7232f8d915 100644 --- a/js/formidable.min.js +++ b/js/formidable.min.js @@ -30,9 +30,9 @@ undefined)return;if(fieldID!==strippedFieldID){const firstField=document.getElem "data-invmsg")}}function checkPatternField(field,errors){let fieldID;const text=field.value;let format=getFieldValidationMessage(field,"pattern");if(format!==""&&text!==""){fieldID=getFieldId(field,true);if(!(fieldID in errors))if("object"===typeof window.frmProForm&&"function"===typeof window.frmProForm.isIntlPhoneInput&&window.frmProForm.isIntlPhoneInput(field)){if(!window.frmProForm.validateIntlPhoneInput(field))errors[fieldID]=getFieldValidationMessage(field,"data-invmsg")}else{format=new RegExp(`^${format}$`, "i");if(format.test(text)===false)errors[fieldID]=getFieldValidationMessage(field,"data-invmsg")}}}function setSelectPlaceholderColor(){const selects=document.querySelectorAll(".form-field select");const styleElement=document.querySelector(".with_frm_style");const textColorDisabled=styleElement?getComputedStyle(styleElement).getPropertyValue("--text-color-disabled").trim():"";if(!selects.length||!textColorDisabled)return;const changeSelectColor=function(select){if(select.options[select.selectedIndex]&& hasClass(select.options[select.selectedIndex],"frm-select-placeholder"))select.style.setProperty("color",textColorDisabled,"important");else select.style.color=""};Array.prototype.forEach.call(selects,function(select){changeSelectColor(select);select.addEventListener("change",function(){changeSelectColor(select)})})}function hasInvisibleRecaptcha(object){if(isGoingToPrevPage(object))return false;const form=object instanceof jQuery?object.get(0):object;if(!form)return false;const recaptcha=form.querySelector('.frm-g-recaptcha[data-size="invisible"], .g-recaptcha[data-size="invisible"]'); -if(recaptcha){const recaptchaID=recaptcha.dataset.rid;if(recaptcha.dataset.saveAsSpam==="1"&&(typeof grecaptcha==="undefined"||recaptchaID===undefined))return false;const alreadyChecked=grecaptcha.getResponse(recaptchaID);if(alreadyChecked.length===0)return recaptcha}return false}function executeInvisibleRecaptcha(invisibleRecaptcha){const recaptchaID=invisibleRecaptcha.dataset.rid;grecaptcha.reset(recaptchaID);grecaptcha.execute(recaptchaID)}function validateRecaptcha(form,errors){const formEl=form instanceof -jQuery?form.get(0):form;if(!formEl)return errors;const recaptcha=formEl.querySelector(".frm-g-recaptcha");if(!recaptcha)return errors;const recaptchaID=recaptcha.dataset.rid;let response;try{response=grecaptcha.getResponse(recaptchaID)}catch(e){if(recaptcha.dataset.saveAsSpam==="1"||formEl.querySelector('input[name="recaptcha_checked"]'))return errors;response=""}if(response.length===0){const fieldContainer=recaptcha.closest(".frm_form_field");if(fieldContainer?.id){const fieldID=fieldContainer.id.replace("frm_field_", -"").replace("_container","");errors[fieldID]=""}}return errors}function getFieldValidationMessage(field,messageType){let msg=field.getAttribute(messageType);if(null===msg)msg="";if(""!==msg&&shouldWrapErrorHtmlAroundMessageType(messageType))msg=wrapErrorHtml(msg,field);return msg}function wrapErrorHtml(msg,field,keyOverride=""){let errorHtml=field.getAttribute("data-error-html");if(null===errorHtml)return msg;errorHtml=errorHtml.replace(/\+/g,"%20");msg=decodeURIComponent(errorHtml).replace("[error]", +if(recaptcha){const recaptchaID=recaptcha.dataset.rid;if(typeof grecaptcha==="undefined"||recaptchaID===undefined)return false;let alreadyChecked;try{alreadyChecked=grecaptcha.getResponse(recaptchaID)}catch(e){return false}if(alreadyChecked.length===0)return recaptcha}return false}function executeInvisibleRecaptcha(invisibleRecaptcha){const recaptchaID=invisibleRecaptcha.dataset.rid;grecaptcha.reset(recaptchaID);grecaptcha.execute(recaptchaID)}function validateRecaptcha(form,errors){const formEl= +form instanceof jQuery?form.get(0):form;if(!formEl)return errors;const recaptcha=formEl.querySelector(".frm-g-recaptcha");if(!recaptcha)return errors;const recaptchaID=recaptcha.dataset.rid;let response;try{response=grecaptcha.getResponse(recaptchaID)}catch(e){if(recaptcha.dataset.saveAsSpam==="1"||formEl.querySelector('input[name="recaptcha_checked"]'))return errors;response=""}if(response.length===0){const fieldContainer=recaptcha.closest(".frm_form_field");if(fieldContainer?.id){const fieldID= +fieldContainer.id.replace("frm_field_","").replace("_container","");errors[fieldID]=""}}return errors}function getFieldValidationMessage(field,messageType){let msg=field.getAttribute(messageType);if(null===msg)msg="";if(""!==msg&&shouldWrapErrorHtmlAroundMessageType(messageType))msg=wrapErrorHtml(msg,field);return msg}function wrapErrorHtml(msg,field,keyOverride=""){let errorHtml=field.getAttribute("data-error-html");if(null===errorHtml)return msg;errorHtml=errorHtml.replace(/\+/g,"%20");msg=decodeURIComponent(errorHtml).replace("[error]", msg);if(keyOverride)return msg.replace("[key]",keyOverride);const fieldId=getFieldId(field,false);const split=fieldId.split("-");const fieldIdParts=field.id.split("_");fieldIdParts.shift();split[0]=fieldIdParts.join("_");const errorKey=split.join("-");return msg.replace("[key]",errorKey)}function shouldWrapErrorHtmlAroundMessageType(type){return"pattern"!==type}function shouldJSValidate(object){if("function"===typeof object.get)object=object.get(0);let validate=hasClass(object,"frm_js_validate"); if(validate&&typeof frmProForm!=="undefined"&&(frmProForm.savingDraft(object)||frmProForm.goingToPreviousPage(object)))validate=false;return validate}function getFormErrors(object,action){const fieldsets=object.querySelectorAll(".frm_form_field");fieldsets.forEach(field=>field.classList.add("frm_doing_ajax"));const data=`${jQuery(object).serialize()}&action=frm_entries_${action}&nonce=${frm_js.nonce}`;const shouldTriggerEvent=object.classList.contains("frm_trigger_event_on_submit");const doRedirect= response=>{jQuery(document).trigger("frmBeforeFormRedirect",[object,response]);if(!response.openInNewTab){window.location=response.redirect;return}const newTab=window.open(response.redirect,"_blank");if(!newTab&&response.fallbackMsg&&response.content)response.content=response.content.trim().replace(/(<\/div><\/div>)$/,` ${response.fallbackMsg}`)};const success=function(response){const defaultResponse={content:"",errors:{},pass:false};if(response===null)response=defaultResponse;else{response= diff --git a/tests/phpunit/settings/test_FrmCaptchaFallback.php b/tests/phpunit/settings/test_FrmCaptchaFallback.php new file mode 100644 index 0000000000..529e239f23 --- /dev/null +++ b/tests/phpunit/settings/test_FrmCaptchaFallback.php @@ -0,0 +1,112 @@ +original_settings = clone FrmAppHelper::get_settings(); + $this->set_front_end(); + } + + public function tearDown(): void { + $GLOBALS['frm_settings'] = $this->original_settings; + parent::tearDown(); + } + + /** + * Load saved settings with test keys for the specified providers. + * + * @param string $active The saved provider selection. + * @param string[] $configured The providers with both keys configured. + * + * @return FrmSettings + */ + private function load_settings( $active, $configured ) { + $settings = clone $this->original_settings; + $settings->active_captcha = $active; + $settings->re_type = 'v2'; + $prefixes = array( + 'recaptcha' => '', + 'hcaptcha' => 'hcaptcha_', + 'turnstile' => 'turnstile_', + ); + + foreach ( $prefixes as $type => $prefix ) { + $has_keys = in_array( $type, $configured, true ); + $settings->{ $prefix . 'pubkey' } = $has_keys ? 'test-site-key' : ''; + $settings->{ $prefix . 'privkey' } = $has_keys ? 'test-secret-key' : ''; + } + + update_option( $settings->option_name, $settings ); + $GLOBALS['frm_settings'] = new FrmSettings(); + return FrmAppHelper::get_settings(); + } + + public function test_unsupported_selection_uses_first_configured_provider() { + $providers = array( 'recaptcha', 'hcaptcha', 'turnstile' ); + + foreach ( $providers as $expected ) { + $settings = $this->load_settings( 'altcha', $providers ); + $this->assertSame( $expected, $settings->active_captcha ); + $this->assertSame( $expected, FrmFieldCaptcha::get_captcha_image_name() ); + $this->assertSame( 'altcha', get_option( $settings->option_name )->active_captcha, 'Loading settings must preserve the saved selection.' ); + array_shift( $providers ); + } + } + + public function test_supported_selection_is_preserved() { + foreach ( array( 'recaptcha', 'hcaptcha', 'turnstile' ) as $type ) { + $settings = $this->load_settings( $type, array( 'recaptcha', 'hcaptcha', 'turnstile' ) ); + $this->assertSame( $type, $settings->active_captcha ); + } + } + + public function test_fallback_requires_both_keys() { + $settings = $this->load_settings( 'altcha', array( 'turnstile' ) ); + $settings->pubkey = 'test-site-key'; + $settings->active_captcha = 'altcha'; + update_option( $settings->option_name, $settings ); + $this->assertSame( 'turnstile', ( new FrmSettings() )->active_captcha ); + + $settings = $this->load_settings( 'altcha', array() ); + $this->assertSame( 'recaptcha', $settings->active_captcha ); + $this->assertFalse( FrmFieldCaptcha::should_show_captcha() ); + } + + public function test_fallback_renders_matching_captcha_and_loads_matching_script() { + $form_id = $this->factory->form->create(); + $this->factory->field->create( + array( + 'form_id' => $form_id, + 'type' => 'captcha', + ) + ); + $providers = array( + 'recaptcha' => array( 'g-recaptcha', 'https://www.google.com/recaptcha/api.js' ), + 'hcaptcha' => array( 'h-captcha', 'https://js.hcaptcha.com/1/api.js' ), + 'turnstile' => array( 'cf-turnstile', 'https://challenges.cloudflare.com/turnstile/v0/api.js' ), + ); + + foreach ( $providers as $type => $expected ) { + $this->load_settings( 'altcha', array( $type ) ); + wp_deregister_script( 'captcha-api' ); + $html = do_shortcode( '[formidable id="' . $form_id . '"]' ); + $this->assertStringContainsString( $expected[0], $html ); + $this->assertStringContainsString( $expected[1], wp_scripts()->registered['captcha-api']->src ); + + ob_start(); + FrmSettingsController::captcha_settings(); + $settings_html = ob_get_clean(); + $this->assertMatchesRegularExpression( '/id="frm-' . $type . '"[^>]+checked=/', $settings_html ); + } + } +}