abstract-captcha
2 years ago
admin-tabs
2 years ago
assets-build
2 years ago
block-types
2 years ago
blocks-metadata
2 years ago
friendly-captcha
2 years ago
hcaptcha
2 years ago
re-captcha-v3
2 years ago
turnstile
2 years ago
module.php
2 years ago
module.php
392 lines
| 1 | <?php |
| 2 | |
| 3 | |
| 4 | namespace JFB_Modules\Captcha; |
| 5 | |
| 6 | // If this file is called directly, abort. |
| 7 | if ( ! defined( 'WPINC' ) ) { |
| 8 | die; |
| 9 | } |
| 10 | |
| 11 | use Jet_Form_Builder\Admin\Tabs_Handlers\Tab_Handler_Manager; |
| 12 | use Jet_Form_Builder\Blocks\Block_Helper; |
| 13 | use Jet_Form_Builder\Blocks\Exceptions\Render_Empty_Field; |
| 14 | use JFB_Components\Repository\Repository_Pattern_Trait; |
| 15 | use Jet_Form_Builder\Classes\Tools; |
| 16 | use Jet_Form_Builder\Exceptions\Repository_Exception; |
| 17 | use JFB_Modules\Captcha\Abstract_Captcha\Base_Captcha; |
| 18 | use JFB_Modules\Captcha\Abstract_Captcha\Captcha_Frontend_Style_It; |
| 19 | use JFB_Modules\Captcha\Abstract_Captcha\Captcha_Separate_Editor_Script; |
| 20 | use JFB_Modules\Captcha\Abstract_Captcha\Captcha_Separate_Frontend_Script; |
| 21 | use JFB_Modules\Captcha\Abstract_Captcha\Captcha_Settings_From_Options; |
| 22 | use JFB_Modules\Captcha\Friendly_Captcha\Friendly_Captcha; |
| 23 | use JFB_Modules\Captcha\Hcaptcha\Hcaptcha; |
| 24 | use JFB_Modules\Captcha\Re_Captcha_V3\Re_Captcha_V3; |
| 25 | use JFB_Modules\Captcha\Turnstile\Turnstile; |
| 26 | use JFB_Components\Module\Base_Module_After_Install_It; |
| 27 | use JFB_Components\Module\Base_Module_Dir_It; |
| 28 | use JFB_Components\Module\Base_Module_Dir_Trait; |
| 29 | use JFB_Components\Module\Base_Module_Handle_It; |
| 30 | use JFB_Components\Module\Base_Module_Handle_Trait; |
| 31 | use JFB_Components\Module\Base_Module_It; |
| 32 | use JFB_Components\Module\Base_Module_Url_It; |
| 33 | use JFB_Components\Module\Base_Module_Url_Trait; |
| 34 | use JFB_Modules\Security\Exceptions\Spam_Exception; |
| 35 | use Jet_Form_Builder\Plugin; |
| 36 | |
| 37 | /** |
| 38 | * @since 3.1.0 |
| 39 | * |
| 40 | * Class Module |
| 41 | * @package JFB_Modules\Captcha |
| 42 | */ |
| 43 | final class Module implements |
| 44 | Base_Module_It, |
| 45 | Base_Module_Url_It, |
| 46 | Base_Module_Dir_It, |
| 47 | Base_Module_After_Install_It, |
| 48 | Base_Module_Handle_It { |
| 49 | |
| 50 | use Base_Module_Handle_Trait; |
| 51 | use Base_Module_Url_Trait; |
| 52 | use Base_Module_Dir_Trait; |
| 53 | |
| 54 | use Repository_Pattern_Trait; |
| 55 | |
| 56 | const PREFIX = 'jet_form_builder_captcha__'; |
| 57 | |
| 58 | /** |
| 59 | * @var Base_Captcha[] |
| 60 | */ |
| 61 | private $current = array(); |
| 62 | |
| 63 | /** |
| 64 | * It becomes false inside `on_render_field`, if it renders the captcha. |
| 65 | * And if it true - captcha renders inside the `on_end_render_form` method |
| 66 | * |
| 67 | * @var bool |
| 68 | */ |
| 69 | private $should_render = true; |
| 70 | |
| 71 | public function rep_item_id() { |
| 72 | return 'captcha'; |
| 73 | } |
| 74 | |
| 75 | public function on_install() { |
| 76 | $this->rep_install(); |
| 77 | |
| 78 | Tab_Handler_Manager::instance()->install( new Admin_Tabs\Captcha_Handler() ); |
| 79 | } |
| 80 | |
| 81 | public function on_uninstall() { |
| 82 | $this->rep_clear(); |
| 83 | |
| 84 | Tab_Handler_Manager::instance()->uninstall( 'captcha-tab' ); |
| 85 | } |
| 86 | |
| 87 | public function rep_instances(): array { |
| 88 | return apply_filters( |
| 89 | 'jet-form-builder/captcha/types', |
| 90 | array( |
| 91 | new Re_Captcha_V3(), |
| 92 | new Hcaptcha(), |
| 93 | new Turnstile(), |
| 94 | new Friendly_Captcha(), |
| 95 | ) |
| 96 | ); |
| 97 | } |
| 98 | |
| 99 | public function condition(): bool { |
| 100 | return true; |
| 101 | } |
| 102 | |
| 103 | public function init_hooks() { |
| 104 | add_filter( 'jet-form-builder/request-handler/request', array( $this, 'on_request' ) ); |
| 105 | add_filter( 'jet-form-builder/before-render-field', array( $this, 'on_render_field' ), 10, 3 ); |
| 106 | add_filter( 'jet-form-builder/page-config/jfb-settings', array( $this, 'on_localize_config' ) ); |
| 107 | add_filter( 'jet-form-builder/editor/config', array( $this, 'on_localize_config' ) ); |
| 108 | add_filter( 'jet-form-builder/setup-blocks', array( $this, 'check_is_container_exist' ) ); |
| 109 | add_filter( 'jet-form-builder/before-end-form', array( $this, 'on_end_render_form' ) ); |
| 110 | add_filter( 'jet-form-builder/blocks/items', array( $this, 'add_blocks_types' ) ); |
| 111 | |
| 112 | add_action( 'jet-form-builder/editor-assets/before', array( $this, 'enqueue_editor_assets' ) ); |
| 113 | add_action( 'jet-form-builder/editor-assets/before', array( $this, 'enqueue_editor_package_assets' ), 0 ); |
| 114 | add_action( 'wp_enqueue_scripts', array( $this, 'register_frontend_scripts' ) ); |
| 115 | add_action( 'jet_plugins/frontend/register_scripts', array( $this, 'register_frontend_scripts' ) ); |
| 116 | add_action( 'jet-form-builder/enqueue-style', array( $this, 'register_frontend_styles' ) ); |
| 117 | } |
| 118 | |
| 119 | public function remove_hooks() { |
| 120 | remove_filter( 'jet-form-builder/request-handler/request', array( $this, 'on_request' ) ); |
| 121 | remove_filter( 'jet-form-builder/before-render-field', array( $this, 'on_render_field' ) ); |
| 122 | remove_filter( 'jet-form-builder/page-config/jfb-settings', array( $this, 'on_localize_config' ) ); |
| 123 | remove_filter( 'jet-form-builder/editor/config', array( $this, 'on_localize_config' ) ); |
| 124 | remove_filter( 'jet-form-builder/setup-blocks', array( $this, 'check_is_container_exist' ) ); |
| 125 | remove_filter( 'jet-form-builder/before-end-form', array( $this, 'on_end_render_form' ) ); |
| 126 | remove_filter( 'jet-form-builder/blocks/items', array( $this, 'add_blocks_types' ) ); |
| 127 | |
| 128 | remove_action( 'jet-form-builder/editor-assets/before', array( $this, 'enqueue_editor_assets' ) ); |
| 129 | remove_action( |
| 130 | 'jet-form-builder/editor-assets/before', |
| 131 | array( $this, 'enqueue_editor_package_assets' ), |
| 132 | 0 |
| 133 | ); |
| 134 | remove_action( 'wp_enqueue_scripts', array( $this, 'register_frontend_scripts' ) ); |
| 135 | remove_action( 'jet_plugins/frontend/register_scripts', array( $this, 'register_frontend_scripts' ) ); |
| 136 | remove_action( 'jet-form-builder/enqueue-style', array( $this, 'register_frontend_styles' ) ); |
| 137 | } |
| 138 | |
| 139 | /** |
| 140 | * @param $request |
| 141 | * |
| 142 | * @return mixed |
| 143 | * @throws Spam_Exception |
| 144 | */ |
| 145 | public function on_request( $request ) { |
| 146 | $this->verify( $request ); |
| 147 | |
| 148 | return $request; |
| 149 | } |
| 150 | |
| 151 | /** |
| 152 | * By default, the captcha is displayed before the submit button. |
| 153 | * But if the Captcha Container block is present in the form, we can check it in advance. |
| 154 | * This is necessary because the captcha and the button can be in parallel columns. |
| 155 | * |
| 156 | * @param string $content |
| 157 | * @param string $field_name |
| 158 | * @param array $attrs |
| 159 | * |
| 160 | * @return string |
| 161 | * @see Forms_Captcha::check_is_container_exist |
| 162 | */ |
| 163 | public function on_render_field( string $content, string $field_name, array $attrs ): string { |
| 164 | $type = $attrs['action_type'] ?? ''; |
| 165 | |
| 166 | if ( 'submit-field' !== $field_name || 'submit' !== $type ) { |
| 167 | return $content; |
| 168 | } |
| 169 | |
| 170 | try { |
| 171 | $current = $this->get_current(); |
| 172 | } catch ( Repository_Exception $exception ) { |
| 173 | return $content; |
| 174 | } |
| 175 | |
| 176 | $this->should_render = false; |
| 177 | |
| 178 | if ( $current->is_exist_container() ) { |
| 179 | return $content; |
| 180 | } |
| 181 | |
| 182 | return ( $content . $this->render() ); |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * If for some reason the submit button has not been rendered in the form, |
| 187 | * then to make sure that we have displayed the captcha, |
| 188 | * we display it at the end of the rendering of the entire form. |
| 189 | * |
| 190 | * @param string $content |
| 191 | * |
| 192 | * @return string |
| 193 | */ |
| 194 | public function on_end_render_form( string $content ): string { |
| 195 | $should_render = $this->should_render; |
| 196 | $this->should_render = true; |
| 197 | |
| 198 | if ( $should_render ) { |
| 199 | $content .= $this->render(); |
| 200 | } |
| 201 | |
| 202 | return $content; |
| 203 | } |
| 204 | |
| 205 | public function add_blocks_types( array $block_types ): array { |
| 206 | $block_types[] = new Block_Types\Captcha_Container(); |
| 207 | |
| 208 | return $block_types; |
| 209 | } |
| 210 | |
| 211 | public function register_frontend_scripts() { |
| 212 | /** @var Base_Captcha $captcha */ |
| 213 | foreach ( $this->rep_generate_items() as $captcha ) { |
| 214 | if ( ! ( $captcha instanceof Captcha_Separate_Frontend_Script ) ) { |
| 215 | continue; |
| 216 | } |
| 217 | $captcha->register_frontend_scripts(); |
| 218 | } |
| 219 | } |
| 220 | |
| 221 | public function register_frontend_styles() { |
| 222 | try { |
| 223 | $current = $this->get_current(); |
| 224 | } catch ( Repository_Exception $exception ) { |
| 225 | return; |
| 226 | } |
| 227 | if ( ! ( $current instanceof Captcha_Frontend_Style_It ) ) { |
| 228 | return; |
| 229 | } |
| 230 | $current->register_frontend_styles(); |
| 231 | } |
| 232 | |
| 233 | public function enqueue_editor_assets() { |
| 234 | wp_enqueue_script( |
| 235 | $this->get_handle(), |
| 236 | $this->get_url( 'assets-build/js/editor.js' ), |
| 237 | array(), |
| 238 | jet_form_builder()->get_version(), |
| 239 | true |
| 240 | ); |
| 241 | |
| 242 | /** @var Base_Captcha $captcha */ |
| 243 | foreach ( $this->rep_generate_items() as $captcha ) { |
| 244 | if ( ! ( $captcha instanceof Captcha_Separate_Editor_Script ) ) { |
| 245 | continue; |
| 246 | } |
| 247 | $captcha->enqueue_editor_script(); |
| 248 | } |
| 249 | } |
| 250 | |
| 251 | public function enqueue_editor_package_assets() { |
| 252 | wp_enqueue_script( |
| 253 | $this->get_handle( 'package' ), |
| 254 | $this->get_url( 'assets-build/js/editor.package.js' ), |
| 255 | array(), |
| 256 | jet_form_builder()->get_version(), |
| 257 | true |
| 258 | ); |
| 259 | } |
| 260 | |
| 261 | /** |
| 262 | * @param $request |
| 263 | * |
| 264 | * @throws Spam_Exception |
| 265 | */ |
| 266 | protected function verify( $request ) { |
| 267 | try { |
| 268 | $this->get_current()->verify( $request ); |
| 269 | } catch ( Repository_Exception $exception ) { |
| 270 | return; |
| 271 | } |
| 272 | } |
| 273 | |
| 274 | public function render(): string { |
| 275 | try { |
| 276 | return $this->get_current()->get_output(); |
| 277 | } catch ( Repository_Exception $exception ) { |
| 278 | return ''; |
| 279 | } catch ( Render_Empty_Field $exception ) { |
| 280 | return ''; |
| 281 | } |
| 282 | } |
| 283 | |
| 284 | /** |
| 285 | * Returns captcha settings for current form |
| 286 | * |
| 287 | * @return Base_Captcha |
| 288 | * @throws Repository_Exception |
| 289 | */ |
| 290 | public function get_current(): Base_Captcha { |
| 291 | if ( ! jet_fb_live()->form_id ) { |
| 292 | throw new Repository_Exception( 'no_captcha' ); |
| 293 | } |
| 294 | |
| 295 | if ( array_key_exists( (int) jet_fb_live()->form_id, $this->current ) ) { |
| 296 | if ( $this->current[ jet_fb_live()->form_id ] instanceof Base_Captcha ) { |
| 297 | return $this->current[ jet_fb_live()->form_id ]; |
| 298 | } |
| 299 | |
| 300 | throw new Repository_Exception( 'no_captcha' ); |
| 301 | } |
| 302 | |
| 303 | $settings = Plugin::instance()->post_type->get_captcha( jet_fb_live()->form_id ); |
| 304 | |
| 305 | if ( ! $settings || ! is_array( $settings ) ) { |
| 306 | $this->current[ jet_fb_live()->form_id ] = false; |
| 307 | |
| 308 | throw new Repository_Exception( 'no_captcha' ); |
| 309 | } |
| 310 | |
| 311 | $captcha = $settings['captcha'] ?? false; |
| 312 | |
| 313 | /** |
| 314 | * For backward compatibility |
| 315 | */ |
| 316 | if ( false === $captcha && ! empty( $settings['enabled'] ) ) { |
| 317 | $captcha = Re_Captcha_V3::class; |
| 318 | } |
| 319 | |
| 320 | /** |
| 321 | * @var Base_Captcha $current |
| 322 | */ |
| 323 | $current = $this->rep_clone_item( $captcha ); |
| 324 | |
| 325 | $this->current[ jet_fb_live()->form_id ] = $current->sanitize_options( $settings ); |
| 326 | |
| 327 | return $this->current[ jet_fb_live()->form_id ]; |
| 328 | } |
| 329 | |
| 330 | public function on_localize_config( array $config ): array { |
| 331 | $captcha_config = array(); |
| 332 | |
| 333 | /** @var Base_Captcha $captcha */ |
| 334 | foreach ( $this->rep_generate_items() as $captcha ) { |
| 335 | if ( ! ( $captcha instanceof Captcha_Settings_From_Options ) ) { |
| 336 | continue; |
| 337 | } |
| 338 | $captcha_config[] = $captcha->to_array(); |
| 339 | } |
| 340 | |
| 341 | $config['captcha-tab-config'] = $captcha_config; |
| 342 | |
| 343 | return $config; |
| 344 | } |
| 345 | |
| 346 | public function check_is_container_exist( array $blocks ): array { |
| 347 | try { |
| 348 | $current = $this->get_current(); |
| 349 | } catch ( Repository_Exception $exception ) { |
| 350 | return $blocks; |
| 351 | } |
| 352 | |
| 353 | if ( ! is_null( $current->is_exist_container() ) ) { |
| 354 | return $blocks; |
| 355 | } |
| 356 | |
| 357 | $current->set_exist_container( |
| 358 | ! empty( |
| 359 | Block_Helper::find_by_block_name( |
| 360 | $blocks, |
| 361 | 'jet-forms/captcha-container' |
| 362 | ) |
| 363 | ) |
| 364 | ); |
| 365 | |
| 366 | return $blocks; |
| 367 | } |
| 368 | |
| 369 | /** |
| 370 | * @param string|array $config |
| 371 | * @param string $handle |
| 372 | * |
| 373 | * @return bool |
| 374 | */ |
| 375 | public function add_inline_config( $config, string $handle = '' ): bool { |
| 376 | $form_id = jet_fb_live()->form_id; |
| 377 | |
| 378 | if ( ! is_string( $config ) ) { |
| 379 | $config = Tools::encode_json( $config ); |
| 380 | } |
| 381 | |
| 382 | return wp_add_inline_script( |
| 383 | $handle ?: Base_Captcha::HANDLE_USER, |
| 384 | " |
| 385 | window.JetFormBuilderCaptchaConfig = window.JetFormBuilderCaptchaConfig || {}; |
| 386 | window.JetFormBuilderCaptchaConfig[ $form_id ] = {$config}; |
| 387 | ", |
| 388 | 'before' |
| 389 | ); |
| 390 | } |
| 391 | } |
| 392 |