| @@ -9,9 +9,8 @@ | ||
| 9 | 9 | class FrmFieldCaptcha extends FrmFieldType { |
| 10 | 10 | |
| 11 | 11 | /** |
| 12 | 12 | * @var string |
| 13 | - * | |
| 14 | 13 | * @since 3.0 |
| 15 | 14 | */ |
| 16 | 15 | protected $type = 'captcha'; |
| 17 | 16 | |
| @@ -22,31 +21,16 @@ | ||
| 22 | 21 | return FrmAppHelper::plugin_path() . '/classes/views/frm-fields/back-end/field-captcha.php'; |
| 23 | 22 | } |
| 24 | 23 | |
| 25 | 24 | /** |
| 26 | - * Returns the image name for a captcha. | |
| 27 | - * | |
| 28 | - * @return string | |
| 29 | - */ | |
| 30 | - public static function get_captcha_image_name() { | |
| 31 | - $frm_settings = FrmAppHelper::get_settings(); | |
| 32 | - $active_captcha = $frm_settings->active_captcha; | |
| 33 | - | |
| 34 | - return $active_captcha === 'recaptcha' && $frm_settings->re_type === 'v3' ? 'recaptcha_v3' : $active_captcha; | |
| 35 | - } | |
| 36 | - | |
| 37 | - /** | |
| 38 | 25 | * @return array |
| 39 | 26 | */ |
| 40 | 27 | protected function field_settings_for_type() { |
| 41 | - $settings = FrmCaptchaFactory::get_settings_object(); | |
| 42 | 28 | return array( |
| 43 | - 'required' => false, | |
| 44 | - 'invalid' => true, | |
| 45 | - 'captcha_size' => $settings->should_show_captcha_size(), | |
| 46 | - 'captcha_theme' => $settings->should_show_captcha_theme(), | |
| 47 | - 'captcha_theme_auto_option' => $settings->should_show_captcha_theme_auto_option(), | |
| 48 | - 'default' => false, | |
| 29 | + 'required' => false, | |
| 30 | + 'invalid' => true, | |
| 31 | + 'captcha_size' => true, | |
| 32 | + 'default' => false, | |
| 49 | 33 | ); |
| 50 | 34 | } |
| 51 | 35 | |
| 52 | 36 | /** |
| @@ -71,230 +55,104 @@ | ||
| 71 | 55 | ); |
| 72 | 56 | } |
| 73 | 57 | |
| 74 | 58 | /** |
| 75 | - * Replace the "for" attribute for captcha field so it matches the response ID. | |
| 59 | + * Remove the "for" attribute for captcha | |
| 76 | 60 | * |
| 77 | - * @param array $args | |
| 61 | + * @param array $args | |
| 78 | 62 | * @param string $html |
| 79 | 63 | * |
| 80 | 64 | * @return string |
| 81 | 65 | */ |
| 82 | 66 | protected function before_replace_html_shortcodes( $args, $html ) { |
| 83 | - $settings = FrmCaptchaFactory::get_settings_object(); | |
| 84 | - return str_replace( ' for="field_[key]"', ' for="' . esc_attr( $settings->token_field ) . '"', $html ); | |
| 67 | + return str_replace( ' for="field_[key]"', ' for="g-recaptcha-response"', $html ); | |
| 85 | 68 | } |
| 86 | 69 | |
| 87 | - /** | |
| 88 | - * @param array $args | |
| 89 | - * @param array $shortcode_atts | |
| 90 | - * | |
| 91 | - * @return string | |
| 92 | - */ | |
| 93 | 70 | public function front_field_input( $args, $shortcode_atts ) { |
| 94 | - if ( ! self::should_show_captcha() ) { | |
| 71 | + $frm_settings = FrmAppHelper::get_settings(); | |
| 72 | + if ( empty( $frm_settings->pubkey ) ) { | |
| 95 | 73 | return ''; |
| 96 | 74 | } |
| 97 | 75 | |
| 98 | - $frm_settings = FrmAppHelper::get_settings(); | |
| 99 | - $settings = FrmCaptchaFactory::get_settings_object(); | |
| 100 | - $div_attributes = array( | |
| 101 | - 'id' => $args['html_id'], | |
| 102 | - 'class' => $this->class_prefix( $frm_settings ) . $this->captcha_class( $frm_settings ), | |
| 103 | - 'data-sitekey' => $settings->get_pubkey(), | |
| 104 | - ); | |
| 76 | + $class_prefix = $this->class_prefix(); | |
| 77 | + $captcha_size = $this->captcha_size(); | |
| 78 | + $allow_mutiple = $frm_settings->re_multi; | |
| 105 | 79 | |
| 106 | - if ( 'turnstile' === $frm_settings->active_captcha ) { | |
| 107 | - $captcha_language = $this->get_captcha_language(); | |
| 108 | - | |
| 109 | - if ( $captcha_language ) { | |
| 110 | - $div_attributes['data-language'] = $captcha_language; | |
| 111 | - } | |
| 80 | + $html = '<div id="' . esc_attr( $args['html_id'] ) . '" class="' . esc_attr( $class_prefix ) . 'g-recaptcha" data-sitekey="' . esc_attr( $frm_settings->pubkey ) . '" data-size="' . esc_attr( $captcha_size ) . '" data-theme="' . esc_attr( $this->field['captcha_theme'] ) . '"'; | |
| 81 | + if ( $captcha_size == 'invisible' && ! $allow_mutiple ) { | |
| 82 | + $html .= ' data-callback="frmAfterRecaptcha"'; | |
| 112 | 83 | } |
| 84 | + $html .= '></div>'; | |
| 113 | 85 | |
| 114 | - $div_attributes = $settings->add_front_end_element_attributes( $div_attributes, $this->field ); | |
| 115 | - | |
| 116 | - return '<div ' . FrmAppHelper::array_to_html_params( $div_attributes ) . '></div>'; | |
| 86 | + return $html; | |
| 117 | 87 | } |
| 118 | 88 | |
| 119 | - /** | |
| 120 | - * @since 6.25 | |
| 121 | - * | |
| 122 | - * @return string | |
| 123 | - */ | |
| 124 | - private function get_captcha_language() { | |
| 125 | - /** | |
| 126 | - * Allows updating the captcha language. | |
| 127 | - * | |
| 128 | - * @since 6.25 | |
| 129 | - * | |
| 130 | - * @param string $lang | |
| 131 | - * @param array $field | |
| 132 | - */ | |
| 133 | - return apply_filters( 'frm_captcha_lang', get_bloginfo( 'language' ), $this->field ); | |
| 134 | - } | |
| 89 | + protected function load_field_scripts( $args ) { | |
| 90 | + $api_js_url = $this->api_url(); | |
| 135 | 91 | |
| 136 | - /** | |
| 137 | - * Load the captcha script. | |
| 138 | - * | |
| 139 | - * @param array $args | |
| 140 | - * | |
| 141 | - * @return void | |
| 142 | - */ | |
| 143 | - protected function load_field_scripts( $args ) { | |
| 144 | - wp_register_script( 'captcha-api', $this->api_url(), array( 'formidable' ), '3', true ); | |
| 145 | - wp_enqueue_script( 'captcha-api' ); | |
| 92 | + wp_register_script( 'recaptcha-api', $api_js_url, array( 'formidable' ), '3', true ); | |
| 93 | + wp_enqueue_script( 'recaptcha-api' ); | |
| 146 | 94 | } |
| 147 | 95 | |
| 148 | - /** | |
| 149 | - * Get the URL for the script JS that is loaded on the front end. | |
| 150 | - * | |
| 151 | - * @return string | |
| 152 | - */ | |
| 153 | 96 | protected function api_url() { |
| 154 | - $frm_settings = FrmAppHelper::get_settings(); | |
| 155 | - $active_mode = $frm_settings->active_captcha; | |
| 156 | - | |
| 157 | - if ( 'recaptcha' === $active_mode ) { | |
| 158 | - return $this->recaptcha_api_url( $frm_settings ); | |
| 159 | - } | |
| 160 | - | |
| 161 | - if ( 'hcaptcha' === $active_mode ) { | |
| 162 | - return $this->hcaptcha_api_url(); | |
| 163 | - } | |
| 164 | - | |
| 165 | - return $this->turnstile_api_url(); | |
| 166 | - } | |
| 167 | - | |
| 168 | - /** | |
| 169 | - * @param FrmSettings $frm_settings | |
| 170 | - * | |
| 171 | - * @return string | |
| 172 | - */ | |
| 173 | - protected function recaptcha_api_url( $frm_settings ) { | |
| 174 | 97 | $api_js_url = 'https://www.google.com/recaptcha/api.js?'; |
| 175 | 98 | |
| 176 | - if ( $this->allow_multiple( $frm_settings ) ) { | |
| 99 | + $frm_settings = FrmAppHelper::get_settings(); | |
| 100 | + $allow_mutiple = $frm_settings->re_multi; | |
| 101 | + if ( $allow_mutiple ) { | |
| 177 | 102 | $api_js_url .= '&onload=frmRecaptcha&render=explicit'; |
| 178 | 103 | } |
| 179 | 104 | |
| 180 | 105 | $lang = apply_filters( 'frm_recaptcha_lang', $frm_settings->re_lang, $this->field ); |
| 181 | - | |
| 182 | - if ( $lang ) { | |
| 106 | + if ( ! empty( $lang ) ) { | |
| 183 | 107 | $api_js_url .= '&hl=' . $lang; |
| 184 | 108 | } |
| 185 | 109 | |
| 186 | - // Since this URL initially ends with ? and we never use add_query_arg, remove the extra | |
| 187 | - // & that appears immediately after the ? | |
| 188 | - $api_js_url = str_replace( '?&', '?', $api_js_url ); | |
| 189 | - | |
| 190 | - /** | |
| 191 | - * @param string $api_js_url | |
| 192 | - */ | |
| 193 | 110 | return apply_filters( 'frm_recaptcha_js_url', $api_js_url ); |
| 194 | 111 | } |
| 195 | 112 | |
| 196 | - /** | |
| 197 | - * @since 6.0 | |
| 198 | - * | |
| 199 | - * @return string | |
| 200 | - */ | |
| 201 | - protected function hcaptcha_api_url() { | |
| 202 | - $api_js_url = 'https://js.hcaptcha.com/1/api.js'; | |
| 203 | - $lang = $this->get_captcha_language(); | |
| 204 | - | |
| 205 | - if ( $lang ) { | |
| 206 | - // Language might be in the format of en-US, fr-FR, etc. In that case, we need to extract the first part to comply with the hcaptcha api request format. | |
| 207 | - $lang_parts = explode( '-', $lang ); | |
| 208 | - $api_js_url .= '?hl=' . $lang_parts[0]; | |
| 113 | + protected function class_prefix() { | |
| 114 | + if ( $this->allow_multiple() ) { | |
| 115 | + $class_prefix = 'frm-'; | |
| 116 | + } else { | |
| 117 | + $class_prefix = ''; | |
| 209 | 118 | } |
| 210 | 119 | |
| 211 | - $api_js_url = add_query_arg( 'onload', 'frmHcaptcha', $api_js_url ); | |
| 212 | - | |
| 213 | - /** | |
| 214 | - * Allows updating hcaptcha js api url. | |
| 215 | - * | |
| 216 | - * @since 6.0 | |
| 217 | - * | |
| 218 | - * @param string $api_js_url | |
| 219 | - */ | |
| 220 | - return apply_filters( 'frm_hcaptcha_js_url', $api_js_url ); | |
| 120 | + return $class_prefix; | |
| 221 | 121 | } |
| 222 | 122 | |
| 223 | - /** | |
| 224 | - * @since 6.8.4 | |
| 225 | - * | |
| 226 | - * @return string | |
| 227 | - */ | |
| 228 | - protected function turnstile_api_url() { | |
| 229 | - $api_js_url = 'https://challenges.cloudflare.com/turnstile/v0/api.js?onload=frmTurnstile&render=explicit'; | |
| 123 | + protected function allow_multiple() { | |
| 124 | + $frm_settings = FrmAppHelper::get_settings(); | |
| 230 | 125 | |
| 231 | - /** | |
| 232 | - * Allows updating hcaptcha js api url. | |
| 233 | - * | |
| 234 | - * @since 6.8.4 | |
| 235 | - * | |
| 236 | - * @param string $api_js_url | |
| 237 | - */ | |
| 238 | - $api_js_url = apply_filters( 'frm_turnstile_js_url', $api_js_url ); | |
| 239 | - | |
| 240 | - // Prevent render=explicit from happening twice in case someone patched | |
| 241 | - // The double rendering issue using the frm_turnstile_js_url hook. | |
| 242 | - return str_replace( | |
| 243 | - '&render=explicit&render=explicit', | |
| 244 | - '&render=explicit', | |
| 245 | - $api_js_url | |
| 246 | - ); | |
| 126 | + return $frm_settings->re_multi; | |
| 247 | 127 | } |
| 248 | 128 | |
| 249 | 129 | /** |
| 250 | - * @param FrmSettings $frm_settings | |
| 251 | - * | |
| 252 | 130 | * @return string |
| 253 | - * | |
| 254 | - * @psalm-return ''|'frm-' | |
| 255 | 131 | */ |
| 256 | - protected function class_prefix( $frm_settings ) { | |
| 257 | - return FrmCaptchaFactory::get_settings_object()->get_class_prefix( $this->allow_multiple( $frm_settings ) ); | |
| 132 | + protected function captcha_size() { | |
| 133 | + $frm_settings = FrmAppHelper::get_settings(); | |
| 134 | + if ( in_array( $frm_settings->re_type, array( 'invisible', 'v3' ), true ) ) { | |
| 135 | + return 'invisible'; | |
| 136 | + } | |
| 137 | + // for reverse compatibility | |
| 138 | + return $this->field['captcha_size'] === 'default' ? 'normal' : $this->field['captcha_size']; | |
| 258 | 139 | } |
| 259 | 140 | |
| 260 | 141 | /** |
| 261 | - * @param FrmSettings $frm_settings This isn't used anymore. It's only there for backwards compatibility. | |
| 262 | - * | |
| 263 | - * @return string | |
| 264 | - * | |
| 265 | - * @psalm-return 'g-recaptcha'|'h-captcha' | |
| 266 | - */ | |
| 267 | - protected function captcha_class( $frm_settings ) { | |
| 268 | - $settings = FrmCaptchaFactory::get_settings_object(); | |
| 269 | - return $settings->get_element_class_name(); | |
| 270 | - } | |
| 271 | - | |
| 272 | - /** | |
| 273 | - * @param FrmSettings $frm_settings | |
| 274 | - * | |
| 275 | - * @return bool | |
| 276 | - */ | |
| 277 | - protected function allow_multiple( $frm_settings ) { | |
| 278 | - return $frm_settings->re_multi; | |
| 279 | - } | |
| 280 | - | |
| 281 | - /** | |
| 282 | 142 | * @since 4.07 |
| 283 | - * | |
| 284 | 143 | * @param array $args |
| 285 | - * | |
| 286 | 144 | * @return array |
| 287 | 145 | */ |
| 288 | 146 | protected function validate_against_api( $args ) { |
| 289 | 147 | $errors = array(); |
| 290 | 148 | $frm_settings = FrmAppHelper::get_settings(); |
| 291 | - $resp = $this->send_api_check(); | |
| 149 | + $resp = $this->send_api_check( $frm_settings ); | |
| 292 | 150 | $response = json_decode( wp_remote_retrieve_body( $resp ), true ); |
| 293 | 151 | |
| 294 | 152 | if ( is_wp_error( $resp ) ) { |
| 295 | 153 | $error_string = $resp->get_error_message(); |
| 296 | - $errors[ 'field' . $args['id'] ] = __( 'There was a problem verifying your captcha', 'formidable' ); | |
| 154 | + $errors[ 'field' . $args['id'] ] = __( 'There was a problem verifying your recaptcha', 'formidable' ); | |
| 297 | 155 | $errors[ 'field' . $args['id'] ] .= ' ' . $error_string; |
| 298 | 156 | return $errors; |
| 299 | 157 | } |
| 300 | 158 | |
| @@ -301,9 +159,9 @@ | ||
| 301 | 159 | if ( ! is_array( $response ) ) { |
| 302 | 160 | return $errors; |
| 303 | 161 | } |
| 304 | 162 | |
| 305 | - if ( $frm_settings->active_captcha === 'recaptcha' && 'v3' === $frm_settings->re_type && array_key_exists( 'score', $response ) ) { | |
| 163 | + if ( 'v3' === $frm_settings->re_type && array_key_exists( 'score', $response ) ) { | |
| 306 | 164 | $threshold = floatval( $frm_settings->re_threshold ); |
| 307 | 165 | $score = floatval( $response['score'] ); |
| 308 | 166 | |
| 309 | 167 | $this->set_score( $score ); |
| @@ -312,38 +170,27 @@ | ||
| 312 | 170 | $response['success'] = false; |
| 313 | 171 | } |
| 314 | 172 | } |
| 315 | 173 | |
| 316 | - if ( ! isset( $response['success'] ) || $response['success'] ) { | |
| 317 | - return $errors; | |
| 174 | + if ( isset( $response['success'] ) && ! $response['success'] ) { | |
| 175 | + // What happens when the CAPTCHA was entered incorrectly | |
| 176 | + $invalid_message = FrmField::get_option( $this->field, 'invalid' ); | |
| 177 | + $errors[ 'field' . $args['id'] ] = ( $invalid_message == '' ? $frm_settings->re_msg : $invalid_message ); | |
| 318 | 178 | } |
| 319 | 179 | |
| 320 | - // What happens when the CAPTCHA was entered incorrectly | |
| 321 | - $invalid_message = FrmField::get_option( $this->field, 'invalid' ); | |
| 322 | - | |
| 323 | - if ( $invalid_message === __( 'The reCAPTCHA was not entered correctly', 'formidable' ) ) { | |
| 324 | - $invalid_message = ''; | |
| 325 | - } | |
| 326 | - | |
| 327 | - $errors[ 'field' . $args['id'] ] = $invalid_message === '' ? $frm_settings->re_msg : $invalid_message; | |
| 328 | - | |
| 329 | 180 | return $errors; |
| 330 | 181 | } |
| 331 | 182 | |
| 332 | 183 | /** |
| 333 | 184 | * @param float $score |
| 334 | - * | |
| 335 | 185 | * @return void |
| 336 | 186 | */ |
| 337 | 187 | private function set_score( $score ) { |
| 338 | 188 | global $frm_vars; |
| 339 | - | |
| 340 | 189 | if ( ! isset( $frm_vars['captcha_scores'] ) ) { |
| 341 | 190 | $frm_vars['captcha_scores'] = array(); |
| 342 | 191 | } |
| 343 | - | |
| 344 | 192 | $form_id = is_object( $this->field ) ? $this->field->form_id : $this->field['form_id']; |
| 345 | - | |
| 346 | 193 | if ( ! isset( $frm_vars['captcha_scores'][ $form_id ] ) ) { |
| 347 | 194 | $frm_vars['captcha_scores'][ $form_id ] = $score; |
| 348 | 195 | } |
| 349 | 196 | } |
| @@ -349,9 +196,8 @@ | ||
| 349 | 196 | } |
| 350 | 197 | |
| 351 | 198 | /** |
| 352 | 199 | * @param array $args |
| 353 | - * | |
| 354 | 200 | * @return array |
| 355 | 201 | */ |
| 356 | 202 | public function validate( $args ) { |
| 357 | 203 | if ( ! $this->should_validate() ) { |
| @@ -357,11 +203,11 @@ | ||
| 357 | 203 | if ( ! $this->should_validate() ) { |
| 358 | 204 | return array(); |
| 359 | 205 | } |
| 360 | 206 | |
| 361 | - $missing_token = ! self::post_data_includes_token(); | |
| 362 | - | |
| 363 | - if ( $missing_token ) { | |
| 207 | + // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 208 | + if ( ! isset( $_POST['g-recaptcha-response'] ) ) { | |
| 209 | + // There was no captcha submitted. | |
| 364 | 210 | return array( 'field' . $args['id'] => __( 'The captcha is missing from this form', 'formidable' ) ); |
| 365 | 211 | } |
| 366 | 212 | |
| 367 | 213 | return $this->validate_against_api( $args ); |
| @@ -367,77 +213,34 @@ | ||
| 367 | 213 | return $this->validate_against_api( $args ); |
| 368 | 214 | } |
| 369 | 215 | |
| 370 | 216 | /** |
| 371 | - * @since 6.8.4 | |
| 372 | - * | |
| 373 | - * @return bool | |
| 374 | - */ | |
| 375 | - protected static function post_data_includes_token() { | |
| 376 | - $settings = FrmCaptchaFactory::get_settings_object(); | |
| 377 | - // phpcs:ignore WordPress.Security.NonceVerification.Missing | |
| 378 | - return ! empty( $_POST[ $settings->token_field ] ); | |
| 379 | - } | |
| 380 | - | |
| 381 | - /** | |
| 382 | - * Check if the active captcha type's public key is set. | |
| 383 | - * | |
| 384 | 217 | * @since 4.07 |
| 385 | - * | |
| 386 | 218 | * @return bool |
| 387 | 219 | */ |
| 388 | - public static function should_show_captcha() { | |
| 389 | - $settings = FrmCaptchaFactory::get_settings_object(); | |
| 390 | - return $settings->has_pubkey(); | |
| 220 | + private function should_show_captcha() { | |
| 221 | + $frm_settings = FrmAppHelper::get_settings(); | |
| 222 | + return ! empty( $frm_settings->pubkey ); | |
| 391 | 223 | } |
| 392 | 224 | |
| 393 | - /** | |
| 394 | - * @return bool | |
| 395 | - */ | |
| 396 | 225 | protected function should_validate() { |
| 397 | 226 | $is_hidden_field = apply_filters( 'frm_is_field_hidden', false, $this->field, wp_unslash( $_POST ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing |
| 398 | - | |
| 399 | 227 | if ( FrmAppHelper::is_admin() || $is_hidden_field ) { |
| 400 | 228 | return false; |
| 401 | 229 | } |
| 402 | 230 | |
| 403 | - // Don't require the captcha if it shouldn't be shown | |
| 404 | - return self::should_show_captcha(); | |
| 231 | + // don't require the captcha if it shouldn't be shown | |
| 232 | + return $this->should_show_captcha(); | |
| 405 | 233 | } |
| 406 | 234 | |
| 407 | - /** | |
| 408 | - * @return array|WP_Error | |
| 409 | - */ | |
| 410 | - protected function send_api_check() { | |
| 411 | - $captcha_settings = FrmCaptchaFactory::get_settings_object(); | |
| 412 | - $arg_array = array( | |
| 235 | + protected function send_api_check( $frm_settings ) { | |
| 236 | + $arg_array = array( | |
| 413 | 237 | 'body' => array( |
| 414 | - 'secret' => $captcha_settings->secret, | |
| 415 | - 'response' => FrmAppHelper::get_param( $captcha_settings->token_field, '', 'post', 'sanitize_text_field' ), | |
| 238 | + 'secret' => $frm_settings->privkey, | |
| 239 | + 'response' => FrmAppHelper::get_param( 'g-recaptcha-response', '', 'post', 'sanitize_text_field' ), | |
| 416 | 240 | 'remoteip' => FrmAppHelper::get_ip_address(), |
| 417 | 241 | ), |
| 418 | 242 | ); |
| 419 | 243 | |
| 420 | - return wp_remote_post( $captcha_settings->endpoint, $arg_array ); | |
| 421 | - } | |
| 422 | - | |
| 423 | - /** | |
| 424 | - * Updates field name in page builder to the currently activated captcha if it is set to the default. | |
| 425 | - * | |
| 426 | - * @since 6.0 | |
| 427 | - * | |
| 428 | - * @param array $values | |
| 429 | - * | |
| 430 | - * @return array Values. | |
| 431 | - */ | |
| 432 | - public static function update_field_name( $values ) { | |
| 433 | - if ( $values['type'] === 'captcha' ) { | |
| 434 | - $name = $values['name']; | |
| 435 | - | |
| 436 | - if ( in_array( $name, array( __( 'reCAPTCHA', 'formidable' ), __( 'hCaptcha', 'formidable' ) ), true ) ) { | |
| 437 | - $values['name'] = __( 'Captcha', 'formidable' ); | |
| 438 | - } | |
| 439 | - } | |
| 440 | - | |
| 441 | - return $values; | |
| 244 | + return wp_remote_post( 'https://www.google.com/recaptcha/api/siteverify', $arg_array ); | |
| 442 | 245 | } |
| 443 | 246 | } |
