Replace recaptcha by own captcha system

Author: frank9999

.env

@@ -32,9 +32,6 @@ DATABASE_URL=mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=5.
 MAILER_DSN=smtp://localhost
 ###< symfony/mailer ###
 
-GOOGLE_RECAPTCHA_SITE_KEY=
-GOOGLE_RECAPTCHA_SECRET_KEY=
-
 # Set this setting to false to disable forum functionality
 UW_FORUM_ENABLED=true
 # Development: Override construction time to 1 second (set 0 to disable)

composer.json

@@ -11,7 +11,6 @@
         "doctrine/common": "^3.5",
         "doctrine/doctrine-bundle": "^3.2",
         "doctrine/orm": "^3.6",
-        "google/recaptcha": "^1.3",
         "symfony/asset": "^8.0",
         "symfony/console": "^8.0",
         "symfony/dotenv": "^8.0",

composer.lock

@@ -774,6 +774,11 @@ Site/ResetPassword:
     controller: FrankProjects\UltimateWarfare\Controller\Site\ResetPasswordController::requestPasswordReset
     methods:   [GET, POST]
 
+Site/Captcha:
+    path:      /captcha
+    controller: FrankProjects\UltimateWarfare\Controller\Site\CaptchaController::captcha
+    methods:   [GET]
+
 Site/Register:
     path:      /register
     controller: FrankProjects\UltimateWarfare\Controller\Site\RegisterController::register

config/routes.yaml

@@ -4,7 +4,6 @@
 # Put parameters here that don't need to change on each machine where the app is deployed
 # https://symfony.com/doc/current/best_practices.html#use-parameters-for-application-configuration
 parameters:
-    app.gg_recaptcha_site_key: '%env(GOOGLE_RECAPTCHA_SITE_KEY)%'
     app.uw_forum_enabled: '%env(bool:UW_FORUM_ENABLED)%'
     app.uw_construction_time_override: '%env(default::int:UW_CONSTRUCTION_TIME_OVERRIDE)%'
     app.uw_research_time_override: '%env(default::int:UW_RESEARCH_TIME_OVERRIDE)%'
@@ -43,10 +42,6 @@ services:
             $researchRegistry: '@FrankProjects\UltimateWarfare\Repository\ResearchRegistry'
             $researchTimeOverride: '%app.uw_research_time_override%'
 
-    ReCaptcha\ReCaptcha:
-        arguments:
-            - '%env(GOOGLE_RECAPTCHA_SECRET_KEY)%'
-
     Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler:
         arguments:
             - '%env(DATABASE_URL)%'

config/services.yaml

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FrankProjects\UltimateWarfare\Controller\Site;
+
+use FrankProjects\UltimateWarfare\Service\CaptchaGenerator;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+
+final class CaptchaController extends AbstractController
+{
+    public function __construct(
+        private readonly CaptchaGenerator $captchaGenerator
+    ) {
+    }
+
+    public function captcha(): Response
+    {
+        $imageData = $this->captchaGenerator->generateImage();
+
+        return new Response($imageData, Response::HTTP_OK, [
+            'Content-Type' => 'image/png',
+            'Cache-Control' => 'no-store, no-cache, must-revalidate',
+        ]);
+    }
+}

public/js/recaptcha.js

@@ -37,7 +37,6 @@ public function contact(Request $request): Response
             'site/contact.html.twig',
             [
                 'form' => $form->createView(),
-                'gg_recaptcha_site_key' => $this->getParameter('app.gg_recaptcha_site_key')
             ]
         );
     }

src/Controller/Site/CaptchaController.php

@@ -45,7 +45,6 @@ public function register(Request $request): Response
             'site/register.html.twig',
             [
                 'form' => $form->createView(),
-                'gg_recaptcha_site_key' => $this->getParameter('app.gg_recaptcha_site_key')
             ]
         );
     }

src/Controller/Site/ContactController.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FrankProjects\UltimateWarfare\Form;
+
+use FrankProjects\UltimateWarfare\Form\EventListener\CaptchaValidationListener;
+use FrankProjects\UltimateWarfare\Service\CaptchaGenerator;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/** @extends AbstractType<null> */
+class CaptchaType extends AbstractType
+{
+    public function __construct(
+        private readonly CaptchaGenerator $captchaGenerator
+    ) {
+    }
+
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        /** @var string $invalidMessage */
+        $invalidMessage = $options['invalid_message'];
+
+        $subscriber = new CaptchaValidationListener($this->captchaGenerator);
+        $subscriber->setInvalidMessage($invalidMessage);
+        $builder->addEventSubscriber($subscriber);
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver
+            ->setDefault('invalid_message', 'The captcha answer is incorrect. Please try again.');
+    }
+
+    public function getParent(): string
+    {
+        return TextType::class;
+    }
+
+    public function getBlockPrefix(): string
+    {
+        return 'captcha';
+    }
+}