blueways/bw-captcha

TYPO3 extension that integrates gregwar/captcha into Form

v3.0.1 2023-04-07 18:26 UTC

Requires

• typo3/cms-core: ^10.0 || ^11.0 || ^12.0

Requires (Dev)

• bk2k/bootstrap-package: dev-master
• friendsofphp/php-cs-fixer: ^3.12
• roave/security-advisories: dev-latest
• saschaegerer/phpstan-typo3: 12.0.x-dev
• typo3/cms-base-distribution: ^12.0
• typo3/cms-lowlevel: ^12.0

GPL-2.0-or-later

• Maik Schneider

• typo3

README

This extension adds a captcha element for the TYPO3 form component. The captcha generation uses Gregwar/Captcha, no Google or 3rd party includes.

Install

• composer require blueways/bw-captcha
• Activate extension
• Include TypoScript template

Usage

Add the captcha element via Form Editor to your form or directly to your yaml form.

Via Form Editor

Or manual configuration

renderables:
     -
        type: Captcha
        identifier: captcha
        label: Captcha
        properties:
          fluidAdditionalAttributes:
            required: required

Configuration

To modify the captcha output, you can use the following TypoScript constants:

plugin.tx_bwcaptcha {
    settings {
        # Show reload button
        refreshButton =
        
        # The length of the captcha
        length =
        
        # The charset of the captcha
        charset =
        
        # The width of the image
        width =
        
        # The height of the image
        height =
        
        # Custom font file(s) to use (comma-separated)
        fontFiles =
        
        # Text color (e.g. 255,0,0)
        textColor =
        
        # Line color (e.g. 0,0,0)
        lineColor =
        
        # Background color (e.g. 255,255,255)
        backgroundColor =
        
        # Distortion
        distortion =
        
        # The maximum number of lines to draw in front of
        maxFrontLines =
        
        # The maximum number of lines to draw behind
        maxBehindLines =
        
        # The maximum angle of char
        maxAngle =
        
        # The maximum offset of char
        maxOffset =
        
        # Is the interpolation enabled?
        interpolation =
        
        # Ignore all effects
        ignoreAllEffects =
        
    }
}

Overriding the captcha element

To override the captcha partial, copy it to your extension and add the partial path to your form setup:

TYPO3:
  CMS:
    Form:
      prototypes:
        standard:
          formElementsDefinition:
            Form:
              renderingOptions:
                partialRootPaths:
                  1680889288: 'EXT:your_ext/Resources/Private/Frontend/Partials/'

Migration from version 2.x to 3.x

The generation of the captcha moved to a middleware, which solves a lot of caching issues. Therefore, adjustments to the form element partial have been made. If you've modified the partial, you need to update the image tag and refresh button link.

tl;dr:

• Check out the new captcha partial
• Reload button is enabled by default (can be disabled via plugin.tx_bwcaptcha.settings.refreshButton)
• You can re-enable the page cache, if disabled it because of this element

Troubleshooting

Refresh button not working

If your site is configured to use trailing slashes, the refresh url cannot be resolved. A simple fix is to add a setting for the pageType 3413, e.g.:

routeEnhancers:
  PageTypeSuffix:
    type: PageType
    default: /
    index: index
    map:
      /: 0
      .captcha: 3413

Contribute

This extension was made by Maik Schneider: Feel free to contribute!

• Github-Repository

Thanks to blueways and XIMA!