REDFORM-298 Create an hCaptcha plugin

build/gulp-extensions.json

@@ -10,7 +10,7 @@
 	},
 	"plugins" : {
 		"redform" : ["economic", "helpscout", "redmemberbillinginfo", "salesforce", "aesirmember", "aesirecommerce"],
-		"redform_captcha" : ["hiddencaptcha", "recaptcha", "simplemath"],
+		"redform_captcha" : ["hiddencaptcha", "recaptcha", "simplemath", "hcaptcha"],
 		"redform_field" : [
 			"dawa",
 			"acymailing",

build/joomla-gulp-extensions/plugins/redform_captcha/hcaptcha.js

@@ -0,0 +1,7 @@
+var base = require('../baseplugin');
+var path = require('path');
+
+var name = path.basename(__filename).replace('.js', '');
+var group = path.basename(path.dirname(__filename));
+
+base.addPlugin(group, name);

plugins/redform_captcha/hcaptcha/hcaptcha.php

@@ -0,0 +1,79 @@
+<?php
+
+use Joomla\CMS\Factory;
+use Joomla\CMS\Http\HttpFactory;
+use Joomla\CMS\Plugin\CMSPlugin;
+use Joomla\Utilities\ArrayHelper;
+
+defined('_JEXEC') or die( 'Restricted access');
+
+/**
+ * Class PlgRedform_captchaHcaptcha
+ */
+class PlgRedform_captchaHcaptcha extends CMSPlugin
+{
+	/**
+	 * onGetCaptchaField trigger
+	 *
+	 * @param   string  &$text  text to modify
+	 *
+	 * @return bool
+	 */
+	public function onGetCaptchaField(&$text)
+	{
+		Factory::getDocument()
+			->addScript('https://hcaptcha.com/1/api.js', [], ['defer' => true, 'async' => true]);
+
+		$attributes = [
+			'data-sitekey' => $this->params->get('siteKey'),
+			'data-theme' => $this->params->get('theme', 'light'),
+			'data-size' => $this->params->get('size', 'normal'),
+		];
+
+		$text = '<div class="h-captcha" ' . ArrayHelper::toString($attributes) . '></div>';
+
+		return true;
+	}
+
+	/**
+	 * onCheckCaptcha trigger
+	 *
+	 * @param   bool  &$result  result
+	 *
+	 * @return bool
+	 */
+	public function onCheckCaptcha(&$result)
+	{
+		$app      = Factory::getApplication();
+		$input    = $app->input;
+		$response = $input->post->getString('h-captcha-response');
+		$result   = false;
+
+		if (empty($response))
+		{
+			return $result;
+		}
+
+		try
+		{
+			$response = HttpFactory::getHttp()
+				->post(
+					'https://hcaptcha.com/siteverify',
+					[
+						'secret' => $this->params->get('secretKey'),
+						'response' => $response,
+						'sitekey' => $this->params->get('siteKey'),
+						'remoteip' => $input->server->get('REMOTE_ADDR')
+					]
+				);
+
+			$responseData = json_decode($response->body);
+			$result       = $responseData->success;
+		}
+		catch (Exception $e)
+		{
+		}
+
+		return $result;
+	}
+}

plugins/redform_captcha/hcaptcha/hcaptcha.xml

@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="utf-8"?>
+<extension version="2.5" type="plugin" group="redform_captcha" method="upgrade">
+	<name>PLG_REDFORM_CAPTCHA_HCAPTCHA</name>
+	<creationDate>December 8, 2020</creationDate>
+	<author>redWEB Aps</author>
+	<authorEmail>email@redweb.dk</authorEmail>
+	<authorUrl>www.redcomponent.com</authorUrl>
+	<copyright>(C) 2008 - 2020 redCOMPONENT.com</copyright>
+	<license>GNU/GPL</license>
+	<version>1.0.0</version>
+	<description>PLG_REDFORM_CAPTCHA_HCAPTCHA_XML_DESCRIPTION</description>
+	<files>
+		<filename plugin="hcaptcha">hcaptcha.php</filename>
+		<folder>language</folder>
+	</files>
+	<config>
+		<fields name="params">
+			<fieldset name="basic">
+				<field name="siteKey"
+					   type="text"
+					   required="true"
+					   label="PLG_REDFORM_CAPTCHA_HCAPTCHA_SITE_KEY"
+					   description="PLG_REDFORM_CAPTCHA_HCAPTCHA_SITE_KEY_DESC" />
+				<field name="secretKey"
+					   type="text"
+					   required="true"
+					   label="PLG_REDFORM_CAPTCHA_HCAPTCHA_SECRET_KEY"
+					   description="PLG_REDFORM_CAPTCHA_HCAPTCHA_SECRET_KEY_DESC" />
+				<field name="theme"
+					   type="radio"
+					   class="btn-group btn-group-yesno"
+					   default="light"
+					   label="PLG_REDFORM_CAPTCHA_HCAPTCHA_THEME">
+					<option value="light">PLG_REDFORM_CAPTCHA_HCAPTCHA_THEME_LIGHT</option>
+					<option value="dark">PLG_REDFORM_CAPTCHA_HCAPTCHA_THEME_DARK</option>
+				</field>
+				<field name="size"
+					   type="radio"
+					   default="normal"
+					   class="btn-group btn-group-yesno"
+					   label="PLG_REDFORM_CAPTCHA_HCAPTCHA_SIZE"
+					   >
+					<option value="normal">PLG_REDFORM_CAPTCHA_HCAPTCHA_SIZE_NORMAL</option>
+					<option value="compact">PLG_REDFORM_CAPTCHA_HCAPTCHA_SIZE_COMPACT</option>
+				</field>
+			</fieldset>
+		</fields>
+	</config>
+</extension>

plugins/redform_captcha/hcaptcha/language/en-GB/en-GB.plg_redform_captcha_hcaptcha.ini

@@ -0,0 +1,12 @@
+PLG_REDFORM_CAPTCHA_HCAPTCHA="redFORM hcaptcha plugin"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_XML_DESCRIPTION="hcaptcha plugin for redform"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_SITE_KEY="Site key"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_SITE_KEY_DESC="Enter please site key"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_SECRET_KEY="Secret key"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_SECRET_KEY_DESC="Enter please secret key"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_THEME="Theme"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_THEME_LIGHT="Light"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_THEME_DARK="Dark"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_SIZE="Size"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_SIZE_NORMAL="Normal"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_SIZE_COMPACT="Compact"

plugins/redform_captcha/hcaptcha/language/en-GB/en-GB.plg_redform_captcha_hcaptcha.sys.ini

@@ -0,0 +1,2 @@
+PLG_REDFORM_CAPTCHA_HCAPTCHA="redFORM hcaptcha plugin"
+PLG_REDFORM_CAPTCHA_HCAPTCHA_XML_DESCRIPTION="hcaptcha plugin for redform"