forbidals

Back Back Up Advanced Editor

<?php
if ( ! defined( 'ABSPATH' ) ) {
	die( 'You are not allowed to call this page directly.' );
}

/**
 * @since 6.0
 */
class FrmFieldCaptchaSettings {

/**
	 * The global settings object.
	 *
	 * @var FrmSettings
	 */
	public $frm_settings;

/**
	 * The private key used for validating the token.
	 *
	 * @since 6.0
	 *
	 * @var string
	 */
	public $secret;

/**
	 * The key value to check in $_POST data with the token for validation.
	 *
	 * @since 6.0
	 *
	 * @var string
	 */
	public $token_field;

/**
	 * The URL that is called when validating the token.
	 *
	 * @since 6.0
	 *
	 * @var string
	 */
	public $endpoint;

/**
	 * @param FrmSettings $frm_settings
	 */
	public function __construct( $frm_settings ) {
		$this->frm_settings = $frm_settings;
		$this->set_secret();
		$this->set_token_field();
		$this->set_endpoint();
	}

/**
	 * Set the private key to $this->secret.
	 *
	 * @return void
	 */
	protected function set_secret() {
		$key          = $this->get_key_for_privkey();
		$this->secret = ! empty( $this->frm_settings->$key ) ? $this->frm_settings->$key : '';
	}

/**
	 * Set the string to use for $this->token_field.
	 * This is consistent between the different CAPTCHA services.
	 * The element class name is always the same as the key before "-response" in the $_POST value key.
	 * For example (h-captcha-response, or cf-turnstile-response).
	 *
	 * @since 6.8.4
	 *
	 * @return void
	 */
	protected function set_token_field() {
		$this->token_field = $this->get_element_class_name() . '-response';
	}

/**
	 * @since 6.8.4
	 *
	 * @return void
	 */
	protected function set_endpoint() {
		$this->endpoint = '';
	}

/**
	 * Get the name of the CAPTCHA service.
	 *
	 * @since 6.8.4
	 *
	 * @return string
	 */
	public function get_name() {
		return '';
	}

/**
	 * Get the class name used for the CAPTCHA element on the front end.
	 *
	 * @since 6.8.4
	 *
	 * @return string
	 */
	public function get_element_class_name() {
		return '';
	}

/**
	 * Get the URL of the page to link to in global settings. This page should have
	 * instructions on how to get site and secret keys.
	 *
	 * @since 6.8.4
	 *
	 * @return string
	 */
	public function get_documentation_url() {
		return '';
	}

/**
	 * Get the prefix for the global setting.
	 * reCAPTCHA fields just use pubkey/privkey.
	 * But other captcha integrations use a prefix like hcaptcha_public/turnstile_privkey.
	 *
	 * @since 6.8.4
	 *
	 * @return string
	 */
	public function get_settings_prefix() {
		return '';
	}

/**
	 * Get the string to use for the tooltip on the Global settings page when hovering over the Site Key label.
	 *
	 * @since 6.8.4
	 *
	 * @return string
	 */
	public function get_site_key_tooltip() {
		return '';
	}

/**
	 * Get the key used in FrmSettings for the site secret used for validating a Captcha.
	 *
	 * @since 6.8.4
	 *
	 * @return string
	 */
	protected function get_key_for_privkey() {
		return $this->get_settings_prefix() . 'privkey';
	}

/**
	 * Get the key used in FrmSettings for the site key used to initialize a Captcha on the front end.
	 *
	 * @since 6.8.4
	 *
	 * @return string
	 */
	protected function get_key_for_pubkey() {
		return $this->get_settings_prefix() . 'pubkey';
	}

/**
	 * Get the site key to use for a Captcha on the front end.
	 *
	 * @since 6.8.4
	 *
	 * @return string
	 */
	public function get_pubkey() {
		$key = $this->get_key_for_pubkey();
		return $this->frm_settings->$key ?? '';
	}

/**
	 * Check if the public key is not empty.
	 *
	 * @since 6.8.4
	 *
	 * @return bool
	 */
	public function has_pubkey() {
		return ! empty( $this->get_pubkey() );
	}

/**
	 * This can be used to add additional attributes to a front end Captcha element.
	 *
	 * @since 6.8.4
	 *
	 * @param array $attributes
	 * @param array $field
	 *
	 * @return array
	 */
	public function add_front_end_element_attributes( $attributes, $field ) {
		$attributes['data-size'] = $this->get_captcha_size( $field );

if ( ! empty( $field['captcha_theme'] ) ) {
			$attributes['data-theme'] = $field['captcha_theme'];
		}

return $attributes;
	}

/**
	 * @since 6.8.4
	 *
	 * @param array $field
	 *
	 * @return string Either 'normal' or 'compact'.
	 */
	protected function get_captcha_size( $field ) {
		return $field['captcha_size'] === 'default' ? 'normal' : $field['captcha_size'];
	}

/**
	 * Determine if the Captcha Size setting should be shown in field settings.
	 * This has options for "Normal" and "Compact".
	 * This is supported by all CAPTCHA types except for invisible reCAPTCHAs.
	 *
	 * @since 6.8.4
	 *
	 * @return bool
	 */
	public function should_show_captcha_size() {
		return true;
	}

/**
	 * Determine if we should show a theme dropdown for our Captcha field.
	 * This is applicable for all Captcha types except for invisible reCAPTCHA.
	 *
	 * @since 6.8.4
	 *
	 * @return bool
	 */
	public function should_show_captcha_theme() {
		return true;
	}

/**
	 * Determine if the "auto" option should be shown for a specific captcha type.
	 * This is only applicable for Turnstile.
	 *
	 * @since 6.8.4
	 *
	 * @return bool
	 */
	public function should_show_captcha_theme_auto_option() {
		return false;
	}

/**
	 * Default to no prefix. This is overwritten by child classes.
	 *
	 * @since 6.25.1
	 *
	 * @param bool $allow_multiple
	 *
	 * @return string
	 */
	public function get_class_prefix( $allow_multiple ) {
		return '';
	}
}