Spam protection module for SilverStripe CMS
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Steve Boyd fc36247598 Merge branch '3.3' into 3 2 months ago
.github/workflows MNT Standardise modules 2 months ago
.tx Add transifex config 7 years ago
_config FIX Typo in userforms form field class name 5 years ago
code ENH PHP 8.1 compatibility 6 months ago
images BUGFIX: Fixed replaced deprecated FieldSet() with FieldList() 10 years ago
lang Update translations 5 months ago
tests Merge branch '3.1' into 3.2 6 months ago
.editorconfig Added standard editor config 7 years ago
.gitattributes Update usage examples in readme, minor fixes in travis configuration and gitattributes 5 years ago
.gitignore Ignore .DS_Store 9 years ago
.upgrade.yml Add upgrader mapping file 5 years ago
README.md MNT Standardise modules 2 months ago
_config.php SilverStripe 4 and Namespacing 5 years ago
changelog.md Update changelog for 2.0.4 release 6 years ago
code-of-conduct.md Added standard code of conduct 7 years ago
codecov.yml Update Travis configuration to be standalone, add codecov.io, update license year 5 years ago
composer.json Merge branch '3.2' into 3 6 months ago
legacy.yml Add legacy mapping 4 years ago
license.md Update Travis configuration to be standalone, add codecov.io, update license year 5 years ago
phpcs.xml.dist MNT Use shared travis config, use sminnee/phpunit 2 years ago
phpunit.xml.dist MNT Standardise modules 2 months ago

README.md

SpamProtection Module

CI Silverstripe supported module

Maintainer Contact

  • Saophalkun Ponlu <phalkunz (at) silverstripe (dot) com>

  • Will Rossiter <will (at) fullscreen (dot) io>

Requirements

Silverstripe 4.0+

Note: For Silverstripe 3.x, please use the 2.x release line.

Install

To install run composer require silverstripe/spamprotection.

Documentation

This module provides a generic, consistent API for adding spam protection to your Silverstripe Forms. This does not provide any spam protection out of the box. For that, you must also download one of the spam protection implementations. Currently available options are:

As a developer you can also provide your own protector by creating a class which implements the \SilverStripe\SpamProtection\SpamProtector interface. More on that below.

Configuring

After installing this module and a protector of your choice (i.e mollom) you'll need to rebuild your database through dev/build and set the default protector via SilverStripe's config system. This will update any Form instances that have spam protection hooks with that protector.

mysite/_config/spamprotection.yml

---
name: mycustomspamprotection
---
SilverStripe\SpamProtection\Extension\FormSpamProtectionExtension:
  default_spam_protector: MollomSpamProtector

To add spam protection to your form instance call enableSpamProtection.

// your existing form code
$form = new Form(/* .. */);
$form->enableSpamProtection();

The logic to perform the actual spam validation is controlled by each of the individual SpamProtector implementations since they each require a different implementation client side or server side.

Options

enableSpamProtection takes a hash of optional configuration values.

$form->enableSpamProtection(array(
    'protector' => MathSpamProtector::class,
    'name' => 'Captcha'
));

Options to configure are:

  • protector: a class name string or class instance which implements \SilverStripe\SpamProtection\SpamProtector. Defaults to your SilverStripe\SpamProtection\Extension\FormSpamProtectionExtension.default_spam_protector value.

  • name: the form field name argument for the Captcha. Defaults to Captcha.

  • title: title of the Captcha form field. Defaults to ''

  • insertBefore: name of existing field to insert the spam protection field prior to

  • mapping: an array mapping of the Form fields to the standardised list of field names. The list of standardised fields to pass to the spam protector are:

title
body
contextUrl
contextTitle
authorName
authorMail
authorUrl
authorIp
authorId

Defining your own SpamProtector

Any class that implements \SilverStripe\SpamProtection\SpamProtector and the getFormField() method can be set as the spam protector. The getFormField() method returns the FormField to be inserted into the Form. The FormField returned should be in charge of the validation process.

<?php

use CaptchaField;
use SilverStripe\SpamProtection\SpamProtector;

class CustomSpamProtector implements SpamProtector
{
    public function getFormField($name = null, $title = null, $value = null)
    {
        // CaptchaField is an imagined class which has some functionality.
        // See silverstripe-mollom module for an example.
        return new CaptchaField($name, $title, $value);
	}
}

Using Spam Protection with User Forms

This module provides an EditableSpamProtectionField wrapper which you can add to your UserForm instances. After installing this module and running /dev/build to rebuild the database, your Form Builder interface will have an option for Spam Protection Field. The type of spam protection used will be based on your currently selected SpamProtector instance.

Releasing code with Spam Protection support

Spam protection is useful to provide but in some cases we do not want to require the developer to use spam protection. In that case, modules can provide the following pattern:

use SilverStripe\Forms\Form;
use SilverStripe\SpamProtection\Extension\FormSpamProtectionExtension;

$form = new Form(/* .. */);

if ($form->hasExtension(FormSpamProtectionExtension::class)) {
    $form->enableSpamProtection();
}